You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spring-boot-admin-docs/src/main/asciidoc/client.adoc
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
[[client-applications]]
2
-
== Client applications ==
2
+
== Client Applications ==
3
3
4
4
[[show-version-in-application-list]]
5
-
=== Show version in application list ===
5
+
=== Show Version in Application List ===
6
6
7
7
For *Spring Boot* applications the easiest way to show the version, is to use the `build-info` goal from the `spring-boot-maven-plugin`, which generates the `META-INF/build-info.properties`. See also the http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#howto-build-info[Spring Boot Reference Guide].
8
8
@@ -29,7 +29,7 @@ For *non-Spring Boot* applications you can either add a `version` or `build.vers
29
29
----
30
30
31
31
[[jmx-bean-management]]
32
-
=== JMX-bean management ===
32
+
=== JMX-Bean Management ===
33
33
34
34
To interact with JMX-beans in the admin UI you have to include https://jolokia.org/[Jolokia] in your application. As Jolokia is servlet based there is no support for reactive applications.
35
35
In case you are using the `spring-boot-admin-starter-client` it will be pulled in for you, if not add Jolokia to your dependencies:
@@ -44,7 +44,7 @@ In case you are using the `spring-boot-admin-starter-client` it will be pulled i
44
44
----
45
45
46
46
[[logfile]]
47
-
=== Logfile viewer ===
47
+
=== Logfile Viewer ===
48
48
49
49
By default the logfile is not accessible via actuator endpoints and therefore not visible in Spring Boot Admin.
50
50
In order to enable the logfile actuator endpoint you need to configure Spring Boot to write a logfile, either by setting
`Tags` are a way to add visual markers per instanace, they will appear in the application list as well as in the instance view.
69
69
By default no tags are added to instances, and it's up to the client to specify the desired tags by adding the information to the metadata or info endpoint.
Copy file name to clipboardExpand all lines: spring-boot-admin-docs/src/main/asciidoc/getting-started.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ NOTE: If you want to setup the Spring Boot Admin Server via war-deployment in a
41
41
See also the {github-src}/spring-boot-admin-samples/spring-boot-admin-sample-servlet/[spring-boot-admin-sample-servlet] project, which also adds security.
42
42
43
43
[[register-client-applications]]
44
-
=== Registering client applications ===
44
+
=== Registering Client Applications ===
45
45
46
46
To register your application at the SBA Server, you can either include the SBA Client or use http://projects.spring.io/spring-cloud/spring-cloud.html[Spring Cloud Discovery] (e.g. Eureka, Consul, ...). There is also a <<spring-cloud-discovery-static-config,simple option using a static configuration on the SBA Server side>>.
Copy file name to clipboardExpand all lines: spring-boot-admin-docs/src/main/asciidoc/server-discovery.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ The Spring Boot Admin Server can use Spring Clouds `DiscoveryClient` to discover
6
6
TIP: Spring Boot Admin will only update the info and available endpoints when a application changes status or when the registration changes. If you want to trigger an update with every new deployment, you can add a key value pair that changes with every restart (e.g. `eureka.instance.metadata-map.startup: ${random.int}`).
7
7
8
8
[[spring-cloud-discovery-static-config]]
9
-
==== SimpleDiscoveryClient configuration ====
9
+
==== Static Configuration using SimpleDiscoveryClient ====
10
10
11
11
Spring Cloud provides a `SimpleDiscoveryClient`. It allows you to specify client applications via static configuration:
Copy file name to clipboardExpand all lines: spring-boot-admin-docs/src/main/asciidoc/server-notifications.adoc
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
4
4
[[reminder-notifications]]
5
-
==== Reminder notifications ====
5
+
==== Reminder Notifications ====
6
6
The `RemindingNotifier` sends reminders for down/offline applications, it delegates the sending of notifications to another notifier.
7
7
8
8
By default a reminder is triggered when a registered application changes to `DOWN` or `OFFLINE`. You can alter this behaviour via `setReminderStatuses()`. The reminder ends when either the status changes to a non-triggering status or the regarding application gets deregistered.
@@ -32,7 +32,7 @@ public class NotifierConfiguration {
32
32
33
33
34
34
[[filtering-notifications]]
35
-
==== Filtering notifications ====
35
+
==== Filtering Notifications ====
36
36
The `FilteringNotifier` allows you to filter certain notification based on rules you can add/remove at runtime. It delegates the sending of notifications to another notifier.
37
37
38
38
If you add a `FilteringNotifier` to your `ApplicationContext` a RESTful interface on `notifications/filter` gets available.
@@ -51,7 +51,7 @@ TIP: This example combines the reminding and filtering notifiers. This allows yo
51
51
52
52
53
53
[[mail-notifications]]
54
-
==== Mail notifications ====
54
+
==== Mail Notifications ====
55
55
56
56
Mail notifications will be delivered as HTML emails rendered using https://www.thymeleaf.org/[Thymeleaf] templates.
57
57
To enable Mail notifications, configure a `JavaMailSender` using `spring-boot-starter-mail` and set a recipient.
To enable https://www.pagerduty.com/[PagerDuty] notifications you just have to add a generic service to your PagerDuty-account and set `spring.boot.admin.notify.pagerduty.service-key` to the service-key you received.
123
123
124
124
.PagerDuty notifications configuration options
@@ -156,7 +156,7 @@ To enable https://www.pagerduty.com/[PagerDuty] notifications you just have to a
156
156
157
157
158
158
[[opsgenie-notifications]]
159
-
==== OpsGenie notifications ====
159
+
==== OpsGenie Notifications ====
160
160
To enable https://www.opsgenie.com/[OpsGenie] notifications you just have to add a new JSON Rest API integration to your OpsGenie account and set `spring.boot.admin.notify.opsgenie.api-key` to the apiKey you received.
161
161
162
162
.OpsGenie notifications configuration options
@@ -206,7 +206,7 @@ To enable https://www.opsgenie.com/[OpsGenie] notifications you just have to add
206
206
207
207
208
208
[[hipchat-notifications]]
209
-
==== Hipchat notifications ====
209
+
==== Hipchat Notifications ====
210
210
To enable https://www.hipchat.com/[Hipchat] notifications you need to create an API token on your Hipchat account and set the appropriate configuration properties.
211
211
212
212
.Hipchat notifications configuration options
@@ -245,7 +245,7 @@ To enable https://www.hipchat.com/[Hipchat] notifications you need to create an
245
245
246
246
247
247
[[slack-notifications]]
248
-
==== Slack notifications ====
248
+
==== Slack Notifications ====
249
249
To enable https://slack.com/[Slack] notifications you need to add a incoming Webhook under custom integrations on your Slack
250
250
account and configure it appropriately.
251
251
@@ -285,7 +285,7 @@ account and configure it appropriately.
285
285
286
286
287
287
[[letschat-notifications]]
288
-
==== Let's Chat notifications ====
288
+
==== Let's Chat Notifications ====
289
289
To enable https://sdelements.github.io/lets-chat/[Let's Chat] notifications you need to add the host url and add the API token and username from Let's Chat
290
290
291
291
.Let's Chat notifications configuration options
@@ -324,7 +324,7 @@ To enable https://sdelements.github.io/lets-chat/[Let's Chat] notifications you
324
324
325
325
326
326
[[ms-teams-notifications]]
327
-
==== Microsoft Teams notifications ====
327
+
==== Microsoft Teams Notifications ====
328
328
To enable Microsoft Teams notifications you need to setup a connector webhook url and set the appropriate configuration property.
329
329
330
330
.Microsoft Teams notifications configuration options
@@ -346,7 +346,7 @@ To enable Microsoft Teams notifications you need to setup a connector webhook ur
346
346
347
347
348
348
[[telegram-notifications]]
349
-
==== Telegram notifications ====
349
+
==== Telegram Notifications ====
350
350
To enable https://telegram.org/[Telegram] notifications you need to create and authorize a telegram bot and set the appropriate configuration properties for auth-token and chat-id.
351
351
352
352
.Telegram notifications configuration options
@@ -380,7 +380,7 @@ To enable https://telegram.org/[Telegram] notifications you need to create and a
380
380
381
381
382
382
[[discord-notifications]]
383
-
==== Discord notifications ====
383
+
==== Discord Notifications ====
384
384
To enable Discord notifications you need to create a webhook and set the appropriate configuration property.
Copy file name to clipboardExpand all lines: spring-boot-admin-docs/src/main/asciidoc/server.adoc
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,12 @@
1
1
[[spring-boot-admin-server]]
2
2
== Spring Boot Admin Server ==
3
3
4
-
.Spring Boot Admin Server configuration options
4
+
=== Running Behind a Front-end Proxy Server ===
5
+
6
+
In case the Spring Boot Admin server is running behind a reverse proxy, it may be requried to configure the public url where the server is reachable via (`spring.boot.admin.ui.public-url`).
7
+
In addition when the reverse proxy terminates the https connection, it may be necessary to configure `server.use-forward-headers=true` (also see https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto-use-tomcat-behind-a-proxy-server[Spring Boot Reference Guide]).
0 commit comments