Explicitly state precedence of config sources in docs (#1439)
I was recently looking into the order in which oauth2-proxy evaluates it configuration options from the various sources.
I think this will also be helpful for other users.
Since oauth2-proxy is using viper, the order of configuration sources is as follows [1]:
> Viper uses the following precedence order. Each item takes precedence over the item below it:
>
> explicit call to Set
> flag
> env
> config
> key/value store
> default
[1] https://github.com/spf13/viper/blob/master/README.md#why-viper
Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>
commit0693856bc319861a27d662d8befe0392763693d1
authorJack Henschel <jackdev@mailbox.org>
dateMon 15 Nov 2021, 10:24 (5 years ago)
parent7ed4e3c
docs/docs/configuration/overview.md+1−1
@@ -3,7 +3,7 @@ id: overview
33title: Overview
44---
55
6−`oauth2-proxy` can be configured via [config file](#config-file), [command line options](#command-line-options) or [environment variables](#environment-variables).
6+`oauth2-proxy` can be configured via [command line options](#command-line-options), [environment variables](#environment-variables) or [config file](#config-file) (in decreasing order of precedence, i.e. command line options will overwrite environment variables and environment variables will overwrite configuration file settings).
77
88### Generating a Cookie Secret
99
docs/versioned_docs/version-6.1.x/configuration/overview.md+1−1
@@ -3,7 +3,7 @@ id: overview
33title: Overview
44---
55
6−`oauth2-proxy` can be configured via [config file](#config-file), [command line options](#command-line-options) or [environment variables](#environment-variables).
6+`oauth2-proxy` can be configured via [command line options](#command-line-options), [environment variables](#environment-variables) or [config file](#config-file) (in decreasing order of precedence, i.e. command line options will overwrite environment variables and environment variables will overwrite configuration file settings).
77
88### Generating a Cookie Secret
99
docs/versioned_docs/version-7.0.x/configuration/overview.md+1−1
@@ -3,7 +3,7 @@ id: overview
33title: Overview
44---
55
6−`oauth2-proxy` can be configured via [config file](#config-file), [command line options](#command-line-options) or [environment variables](#environment-variables).
6+`oauth2-proxy` can be configured via [command line options](#command-line-options), [environment variables](#environment-variables) or [config file](#config-file) (in decreasing order of precedence, i.e. command line options will overwrite environment variables and environment variables will overwrite configuration file settings).
77
88### Generating a Cookie Secret
99
docs/versioned_docs/version-7.1.x/configuration/overview.md+1−1
@@ -3,7 +3,7 @@ id: overview
33title: Overview
44---
55
6−`oauth2-proxy` can be configured via [config file](#config-file), [command line options](#command-line-options) or [environment variables](#environment-variables).
6+`oauth2-proxy` can be configured via [command line options](#command-line-options), [environment variables](#environment-variables) or [config file](#config-file) (in decreasing order of precedence, i.e. command line options will overwrite environment variables and environment variables will overwrite configuration file settings).
77
88### Generating a Cookie Secret
99
docs/versioned_docs/version-7.2.x/configuration/overview.md+1−1
@@ -3,7 +3,7 @@ id: overview
33title: Overview
44---
55
6−`oauth2-proxy` can be configured via [config file](#config-file), [command line options](#command-line-options) or [environment variables](#environment-variables).
6+`oauth2-proxy` can be configured via [command line options](#command-line-options), [environment variables](#environment-variables) or [config file](#config-file) (in decreasing order of precedence, i.e. command line options will overwrite environment variables and environment variables will overwrite configuration file settings).
77
88### Generating a Cookie Secret
99