Skip to content

Commit a2ed7bf

Browse files
committed
Docs: Add notes about running behind a front-end proxy server
1 parent 2b8a013 commit a2ed7bf

File tree

5 files changed

+24
-19
lines changed

5 files changed

+24
-19
lines changed

spring-boot-admin-docs/src/main/asciidoc/client.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[[client-applications]]
2-
== Client applications ==
2+
== Client Applications ==
33

44
[[show-version-in-application-list]]
5-
=== Show version in application list ===
5+
=== Show Version in Application List ===
66

77
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].
88

@@ -29,7 +29,7 @@ For *non-Spring Boot* applications you can either add a `version` or `build.vers
2929
----
3030

3131
[[jmx-bean-management]]
32-
=== JMX-bean management ===
32+
=== JMX-Bean Management ===
3333

3434
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.
3535
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
4444
----
4545

4646
[[logfile]]
47-
=== Logfile viewer ===
47+
=== Logfile Viewer ===
4848

4949
By default the logfile is not accessible via actuator endpoints and therefore not visible in Spring Boot Admin.
5050
In order to enable the logfile actuator endpoint you need to configure Spring Boot to write a logfile, either by setting
@@ -63,7 +63,7 @@ logging.pattern.file=%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${P
6363
<2> File log pattern using ANSI colors.
6464

6565
[[show-instance-tags]]
66-
=== Show tags per instance ===
66+
=== Show Tags per Instance ===
6767

6868
`Tags` are a way to add visual markers per instanace, they will appear in the application list as well as in the instance view.
6969
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.

spring-boot-admin-docs/src/main/asciidoc/getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ NOTE: If you want to setup the Spring Boot Admin Server via war-deployment in a
4141
See also the {github-src}/spring-boot-admin-samples/spring-boot-admin-sample-servlet/[spring-boot-admin-sample-servlet] project, which also adds security.
4242

4343
[[register-client-applications]]
44-
=== Registering client applications ===
44+
=== Registering Client Applications ===
4545

4646
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>>.
4747

spring-boot-admin-docs/src/main/asciidoc/server-discovery.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Spring Boot Admin Server can use Spring Clouds `DiscoveryClient` to discover
66
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}`).
77

88
[[spring-cloud-discovery-static-config]]
9-
==== SimpleDiscoveryClient configuration ====
9+
==== Static Configuration using SimpleDiscoveryClient ====
1010

1111
Spring Cloud provides a `SimpleDiscoveryClient`. It allows you to specify client applications via static configuration:
1212

spring-boot-admin-docs/src/main/asciidoc/server-notifications.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
[[reminder-notifications]]
5-
==== Reminder notifications ====
5+
==== Reminder Notifications ====
66
The `RemindingNotifier` sends reminders for down/offline applications, it delegates the sending of notifications to another notifier.
77

88
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 {
3232

3333

3434
[[filtering-notifications]]
35-
==== Filtering notifications ====
35+
==== Filtering Notifications ====
3636
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.
3737

3838
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
5151

5252

5353
[[mail-notifications]]
54-
==== Mail notifications ====
54+
==== Mail Notifications ====
5555

5656
Mail notifications will be delivered as HTML emails rendered using https://www.thymeleaf.org/[Thymeleaf] templates.
5757
To enable Mail notifications, configure a `JavaMailSender` using `spring-boot-starter-mail` and set a recipient.
@@ -118,7 +118,7 @@ [email protected]
118118
|===
119119

120120
[[pagerduty-notifications]]
121-
==== PagerDuty notifications ====
121+
==== PagerDuty Notifications ====
122122
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.
123123

124124
.PagerDuty notifications configuration options
@@ -156,7 +156,7 @@ To enable https://www.pagerduty.com/[PagerDuty] notifications you just have to a
156156

157157

158158
[[opsgenie-notifications]]
159-
==== OpsGenie notifications ====
159+
==== OpsGenie Notifications ====
160160
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.
161161

162162
.OpsGenie notifications configuration options
@@ -206,7 +206,7 @@ To enable https://www.opsgenie.com/[OpsGenie] notifications you just have to add
206206

207207

208208
[[hipchat-notifications]]
209-
==== Hipchat notifications ====
209+
==== Hipchat Notifications ====
210210
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.
211211

212212
.Hipchat notifications configuration options
@@ -245,7 +245,7 @@ To enable https://www.hipchat.com/[Hipchat] notifications you need to create an
245245

246246

247247
[[slack-notifications]]
248-
==== Slack notifications ====
248+
==== Slack Notifications ====
249249
To enable https://slack.com/[Slack] notifications you need to add a incoming Webhook under custom integrations on your Slack
250250
account and configure it appropriately.
251251

@@ -285,7 +285,7 @@ account and configure it appropriately.
285285

286286

287287
[[letschat-notifications]]
288-
==== Let's Chat notifications ====
288+
==== Let's Chat Notifications ====
289289
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
290290

291291
.Let's Chat notifications configuration options
@@ -324,7 +324,7 @@ To enable https://sdelements.github.io/lets-chat/[Let's Chat] notifications you
324324

325325

326326
[[ms-teams-notifications]]
327-
==== Microsoft Teams notifications ====
327+
==== Microsoft Teams Notifications ====
328328
To enable Microsoft Teams notifications you need to setup a connector webhook url and set the appropriate configuration property.
329329

330330
.Microsoft Teams notifications configuration options
@@ -346,7 +346,7 @@ To enable Microsoft Teams notifications you need to setup a connector webhook ur
346346

347347

348348
[[telegram-notifications]]
349-
==== Telegram notifications ====
349+
==== Telegram Notifications ====
350350
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.
351351

352352
.Telegram notifications configuration options
@@ -380,7 +380,7 @@ To enable https://telegram.org/[Telegram] notifications you need to create and a
380380

381381

382382
[[discord-notifications]]
383-
==== Discord notifications ====
383+
==== Discord Notifications ====
384384
To enable Discord notifications you need to create a webhook and set the appropriate configuration property.
385385

386386
.Discord notifications configuration options

spring-boot-admin-docs/src/main/asciidoc/server.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
[[spring-boot-admin-server]]
22
== Spring Boot Admin Server ==
33

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]).
8+
9+
=== Configuration Options ===
510
|===
611
| Property name |Description |Default value
712

0 commit comments

Comments
 (0)