git.iko.soy/typeable/oauth2-proxy
on master help sign in
Update docs and changelog
commitbdcdfb74f97fe2341956315bc75951b03e387669 authorJoel Speed <Joel.speed@hotmail.co.uk> dateSat 15 Jun 2019, 11:12 (7 years ago) parentf0d0062
2 files changed+23−13
compare with master
unifiedsplit
CHANGELOG.md+15−2 docs/configuration/configuration.md+8−11
CHANGELOG.md+15−2
@@ -2,6 +2,18 @@
22
33## Breaking Changes
44
5+- [#186](https://github.com/pusher/oauth2_proxy/pull/186) Make config consistent
6+ - This PR changes configuration options so that all flags have a config counterpart
7+ of the same name but with underscores (`_`) in place of hyphens (`-`).
8+ This change affects the following existing configuration options:
9+ - The `proxy-prefix` option is now `proxy_prefix`.
10+ - This PR changes environment variables so that all flags have an environment
11+ counterpart of the same name but capitalised, with underscores (`_`) in place
12+ of hyphens (`-`) and with the prefix `OAUTH2_PROXY_`.
13+ This change affects the following existing environment variables:
14+ - The `OAUTH2_SKIP_OIDC_DISCOVERY` environment variable is now `OAUTH2_PROXY_SKIP_OIDC_DISCOVERY`.
15+ - The `OAUTH2_OIDC_JWKS_URL` environment variable is now `OAUTH2_PROXY_OIDC_JWKS_URL`.
16+
517- [#146](https://github.com/pusher/oauth2_proxy/pull/146) Use full email address as `User` if the auth response did not contain a `User` field (@gargath)
618 - This change modifies the contents of the `X-Forwarded-User` header supplied by the proxy for users where the auth response from the IdP did not contain
719 a username.
@@ -14,10 +26,11 @@
1426
1527## Changes since v3.2.0
1628
29+- [#186](https://github.com/pusher/oauth2_proxy/pull/186) Make config consistent (@JoelSpeed)
1730- [#187](https://github.com/pusher/oauth2_proxy/pull/187) Move root packages to pkg folder (@JoelSpeed)
1831- [#65](https://github.com/pusher/oauth2_proxy/pull/65) Improvements to authenticate requests with a JWT bearer token in the `Authorization` header via
19− the `-skip-jwt-bearer-token` options.
20− - Additional verifiers can be configured via the `-extra-jwt-issuers` flag if the JWT issuers is either an OpenID provider or has a JWKS URL
32+ the `-skip-jwt-bearer-token` options.
33+ - Additional verifiers can be configured via the `-extra-jwt-issuers` flag if the JWT issuers is either an OpenID provider or has a JWKS URL
2134 (e.g. `https://example.com/.well-known/jwks.json`).
2235- [#180](https://github.com/pusher/outh2_proxy/pull/180) Minor refactor of core proxying path (@aeijdenberg).
2336- [#175](https://github.com/pusher/outh2_proxy/pull/175) Bump go-oidc to v2.0.0 (@aeijdenberg).
docs/configuration/configuration.md+8−11
@@ -120,17 +120,14 @@ Multiple upstreams can either be configured by supplying a comma separated list
120120
121121### Environment variables
122122
123−The following environment variables can be used in place of the corresponding command-line arguments:
124−
125−- `OAUTH2_PROXY_CLIENT_ID`
126−- `OAUTH2_PROXY_CLIENT_SECRET`
127−- `OAUTH2_PROXY_COOKIE_NAME`
128−- `OAUTH2_PROXY_COOKIE_SECRET`
129−- `OAUTH2_PROXY_COOKIE_DOMAIN`
130−- `OAUTH2_PROXY_COOKIE_PATH`
131−- `OAUTH2_PROXY_COOKIE_EXPIRE`
132−- `OAUTH2_PROXY_COOKIE_REFRESH`
133−- `OAUTH2_PROXY_SIGNATURE_KEY`
123+Every command line argument can be specified as an environment variable by
124+prefixing it with `OAUTH2_PROXY_`, capitalising it, and replacing hypens (`-`)
125+with underscores (`_`). This is particularly useful for storing secrets outside
126+of a configuration file or the command line.
127+
128+For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET` and
129+the `--set-authorization-header` flag becomes `OAUTH2_PROXY_SET_AUTHORIZATION_HEADER`.
130+
134131
135132## Logging Configuration
136133