Skip to content

Commit 2dac11d

Browse files
committed
Add documentation for setup
1 parent 39f2081 commit 2dac11d

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,44 @@ This application provides a simple GUI to administrate Spring Boot applications
1818
</ul>
1919
</ul>
2020

21+
#### Server application
22+
23+
Add the following dependency to your pom.xml.
24+
25+
```
26+
<dependency>
27+
<groupId>de.codecentric</groupId>
28+
<artifactId>spring-boot-admin-server</artifactId>
29+
<version>1.0.2</version>
30+
</dependency>
31+
```
32+
33+
Create the Spring Boot Admin Server with only one single Annotation.
34+
35+
```
36+
@Configuration
37+
@EnableAutoConfiguration
38+
@EnableAdminServer
39+
public class Application {
40+
public static void main(String[] args) {
41+
SpringApplication.run(Application.class, args);
42+
}
43+
}
44+
```
45+
46+
See also the [example project](https://github.com/codecentric/spring-boot-admin/spring-boot-admin-example) in this repository.
47+
2148
#### Client applications
2249

23-
Each application that want to register itself to the admin application has to include the [spring-boot-starter-admin-client](https://github.com/codecentric/spring-boot-starter-admin-client "GitHub project") as dependency. This starter JAR includes some [AutoConfiguration](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration "Spring Boot docu") features that includes registering tasks, controller, etc.
50+
Each application that want to register itself to the admin application has to include the [spring-boot-starter-admin-client](https://github.com/codecentric/spring-boot-admin/spring-boot-starter-admin-client "GitHub project") as dependency. This starter JAR includes some [AutoConfiguration](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration "Spring Boot docu") features that includes registering tasks, controller, etc.
51+
52+
```
53+
<dependency>
54+
<groupId>de.codecentric</groupId>
55+
<artifactId>spring-boot-starter-admin-client</artifactId>
56+
<version>1.0.2</version>
57+
</dependency>
58+
```
2459

2560
#### Screenshots
2661

0 commit comments

Comments
 (0)