Skip to content

Commit 1107173

Browse files
gitblitgitblit
committed
Update documentation
1 parent 35ff932 commit 1107173

File tree

26 files changed

+133
-118
lines changed

26 files changed

+133
-118
lines changed

‎fathom-core/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Core
2+
3+
Please see [documentation](http://fathom.gitblit.com).

‎fathom-eventbus/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Eventbus
2+
3+
Please see [documentation](http://fathom.gitblit.com/eventbus).

‎fathom-jcache/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom JCache
2+
3+
Please see [documentation](http://fathom.gitblit.com/jcache).

‎fathom-mailer/README.md

Lines changed: 2 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,3 @@
1-
Fathom Mailer
2-
=====================
3-
4-
Module for sending emails.
5-
6-
Setup
7-
-----
8-
9-
1) Add the dependency to your pom.xml:
10-
```xml
11-
<dependency>
12-
<groupId>com.gitblit.fathom</groupId>
13-
<artifactId>fathom-mailer</artifactId>
14-
<version>${fathom.version}</version>
15-
</dependency>
16-
```
17-
18-
2) Configure your mail server.
19-
```properties
20-
mail.server = smtp.gmail.com
21-
mail.port = 465
22-
mail.useSsl = true
23-
mail.useTls = true
24-
mail.username = username
25-
mail.password = password
26-
mail.debug = false
27-
mail.systemName = Fathom
28-
mail.systemAddress = [email protected]
29-
mail.bounceAddress = [email protected]
30-
```
31-
32-
3) Inject `fathom.mailer.Mailer` when you need email sending.
33-
34-
Usage
35-
-----
36-
37-
Fathom Mailer is based on [Sisu-Mailer](https://github.com/sonatype/sisu-mailer) and is integrated
38-
with your chosen `TemplateEngine`. This allows you to generate email notifications from templates rather
39-
than wasting your time using `StringBuilder` and friends.
1+
## Fathom Mailer
402

3+
Please see [documentation](http://fathom.gitblit.com/mail).

‎fathom-metrics-ganglia/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Metrics Ganglia
2+
3+
Please see [documentation](http://fathom.gitblit.com/metrics).

‎fathom-metrics-graphite/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Metrics Graphite
2+
3+
Please see [documentation](http://fathom.gitblit.com/metrics).

‎fathom-metrics-influxdb/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Metrics InfluxDB
2+
3+
Please see [documentation](http://fathom.gitblit.com/metrics).

‎fathom-metrics-librato/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Metrics Librato
2+
3+
Please see [documentation](http://fathom.gitblit.com/metrics).

‎fathom-metrics/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Metrics
2+
3+
Please see [documentation](http://fathom.gitblit.com/metrics).

‎fathom-quartz/README.md

Lines changed: 2 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,3 @@
1-
Fathom Quartz Scheduler
2-
=====================
1+
## Fathom Quartz
32

4-
Fathom Module for the Quartz Scheduler.
5-
6-
This is a fork of [Apache Onami Scheduler](https://onami.apache.org/scheduler)
7-
8-
Setup
9-
-----
10-
11-
1) Add the dependency to your pom.xml:
12-
```xml
13-
<dependency>
14-
<groupId>com.gitblit.fathom</groupId>
15-
<artifactId>fathom-quartz</artifactId>
16-
<version>${fathom.version}</version>
17-
</dependency>
18-
```
19-
20-
2) Create a `conf/Jobs` class.
21-
```java
22-
public class Jobs extends JobsModule {
23-
24-
@Override
25-
protected void schedule() {
26-
27-
if (getSettings().isProd()) {
28-
scheduleJob(ProdJob.class).withCronExpression("0/60 * * * * ?");
29-
} else {
30-
scheduleJob(DevJob.class);
31-
}
32-
33-
}
34-
}
35-
```
36-
37-
Usage
38-
-----
39-
40-
By default, this module will try to configure Quartz from a `conf/quartz.properties` file, if it exists.
41-
42-
Jobs
43-
----
44-
Don't create jobs instances manually, let Guice do the job for you!
45-
`org.quartz.Job` instances and scheduling are managed as well, a typical example of scheduling `org.quartz.Job` is:
46-
47-
```java
48-
public class Jobs extends JobsModule {
49-
50-
@Override
51-
protected void schedule() {
52-
...
53-
scheduleJob(com.acme.MyJobImpl.class).withCronExpression( "0/2 * * * * ?" );
54-
...
55-
}
56-
57-
});
58-
```
59-
60-
Annotated Scheduling
61-
62-
Job classes annotated with `fathom.quartz.Scheduled` will be automatically scheduled.
63-
64-
```java
65-
@Singleton
66-
@Scheduled(jobName = "test", cronExpression = "0/2 * * * * ?")
67-
public class com.acme.MyJobImpl implements org.quartz.Job {
68-
69-
@Inject
70-
private MyCustomService service;
71-
72-
public void execute(JobExecutionContext context) throws JobExecutionException {
73-
service.customOperation();
74-
}
75-
76-
}
77-
```
78-
79-
[1]: http://quartz-scheduler.org/documentation/quartz-2.2.x/quick-start
3+
Please see [documentation](http://fathom.gitblit.com/quartz).

‎fathom-rest-security/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom REST Security
2+
3+
Please see [documentation](http://fathom.gitblit.com/rest-security).

‎fathom-rest-shiro/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom REST Shiro
2+
3+
Please see [documentation](http://fathom.gitblit.com/rest-shiro).

‎fathom-rest/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom REST
2+
3+
Please see [documentation](http://fathom.gitblit.com/rest).

‎fathom-security-htpasswd/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Security Htpasswd
2+
3+
Please see [documentation](http://fathom.gitblit.com/security).

‎fathom-security-jdbc/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Security JDBC
2+
3+
Please see [documentation](http://fathom.gitblit.com/security).

‎fathom-security-ldap/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Security LDAP
2+
3+
Please see [documentation](http://fathom.gitblit.com/security).

‎fathom-security-pam/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Security PAM
2+
3+
Please see [documentation](http://fathom.gitblit.com/security).

‎fathom-security-redis/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Security Redis
2+
3+
Please see [documentation](http://fathom.gitblit.com/security).

‎fathom-security-windows/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Security Windows
2+
3+
Please see [documentation](http://fathom.gitblit.com/security).

‎fathom-security/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Security
2+
3+
Please see [documentation](http://fathom.gitblit.com/security).

‎fathom-site/docs/mail.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
**Fathom-Mailer** provides your application with an outgoing email capability.
44

5+
**Fathom-Mailer** is based on [Sisu-Mailer](https://github.com/sonatype/sisu-mailer) and is integrated
6+
with your chosen Pippo `TemplateEngine`. This allows you to generate email notifications from templates rather
7+
than wasting your time using `StringBuilder` and friends.
8+
59
## Installation
610

711
Add the **Fathom-Mailer** artifact.
@@ -17,3 +21,21 @@ Add the **Fathom-Mailer** artifact.
1721
**Fathom-Mailer** depends on [Fathom-REST](rest.md) and a Pippo Template Engine.
1822

1923
## Configuration
24+
25+
Configure your mail server.
26+
```properties
27+
mail.server = smtp.gmail.com
28+
mail.port = 465
29+
mail.useSsl = true
30+
mail.useTls = true
31+
mail.username = username
32+
mail.password = password
33+
mail.debug = false
34+
mail.systemName = Fathom
35+
mail.systemAddress = [email protected]
36+
mail.bounceAddress = [email protected]
37+
```
38+
39+
## Usage
40+
41+
Inject `fathom.mailer.Mailer` when you need email sending.

‎fathom-site/docs/quartz.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
**Fathom-Quartz** provides [Quartz Scheduler]() integration for your application.
44

5+
This is a fork of [Apache Onami Scheduler](https://onami.apache.org/scheduler)
6+
57
## Installation
68

79
Add the **Fathom-Quartz** artifact.
@@ -34,7 +36,13 @@ public class Jobs extends JobsModule {
3436
}
3537

3638
}
39+
```
40+
41+
## Usage
42+
43+
By default, this module will try to configure Quartz from a `conf/quartz.properties` file, if it exists.
3744

45+
```java
3846
private static class ProdJob implements Job {
3947

4048
final Logger log = LoggerFactory.getLogger(ProdJob.class);
@@ -57,3 +65,24 @@ public class Jobs extends JobsModule {
5765
}
5866
}
5967
```
68+
69+
### Annotated Scheduling
70+
71+
Job classes annotated with `fathom.quartz.Scheduled` will be automatically scheduled.
72+
73+
```java
74+
@Singleton
75+
@Scheduled(jobName = "test", cronExpression = "0/2 * * * * ?")
76+
public class com.acme.MyJobImpl implements org.quartz.Job {
77+
78+
@Inject
79+
private MyCustomService service;
80+
81+
public void execute(JobExecutionContext context) throws JobExecutionException {
82+
service.customOperation();
83+
}
84+
85+
}
86+
```
87+
88+
[1]: http://quartz-scheduler.org/documentation/quartz-2.2.x/quick-start

‎fathom-site/docs/rest-security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## About
22

3-
**Fathom-REST-Security** integrates [Fathom-REST](rest.md) with [Fathom-Security](security.md) to provide your RESTful Routes and Controllers with flexible authentication and authorization.
3+
**Fathom-REST-Security** integrates [Fathom-REST](rest.md) with [Fathom-Security](security.md) to provide your RESTful Routes and Controllers with flexible authentication and authorization. This is a lightweight alternative to [Fathom-REST-Shiro](rest-shiro.md).
44

55
## Installation
66

‎fathom-site/docs/rest-shiro.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## About
2+
3+
**Fathom-REST-Shiro** integrates [Fathom-REST](rest.md) with [Apache Shiro][]] to provide your RESTful Routes and Controllers with flexible authentication and authorization.
4+
5+
## Installation
6+
7+
Add the **Fathom-REST-Shiro** artifact.
8+
9+
```XML
10+
<dependency>
11+
<groupId>com.gitblit.fathom</groupId>
12+
<artifactId>fathom-rest-shiro</artifactId>
13+
<version>${fathom.version}</version>
14+
</dependency>
15+
```
16+
17+
## Configuration
18+
19+
[Apache Shiro]: https://shiro.apache.org/

‎fathom-site/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ pages:
2121
- Modules:
2222
- 'Fathom-REST' : 'rest.md'
2323
- 'Fathom-REST-Security' : 'rest-security.md'
24+
- 'Fathom-REST-Shiro' : 'rest-shiro.md'
2425
- 'Fathom-Security' : 'security.md'
2526
- 'Fathom-Metrics' : 'metrics.md'
2627
- 'Fathom-Mailer' : 'mail.md'

‎fathom-test-tools/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Fathom Test Tools
2+
3+
Please see [documentation](http://fathom.gitblit.com/testing).

0 commit comments

Comments
 (0)