docs(wiki): fix misleading env vars in container guide
Remove potentially non-working environment variables for nested config options (registry_auth.*). Without SetEnvKeyReplacer in viper config, these env vars won't map correctly. Recommend using config file instead.
- commit
- eb6fc8cd19ecad1cfcdb336dce2b8c48f2b4cce8
- author
- brice · · 2026-01-16 06:31 UTC
- parent
- 183e585
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
1 file · +12 -7
M wiki/guides/running-in-container.md +12 -7
| @@ -213,18 +213,23 @@ systemctl --user enable --now gordon | |||
| 213 | 213 | ||
| 214 | 214 | ### Environment Variables | |
| 215 | 215 | ||
| 216 | - | All configuration options can be set via environment variables with `GORDON_` prefix: | |
| 216 | + | Some configuration options can be set via environment variables with `GORDON_` prefix. | |
| 217 | + | ||
| 218 | + | > **Note**: Environment variables work best for simple options. For nested configuration like `registry_auth`, use a mounted config file instead. | |
| 217 | 219 | ||
| 218 | 220 | | Variable | Description | Example | | |
| 219 | 221 | |----------|-------------|---------| | |
| 220 | - | | `GORDON_SERVER_PORT` | Proxy port | `8080` | | |
| 221 | - | | `GORDON_SERVER_REGISTRY_PORT` | Registry port | `5000` | | |
| 222 | 222 | | `GORDON_SERVER_REGISTRY_DOMAIN` | Registry domain (required) | `registry.mydomain.com` | | |
| 223 | - | | `GORDON_SERVER_DATA_DIR` | Data directory | `/data` | | |
| 224 | 223 | | `GORDON_LOGGING_LEVEL` | Log level | `debug`, `info`, `warn`, `error` | | |
| 225 | - | | `GORDON_REGISTRY_AUTH_ENABLED` | Enable registry auth | `true` | | |
| 226 | - | | `GORDON_REGISTRY_AUTH_USERNAME` | Registry username | `admin` | | |
| 227 | - | | `GORDON_REGISTRY_AUTH_PASSWORD` | Registry password | `secret` | | |
| 224 | + | ||
| 225 | + | For registry authentication and other nested options, use a config file: | |
| 226 | + | ||
| 227 | + | ```toml | |
| 228 | + | [registry_auth] | |
| 229 | + | enabled = true | |
| 230 | + | username = "admin" | |
| 231 | + | password = "secret" | |
| 232 | + | ``` | |
| 228 | 233 | ||
| 229 | 234 | ## Security Considerations | |
| 230 | 235 | ||
| @@ -213,18 +213,23 @@ systemctl --user enable --now gordon | |||||
| 213 | 213 | ||||
| 214 | ### Environment Variables | 214 | ### Environment Variables | ||
| 215 | 215 | ||||
| 216 | - | All configuration options can be set via environment variables with `GORDON_` prefix: | 216 | + | Some configuration options can be set via environment variables with `GORDON_` prefix. |
| 217 | + | ||||
| 218 | + | > **Note**: Environment variables work best for simple options. For nested configuration like `registry_auth`, use a mounted config file instead. | |||
| 217 | 219 | ||||
| 218 | | Variable | Description | Example | | 220 | | Variable | Description | Example | | ||
| 219 | |----------|-------------|---------| | 221 | |----------|-------------|---------| | ||
| 220 | - | | `GORDON_SERVER_PORT` | Proxy port | `8080` | | |||
| 221 | - | | `GORDON_SERVER_REGISTRY_PORT` | Registry port | `5000` | | |||
| 222 | | `GORDON_SERVER_REGISTRY_DOMAIN` | Registry domain (required) | `registry.mydomain.com` | | 222 | | `GORDON_SERVER_REGISTRY_DOMAIN` | Registry domain (required) | `registry.mydomain.com` | | ||
| 223 | - | | `GORDON_SERVER_DATA_DIR` | Data directory | `/data` | | |||
| 224 | | `GORDON_LOGGING_LEVEL` | Log level | `debug`, `info`, `warn`, `error` | | 223 | | `GORDON_LOGGING_LEVEL` | Log level | `debug`, `info`, `warn`, `error` | | ||
| 225 | - | | `GORDON_REGISTRY_AUTH_ENABLED` | Enable registry auth | `true` | | 224 | + | |
| 226 | - | | `GORDON_REGISTRY_AUTH_USERNAME` | Registry username | `admin` | | 225 | + | For registry authentication and other nested options, use a config file: |
| 227 | - | | `GORDON_REGISTRY_AUTH_PASSWORD` | Registry password | `secret` | | 226 | + | |
| 227 | + | ```toml | |||
| 228 | + | [registry_auth] | |||
| 229 | + | enabled = true | |||
| 230 | + | username = "admin" | |||
| 231 | + | password = "secret" | |||
| 232 | + | ``` | |||
| 228 | 233 | ||||
| 229 | ## Security Considerations | 234 | ## Security Considerations | ||
| 230 | 235 | ||||