Skip to content

Commit b910b19

Browse files
author
Johannes Stelzer
committed
update README and screenshots
increment version
1 parent 507405a commit b910b19

File tree

20 files changed

+69
-18
lines changed

20 files changed

+69
-18
lines changed

README.md

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,21 @@ This application provides a simple GUI to administrate Spring Boot applications
2323
* Interact with JMX-Beans
2424
* View Threaddump
2525
* View Traces
26-
* Desktop notification on status change
26+
* Mail and desktop notification on status change
27+
* Event journal of status changes (non persistent)
2728

2829
#### Server application
2930
Add the following dependency to your pom.xml.
3031
```xml
3132
<dependency>
3233
<groupId>de.codecentric</groupId>
3334
<artifactId>spring-boot-admin-server</artifactId>
34-
<version>1.2.1</version>
35+
<version>1.2.2</version>
3536
</dependency>
3637
<dependency>
3738
<groupId>de.codecentric</groupId>
3839
<artifactId>spring-boot-admin-server-ui</artifactId>
39-
<version>1.2.1</version>
40+
<version>1.2.2</version>
4041
</dependency>
4142
```
4243

@@ -73,14 +74,14 @@ Each application that want to register itself to the admin application has to in
7374
<dependency>
7475
<groupId>de.codecentric</groupId>
7576
<artifactId>spring-boot-admin-starter-client</artifactId>
76-
<version>1.2.1</version>
77+
<version>1.2.2</version>
7778
</dependency>
7879
```
7980
Inside your configuration (e.g. application.properties) you also have to define the URL of the Spring Boot Admin Server, e.g.
8081
```
8182
spring.boot.admin.url=http://localhost:8080
8283
```
83-
For all configuration options see [spring-boot-starter-admin-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-starter-client/README.md)
84+
For all configuration options see [spring-boot-admin-starter-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-starter-client/README.md)
8485

8586
##### Discover client applications via DiscoveryClient
8687
Just add spring-clouds ``@EnableDiscoveryClient`` annotation and include an appropriate implementation (e.g. Eureka) to your classpath.
@@ -100,11 +101,28 @@ public class SpringBootAdminApplication {
100101
<dependency>
101102
<groupId>org.springframework.cloud</groupId>
102103
<artifactId>spring-cloud-starter-eureka</artifactId>
103-
<version>1.0.1.RELEASE</version>
104+
<version>1.0.3.RELEASE</version>
104105
</dependency>
105106
```
106107
See the sample [discovery sample project](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample-discovery)
107108

109+
#### Mail notification on status change
110+
111+
Configure a JavaMailSender using spring-boot-starter-mail and set a recipient:
112+
```xml
113+
<dependency>
114+
<groupId>org.springframework.boot</groupId>
115+
<artifactId>spring-boot-starter-mail</artifactId>
116+
</dependency>
117+
```
118+
119+
```
120+
spring.mail.host=smtp.example.com
121+
122+
```
123+
124+
For all configuration options see [spring-boot-admin-server](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-server/README.md)
125+
108126

109127
#### Screenshots
110128

@@ -118,6 +136,11 @@ See the sample [discovery sample project](https://github.com/codecentric/spring-
118136
[](url "title")
119137
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-details.png">
120138

139+
##### Environment
140+
141+
[](url "title")
142+
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-environment.png">
143+
121144
##### Logging
122145

123146
[](url "title")
@@ -128,6 +151,22 @@ See the sample [discovery sample project](https://github.com/codecentric/spring-
128151
[](url "title")
129152
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-jmx.png">
130153

154+
##### Threads
155+
156+
[](url "title")
157+
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-threads.png">
158+
159+
##### JMX
160+
161+
[](url "title")
162+
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-trace.png">
163+
164+
##### Journal
165+
166+
[](url "title")
167+
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-journal.png">
168+
169+
131170
#### Build
132171
In order to build spring-boot-admin you need to have node.js and npm on your PATH.
133172

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
<groupId>de.codecentric</groupId>
1313
<artifactId>spring-boot-admin</artifactId>
14-
<version>1.2.2-SNAPSHOT</version>
14+
<version>1.2.3-SNAPSHOT</version>
1515
<packaging>pom</packaging>
1616

1717
<name>Spring Boot Admin</name>

screenshot-details.png

-38.4 KB
Loading

screenshot-environment.png

1.49 MB
Loading

screenshot-jmx.png

36.6 KB
Loading

screenshot-journal.png

411 KB
Loading

screenshot-logging.png

16.7 KB
Loading

screenshot-threads.png

340 KB
Loading

screenshot-trace.png

724 KB
Loading

screenshot.png

176 KB
Loading

0 commit comments

Comments
 (0)