Skip to content

Commit 647b0b9

Browse files
committed
add security docs to lavalink config server
1 parent 931bbd5 commit 647b0b9

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
spring:
22
cloud:
33
config:
4+
# Enable the use of the Config Server
45
enabled: true
56
# Set the application name here
67
name: Lavalink
78
# Set profile here (default: default)
89
profile: node1
910
# Set the label (git branch/commit id/release) (default: main/master)
10-
label: main
11+
label: master
1112
# Fail if no config could be found
1213
fail-fast: true
14+
# Set the username for the Config Server
15+
username: admin
16+
# Set the password for the Config Server
17+
password: "youshallnotpass"
1318
config:
14-
# replace http://localhost:8888 with the url to your Lavalink Config Server
19+
# Replace http://localhost:8888 with the url to your Lavalink Config Server
1520
import: "configserver:http://localhost:8888/"

docs/configuration/config/config-server.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ SPRING_APPLICATION_NAME
2222
SPRING_CLOUD_CONFIG_PROFILE
2323
SPRING_CLOUD_CONFIG_LABEL
2424
SPRING_CLOUD_CONFIG_FAIL_FAST
25+
SPRING_CLOUD_CONFIG_USERNAME
26+
SPRING_CLOUD_CONFIG_PASSWORD
2527

2628
SPRING_CONFIG_IMPORT
2729
```
@@ -67,9 +69,17 @@ The Lavalink Config Server can be configured to use a git repository or a local
6769
6870
```yaml title="application.yml"
6971
spring:
72+
security:
73+
# Enable basic authentication for the config server
74+
enabled: true
75+
user:
76+
# Set the username to access the config server
77+
name: admin
78+
# Set the password to access the config server
79+
password: "youshallnotpass"
7080
profiles:
7181
# Set to native to use a local filesystem/static url
72-
active: git
82+
active: native
7383
cloud:
7484
config:
7585
server:
@@ -106,6 +116,7 @@ logging:
106116
level:
107117
root: INFO
108118
org.springframework.cloud.config: DEBUG
119+
109120
```
110121

111122
Alternatively, this can also be done via environment variables:
@@ -114,6 +125,10 @@ Alternatively, this can also be done via environment variables:
114125
<summary>Environment Variables</summary>
115126

116127
```bash
128+
SPRING_SECURITY_ENABLED
129+
SPRING_SECURITY_USER_NAME
130+
SPRING_SECURITY_USER_PASSWORD
131+
117132
SPRING_PROFILES_ACTIVE
118133

119134
SPRING_CLOUD_CONFIG_SERVER_ACCEPT_EMPTY

0 commit comments

Comments
 (0)