From 8dfb7e9b26cb6cb124711bb99ca407732d7af4da Mon Sep 17 00:00:00 2001 From: Blue Falcon <130698314+anonhostpi@users.noreply.github.com> Date: Mon, 24 Jun 2024 13:15:24 -0700 Subject: [PATCH] docs: update README and fix code some commentary typos (#2608) * Update overview.md see: https://github.com/oauth2-proxy/oauth2-proxy/blob/fc701bfd6a992bb074671b91ac89b50a79d3dc3d/pkg/apis/options/options.go#L123 * docs(code-commentary): typo - fixed typo --------- Co-authored-by: Jan Larwig --- docs/docs/configuration/overview.md | 2 +- pkg/providers/oidc/provider_verifier.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/configuration/overview.md b/docs/docs/configuration/overview.md index e1cce4d3..6bcada4d 100644 --- a/docs/docs/configuration/overview.md +++ b/docs/docs/configuration/overview.md @@ -161,7 +161,7 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/ | `--real-client-ip-header` | string | Header used to determine the real IP of the client, requires `--reverse-proxy` to be set (one of: X-Forwarded-For, X-Real-IP, or X-ProxyUser-IP) | X-Real-IP | | `--redeem-url` | string | Token redemption endpoint | | | `--redirect-url` | string | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"` | | -| `--relative-redirect-url` | bool | allow relative OAuth Redirect URL.` | | +| `--relative-redirect-url` | bool | allow relative OAuth Redirect URL.` | false | | `--redis-cluster-connection-urls` | string \| list | List of Redis cluster connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-cluster` | | | `--redis-connection-url` | string | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`) | | | `--redis-insecure-skip-tls-verify` | bool | skip TLS verification when connecting to Redis | false | diff --git a/pkg/providers/oidc/provider_verifier.go b/pkg/providers/oidc/provider_verifier.go index 6a4669fa..c83df5d3 100644 --- a/pkg/providers/oidc/provider_verifier.go +++ b/pkg/providers/oidc/provider_verifier.go @@ -116,7 +116,7 @@ type verifierBuilder func(*oidc.Config) *oidc.IDTokenVerifier func getVerifierBuilder(ctx context.Context, opts ProviderVerifierOptions) (verifierBuilder, DiscoveryProvider, error) { if opts.SkipDiscovery { - // Instead of discovering the JWKs URK, it needs to be specified in the opts already + // Instead of discovering the JWKs URL, it needs to be specified in the opts already return newVerifierBuilder(ctx, opts.IssuerURL, opts.JWKsURL, opts.SupportedSigningAlgs), nil, nil }