@@ -50,7 +50,6 @@ See also the [example project](https://github.com/codecentric/spring-boot-admin/
#### 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-admin/tree/master/spring-boot-starter-admin-client) 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>
...
...
@@ -59,12 +58,14 @@ Each application that want to register itself to the admin application has to in
</dependency>
```
Inside your application.properties you also have to define the URL of the Spring Boot Admin Server, e.g.
Inside your configuration (e.g. application.properties) you also have to define the URL of the Spring Boot Admin Server, e.g.
```
spring.boot.admin.url=http://localhost:8080
```
For all configuration options see [spring-boot-starter-admin-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-starter-admin-client)
@@ -5,21 +5,24 @@ This [Spring-Boot starter](http://docs.spring.io/spring-boot/docs/current-SNAPSH
This client uses the [AutoConfiguration](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration"Spring Boot docu") feature of Spring Boot to register service and controller beans in the application context.
The main service that is used is a registrar that registeres the application at the spring-boot-admin application by periodically calling a REST-API to check or perform the registration of itself.
The main service that is used is a registrar that registeres the application at the spring-boot-admin application by periodically calling a REST-API to perform the registration of itself.
The following properties have to be included in the environment (i.e. application.properties) to ensure all features to work properly.
##Configuration properties
### spring-boot-admin
| Name | Description |
| --------------------- | ----------- |
| spring.boot.admin.url | URL of the spring-boot-admin application to register at.<br>_Mandatory_. | |
| spring.boot.admin.contextPath | Context-path of registration point.<br>Default: api/applications |
| spring.boot.admin.period | Time period for registration repeat.<br>Default: 10000 |
| spring.boot.admin.client.url | Client-management-URL to register with. Can be overriden in case the reachable URL is different (e.g. Docker). Must be unique in registry.<br>Default: http://_hostname_:_${management.port}_/_${management.context-path}_ |
| spring.boot.admin.client.name | Name to register with. Defaults to the ApplicationContexts name. Only set when it should differ.<br>Default: _${spring.application.name}_ if set, spring-boot-application otherwise. |
<table>
<tr>
<td>info.id</td><td>The identifier in the registry - this property is published by the /info endpoint</td>
</tr>
<tr>
<td>info.version</td><td>The version number - also published by the /info endpoint</td>
</tr>
<tr>
<td>spring.boot.admin.url</td><td>URL of the spring-boot-admin application to register at</td>
</tr>
<tr>
<td>logging.file</td><td>File path of the logfile of the application</td>
</tr>
</table>
### Other configuration properties
Options from other spring boot features. These should be set to enable all features.
| Name | Description |
| ----------------------- | ----------- |
| spring.application.name | Name to be shown in the application list. Name of the ApplicationContext. |
| info.version | Version number to be shown in the application list. Also published via /info-endpoint. |
| logging.file | Path to the applications logfile for access via spring-boot-admin. From Spring Boot logging configuration. |