git.iko.soy/typeable/oauth2-proxy
on master help sign in
docs: clear up multiple-providers is unimplemented (#3046)

* docs: clear up multiple-providers is unimplemented Currently this configuration option is held up by #926. So users don't assume this solution will work for them, and later find the feature is not yet implemented -- own the shortcoming clearly. * doc: add note about missing multi provider implementation to versioned docs --------- Signed-off-by: Jan Larwig <jan@larwig.com> Co-authored-by: Jan Larwig <jan@larwig.com>

commitbae509d2ecde533ffa32a6a72159eb948cabd1d3 authorEvan Carroll <me@evancarroll.com> dateMon 28 Apr 2025, 16:52 (1 year ago) parent2ecb2c6
8 files changed+29−11
compare with master
unifiedsplit
docs/docs/configuration/alpha_config.md+6−2 docs/docs/configuration/providers/index.md+1−1 docs/versioned_docs/version-7.8.x/configuration/alpha_config.md+6−2 docs/versioned_docs/version-7.8.x/configuration/providers/index.md+1−1 docs/versioned_docs/version-7.9.x/configuration/alpha_config.md+6−2 docs/versioned_docs/version-7.9.x/configuration/providers/index.md+1−1 pkg/apis/options/alpha_options.go+3−1 pkg/apis/options/providers.go+5−1
docs/docs/configuration/alpha_config.md+6−2
@@ -168,7 +168,7 @@ They may change between releases without notice.
168168| `injectResponseHeaders` | _[[]Header](#header)_ | InjectResponseHeaders is used to configure headers that should be added<br/>to responses from the proxy.<br/>This is typically used when using the proxy as an external authentication<br/>provider in conjunction with another proxy such as NGINX and its<br/>auth_request module.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
169169| `server` | _[Server](#server)_ | Server is used to configure the HTTP(S) server for the proxy application.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
170170| `metricsServer` | _[Server](#server)_ | MetricsServer is used to configure the HTTP(S) server for metrics.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
171−| `providers` | _[Providers](#providers)_ | Providers is used to configure multiple providers. |
171+| `providers` | _[Providers](#providers)_ | Providers is used to configure your provider. **Multiple-providers is not<br/>yet working.** [This feature is tracked in<br/>#925](https://github.com/oauth2-proxy/oauth2-proxy/issues/926) |
172172
173173### AzureOptions
174174
@@ -472,7 +472,11 @@ and oidc.
472472
473473(**Appears on:** [AlphaOptions](#alphaoptions))
474474
475−Providers is a collection of definitions for providers.
475+The provider can be selected using the `provider` configuration value, or
476+set in the [`providers` array using
477+AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers).
478+However, [**the feature to implement multiple providers is not
479+complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
476480
477481### SecretSource
478482
docs/docs/configuration/providers/index.md+1−1
@@ -25,7 +25,7 @@ Valid providers are :
2525- [Nextcloud](nextcloud.md)
2626- [OpenID Connect](openid_connect.md)
2727
28−The provider can be selected using the `provider` configuration value.
28+The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
2929
3030Please note that not all providers support all claims. The `preferred_username` claim is currently only supported by the
3131OpenID Connect provider.
docs/versioned_docs/version-7.8.x/configuration/alpha_config.md+6−2
@@ -168,7 +168,7 @@ They may change between releases without notice.
168168| `injectResponseHeaders` | _[[]Header](#header)_ | InjectResponseHeaders is used to configure headers that should be added<br/>to responses from the proxy.<br/>This is typically used when using the proxy as an external authentication<br/>provider in conjunction with another proxy such as NGINX and its<br/>auth_request module.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
169169| `server` | _[Server](#server)_ | Server is used to configure the HTTP(S) server for the proxy application.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
170170| `metricsServer` | _[Server](#server)_ | MetricsServer is used to configure the HTTP(S) server for metrics.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
171−| `providers` | _[Providers](#providers)_ | Providers is used to configure multiple providers. |
171+| `providers` | _[Providers](#providers)_ | Providers is used to configure your provider. **Multiple-providers is not<br/>yet working.** [This feature is tracked in<br/>#925](https://github.com/oauth2-proxy/oauth2-proxy/issues/926) |
172172
173173### AzureOptions
174174
@@ -471,7 +471,11 @@ and oidc.
471471
472472(**Appears on:** [AlphaOptions](#alphaoptions))
473473
474−Providers is a collection of definitions for providers.
474+The provider can be selected using the `provider` configuration value, or
475+set in the [`providers` array using
476+AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers).
477+However, [**the feature to implement multiple providers is not
478+complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
475479
476480### SecretSource
477481
docs/versioned_docs/version-7.8.x/configuration/providers/index.md+1−1
@@ -25,7 +25,7 @@ Valid providers are :
2525- [Nextcloud](nextcloud.md)
2626- [OpenID Connect](openid_connect.md)
2727
28−The provider can be selected using the `provider` configuration value.
28+The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
2929
3030Please note that not all providers support all claims. The `preferred_username` claim is currently only supported by the
3131OpenID Connect provider.
docs/versioned_docs/version-7.9.x/configuration/alpha_config.md+6−2
@@ -168,7 +168,7 @@ They may change between releases without notice.
168168| `injectResponseHeaders` | _[[]Header](#header)_ | InjectResponseHeaders is used to configure headers that should be added<br/>to responses from the proxy.<br/>This is typically used when using the proxy as an external authentication<br/>provider in conjunction with another proxy such as NGINX and its<br/>auth_request module.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
169169| `server` | _[Server](#server)_ | Server is used to configure the HTTP(S) server for the proxy application.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
170170| `metricsServer` | _[Server](#server)_ | MetricsServer is used to configure the HTTP(S) server for metrics.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
171−| `providers` | _[Providers](#providers)_ | Providers is used to configure multiple providers. |
171+| `providers` | _[Providers](#providers)_ | Providers is used to configure your provider. **Multiple-providers is not<br/>yet working.** [This feature is tracked in<br/>#925](https://github.com/oauth2-proxy/oauth2-proxy/issues/926) |
172172
173173### AzureOptions
174174
@@ -472,7 +472,11 @@ and oidc.
472472
473473(**Appears on:** [AlphaOptions](#alphaoptions))
474474
475−Providers is a collection of definitions for providers.
475+The provider can be selected using the `provider` configuration value, or
476+set in the [`providers` array using
477+AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers).
478+However, [**the feature to implement multiple providers is not
479+complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
476480
477481### SecretSource
478482
docs/versioned_docs/version-7.9.x/configuration/providers/index.md+1−1
@@ -25,7 +25,7 @@ Valid providers are :
2525- [Nextcloud](nextcloud.md)
2626- [OpenID Connect](openid_connect.md)
2727
28−The provider can be selected using the `provider` configuration value.
28+The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
2929
3030Please note that not all providers support all claims. The `preferred_username` claim is currently only supported by the
3131OpenID Connect provider.
pkg/apis/options/alpha_options.go+3−1
@@ -41,7 +41,9 @@ type AlphaOptions struct {
4141 // To use the secure server you must configure a TLS certificate and key.
4242 MetricsServer Server `json:"metricsServer,omitempty"`
4343
44− // Providers is used to configure multiple providers.
44+ // Providers is used to configure your provider. **Multiple-providers is not
45+ // yet working.** [This feature is tracked in
46+ // #925](https://github.com/oauth2-proxy/oauth2-proxy/issues/926)
4547 Providers Providers `json:"providers,omitempty"`
4648}
4749
pkg/apis/options/providers.go+5−1
@@ -11,7 +11,11 @@ const (
1111// OIDCAudienceClaims is the generic audience claim list used by the OIDC provider.
1212var OIDCAudienceClaims = []string{"aud"}
1313
14−// Providers is a collection of definitions for providers.
14+// The provider can be selected using the `provider` configuration value, or
15+// set in the [`providers` array using
16+// AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers).
17+// However, [**the feature to implement multiple providers is not
18+// complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
1519type Providers []Provider
1620
1721// Provider holds all configuration for a single provider