From e12ae03801b3bb67581085c9334bb6a944298e10 Mon Sep 17 00:00:00 2001 From: Stephan Eicher Date: Mon, 2 Sep 2024 20:13:47 +0200 Subject: [PATCH] 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 --- docs/docs/configuration/overview.md | 11 +++++++++-- .../version-7.6.x/configuration/overview.md | 11 +++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/docs/configuration/overview.md b/docs/docs/configuration/overview.md index 3c35391..c7484c0 100644 --- a/docs/docs/configuration/overview.md +++ b/docs/docs/configuration/overview.md @@ -279,8 +279,15 @@ environment variable should be plural (trailing `S`). This is particularly useful for storing secrets outside a configuration file or the command line. -For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`, -and the `--email-domain` flag becomes `OAUTH2_PROXY_EMAIL_DOMAINS`. +For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`. +If a flag has the type `string | list` like the `--email-domain` flag it is +available as an environment variable in plural form e.g. `OAUTH2_PROXY_EMAIL_DOMAINS` + +Values for type `string | list` usually have a plural environment variable name +and need to be seperated by `,` e.g. +`OAUTH2_PROXY_SKIP_AUTH_ROUTES="GET=^/api/status,POST=^/api/saved_objects/_import"` + +Please check the type for each [config option](#config-options) first. ## Logging Configuration diff --git a/docs/versioned_docs/version-7.6.x/configuration/overview.md b/docs/versioned_docs/version-7.6.x/configuration/overview.md index 3c35391..c7484c0 100644 --- a/docs/versioned_docs/version-7.6.x/configuration/overview.md +++ b/docs/versioned_docs/version-7.6.x/configuration/overview.md @@ -279,8 +279,15 @@ environment variable should be plural (trailing `S`). This is particularly useful for storing secrets outside a configuration file or the command line. -For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`, -and the `--email-domain` flag becomes `OAUTH2_PROXY_EMAIL_DOMAINS`. +For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`. +If a flag has the type `string | list` like the `--email-domain` flag it is +available as an environment variable in plural form e.g. `OAUTH2_PROXY_EMAIL_DOMAINS` + +Values for type `string | list` usually have a plural environment variable name +and need to be seperated by `,` e.g. +`OAUTH2_PROXY_SKIP_AUTH_ROUTES="GET=^/api/status,POST=^/api/saved_objects/_import"` + +Please check the type for each [config option](#config-options) first. ## Logging Configuration