Skip to content

Commit 0985118

Browse files
committed
chore(docs): add documentation for hiding service URLs
1 parent 1c4573b commit 0985118

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

spring-boot-admin-docs/src/site/docs/customize/01-customize_ui.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,16 @@ spring:
7575
- name: "journal"
7676
enabled: false
7777
```
78+
79+
## Hide Service URL ==
80+
81+
To hide service URLs in Spring Boot Admin UI entirely, set the following property in your Server's configuration:
82+
83+
| Property name | Default | Usage
84+
|------------------------------------------|---------|--------------------------------------------------------------------------------------------------------------------
85+
| `spring.boot.admin.ui.hide-instance-url` | `false` | Set to `true` to hide service URLs as well as actions that require them in UI (e.g. jump to /health or /actuator).
86+
87+
If you want to hide the URL for specific instances only, you can set the `hide-url` property in the instance metadata
88+
while registering a service.
89+
When using Spring Boot Admin Client you can set the property `spring.boot.admin.client.metadata.hide-url=true` in the
90+
corresponding config file. The value set in `metadata` does not have any effect, when the URLs are disabled in Server.

0 commit comments

Comments
 (0)