Skip to content

Commit 064291e

Browse files
committed
add an explicit note covering #2289
1 parent 65295cb commit 064291e

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/MANUAL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ Rehashing also reloads TLS certificates and the MOTD. Some configuration setting
171171

172172
Ergo can also be configured using environment variables, using the following technique:
173173

174+
1. Ensure that `allow-environment-variables` is set to `true` in the YAML config file itself (see `default.yaml` for an example)
174175
1. Find the "path" of the config variable you want to override in the YAML file, e.g., `server.websockets.allowed-origins`
175176
1. Convert each path component from "kebab case" to "screaming snake case", e.g., `SERVER`, `WEBSOCKETS`, and `ALLOWED_ORIGINS`.
176177
1. Prepend `ERGO` to the components, then join them all together using `__` as the separator, e.g., `ERGO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS`.

0 commit comments

Comments
 (0)