Commit 2dac11dd by Dennis Schulte

Add documentation for setup

parent 39f20814
......@@ -18,9 +18,44 @@ This application provides a simple GUI to administrate Spring Boot applications
</ul>
</ul>
#### Server application
Add the following dependency to your pom.xml.
```
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server</artifactId>
<version>1.0.2</version>
</dependency>
```
Create the Spring Boot Admin Server with only one single Annotation.
```
@Configuration
@EnableAutoConfiguration
@EnableAdminServer
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
See also the [example project](https://github.com/codecentric/spring-boot-admin/spring-boot-admin-example) in this repository.
#### Client applications
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.
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.
```
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-starter-admin-client</artifactId>
<version>1.0.2</version>
</dependency>
```
#### Screenshots
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment