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>
This commit is contained in:
Evan Carroll
2025-04-28 23:52:27 +02:00
committed by GitHub
co-authored by Jan Larwig
parent 2ecb2c64aa
commit bae509d2ec
8 changed files with 29 additions and 11 deletions
+3 -1
View File
@@ -41,7 +41,9 @@ type AlphaOptions struct {
// To use the secure server you must configure a TLS certificate and key.
MetricsServer Server `json:"metricsServer,omitempty"`
// Providers is used to configure multiple providers.
// Providers is used to configure your provider. **Multiple-providers is not
// yet working.** [This feature is tracked in
// #925](https://github.com/oauth2-proxy/oauth2-proxy/issues/926)
Providers Providers `json:"providers,omitempty"`
}
+5 -1
View File
@@ -11,7 +11,11 @@ const (
// OIDCAudienceClaims is the generic audience claim list used by the OIDC provider.
var OIDCAudienceClaims = []string{"aud"}
// Providers is a collection of definitions for providers.
// 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).
type Providers []Provider
// Provider holds all configuration for a single provider