public_git
/
oauth2-proxy
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Stephan Eicher 2024-09-02 20:13:47 +02:00 committed by GitHub
parent 076d2df246
commit e12ae03801
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/docs/configuration/overview.md
View File

@ -279,8 +279,15 @@ environment variable should be plural (trailing `S`).
This is particularly useful for storing secrets outside a configuration file This is particularly useful for storing secrets outside a configuration file
or the command line. or the command line.
For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`, For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`.
and the `--email-domain` flag becomes `OAUTH2_PROXY_EMAIL_DOMAINS`. 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 ## Logging Configuration

11
docs/versioned_docs/version-7.6.x/configuration/overview.md
View File

@ -279,8 +279,15 @@ environment variable should be plural (trailing `S`).
This is particularly useful for storing secrets outside a configuration file This is particularly useful for storing secrets outside a configuration file
or the command line. or the command line.
For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`, For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`.
and the `--email-domain` flag becomes `OAUTH2_PROXY_EMAIL_DOMAINS`. 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 ## Logging Configuration