git.iko.soy/typeable/oauth2-proxy
on master help sign in
doc: explain value comma separation for plural environment variables (#2732)

* Mention value seperation for plural environment variables * Mention value seperation for plural environment variables on version 7.6.x documentation * change phrasing for better clarification --------- Co-authored-by: tuunit <jan@larwig.com>

commite12ae03801b3bb67581085c9334bb6a944298e10 authorStephan Eicher <stephan.eicher@check24.de> dateMon 2 Sep 2024, 20:13 (2 years ago) parent076d2df
2 files changed+18−4
compare with master
unifiedsplit
docs/docs/configuration/overview.md+9−2 docs/versioned_docs/version-7.6.x/configuration/overview.md+9−2
docs/docs/configuration/overview.md+9−2
@@ -279,8 +279,15 @@ environment variable should be plural (trailing `S`).
279279This is particularly useful for storing secrets outside a configuration file
280280or the command line.
281281
282−For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`,
283−and the `--email-domain` flag becomes `OAUTH2_PROXY_EMAIL_DOMAINS`.
282+For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`.
283+If a flag has the type `string | list` like the `--email-domain` flag it is
284+available as an environment variable in plural form e.g. `OAUTH2_PROXY_EMAIL_DOMAINS`
285+
286+Values for type `string | list` usually have a plural environment variable name
287+and need to be seperated by `,` e.g.
288+`OAUTH2_PROXY_SKIP_AUTH_ROUTES="GET=^/api/status,POST=^/api/saved_objects/_import"`
289+
290+Please check the type for each [config option](#config-options) first.
284291
285292## Logging Configuration
286293
docs/versioned_docs/version-7.6.x/configuration/overview.md+9−2
@@ -279,8 +279,15 @@ environment variable should be plural (trailing `S`).
279279This is particularly useful for storing secrets outside a configuration file
280280or the command line.
281281
282−For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`,
283−and the `--email-domain` flag becomes `OAUTH2_PROXY_EMAIL_DOMAINS`.
282+For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`.
283+If a flag has the type `string | list` like the `--email-domain` flag it is
284+available as an environment variable in plural form e.g. `OAUTH2_PROXY_EMAIL_DOMAINS`
285+
286+Values for type `string | list` usually have a plural environment variable name
287+and need to be seperated by `,` e.g.
288+`OAUTH2_PROXY_SKIP_AUTH_ROUTES="GET=^/api/status,POST=^/api/saved_objects/_import"`
289+
290+Please check the type for each [config option](#config-options) first.
284291
285292## Logging Configuration
286293