From da9123f740d570374df9bf36ea66d3b94f712284 Mon Sep 17 00:00:00 2001 From: Jan Larwig Date: Mon, 23 Mar 2026 16:05:54 +0100 Subject: [PATCH] doc: fix config validation formatting (#3386) Signed-off-by: Jan Larwig --- docs/docs/configuration/overview.md | 74 +++++++++---------- .../version-7.15.x/configuration/overview.md | 74 +++++++++---------- 2 files changed, 74 insertions(+), 74 deletions(-) diff --git a/docs/docs/configuration/overview.md b/docs/docs/configuration/overview.md index 37f385c7..a73e3acd 100644 --- a/docs/docs/configuration/overview.md +++ b/docs/docs/configuration/overview.md @@ -72,43 +72,6 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/ | `--config-test` | test configuration and exit (for CI/CD validation) | | `--version` | print version string | -## Configuration Validation - -The `--config-test` flag validates your configuration file without starting the proxy server. This is useful for: -- **CI/CD pipelines**: Pre-deployment validation -- **Configuration management**: Testing before applying changes -- **Debugging**: Verifying syntax and required fields - -### Usage - -```bash -# Test legacy config -oauth2-proxy --config /etc/oauth2-proxy.cfg --config-test - -# Test alpha config -oauth2-proxy --config /etc/core.cfg --alpha-config /etc/alpha.yaml --config-test - -# CI/CD pre-deployment check -# Returns with exit code 1 if any validation errors occur -oauth2-proxy --config new-config.cfg --config-test -``` - -### Exit Codes - -- **0**: Configuration is valid ✅ -- **1**: Configuration is invalid (errors printed to stderr) ❌ - -### Validation Coverage - -The `--config-test` flag performs the **same comprehensive validation** as normal startup, including: -- Required fields (client ID, client secret, cookie secret, etc.) -- Syntax validation (TOML/YAML parsing) -- Provider configuration -- Upstream server definitions -- Session store connectivity (e.g., Redis network checks if configured) - -**Note**: Cannot be combined with `--convert-config-to-alpha`. - ### General Provider Options Provider specific options can be found on their respective subpages. @@ -305,6 +268,43 @@ Provider specific options can be found on their respective subpages. | flag: `--upstream-timeout`
toml: `upstream_timeout` | duration | maximum amount of time the server will wait for a response from the upstream | 30s | | flag: `--upstream`
toml: `upstreams` | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://` for static response. Routing is based on the path | | +## Configuration Validation + +The `--config-test` flag validates your configuration file without starting the proxy server. This is useful for: +- **CI/CD pipelines**: Pre-deployment validation +- **Configuration management**: Testing before applying changes +- **Debugging**: Verifying syntax and required fields + +### Usage + +```bash +# Test legacy config +oauth2-proxy --config /etc/oauth2-proxy.cfg --config-test + +# Test alpha config +oauth2-proxy --config /etc/core.cfg --alpha-config /etc/alpha.yaml --config-test + +# CI/CD pre-deployment check +# Returns with exit code 1 if any validation errors occur +oauth2-proxy --config new-config.cfg --config-test +``` + +### Exit Codes + +- **0**: Configuration is valid ✅ +- **1**: Configuration is invalid (errors printed to stderr) ❌ + +### Validation Coverage + +The `--config-test` flag performs the **same comprehensive validation** as normal startup, including: +- Required fields (client ID, client secret, cookie secret, etc.) +- Syntax validation (TOML/YAML parsing) +- Provider configuration +- Upstream server definitions +- Session store connectivity (e.g., Redis network checks if configured) + +**Note**: Cannot be combined with `--convert-config-to-alpha`. + ## Upstreams Configuration `oauth2-proxy` supports having multiple upstreams, and has the option to pass requests on to HTTP(S) servers, unix socket or serve static files from the file system. diff --git a/docs/versioned_docs/version-7.15.x/configuration/overview.md b/docs/versioned_docs/version-7.15.x/configuration/overview.md index 37f385c7..a73e3acd 100644 --- a/docs/versioned_docs/version-7.15.x/configuration/overview.md +++ b/docs/versioned_docs/version-7.15.x/configuration/overview.md @@ -72,43 +72,6 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/ | `--config-test` | test configuration and exit (for CI/CD validation) | | `--version` | print version string | -## Configuration Validation - -The `--config-test` flag validates your configuration file without starting the proxy server. This is useful for: -- **CI/CD pipelines**: Pre-deployment validation -- **Configuration management**: Testing before applying changes -- **Debugging**: Verifying syntax and required fields - -### Usage - -```bash -# Test legacy config -oauth2-proxy --config /etc/oauth2-proxy.cfg --config-test - -# Test alpha config -oauth2-proxy --config /etc/core.cfg --alpha-config /etc/alpha.yaml --config-test - -# CI/CD pre-deployment check -# Returns with exit code 1 if any validation errors occur -oauth2-proxy --config new-config.cfg --config-test -``` - -### Exit Codes - -- **0**: Configuration is valid ✅ -- **1**: Configuration is invalid (errors printed to stderr) ❌ - -### Validation Coverage - -The `--config-test` flag performs the **same comprehensive validation** as normal startup, including: -- Required fields (client ID, client secret, cookie secret, etc.) -- Syntax validation (TOML/YAML parsing) -- Provider configuration -- Upstream server definitions -- Session store connectivity (e.g., Redis network checks if configured) - -**Note**: Cannot be combined with `--convert-config-to-alpha`. - ### General Provider Options Provider specific options can be found on their respective subpages. @@ -305,6 +268,43 @@ Provider specific options can be found on their respective subpages. | flag: `--upstream-timeout`
toml: `upstream_timeout` | duration | maximum amount of time the server will wait for a response from the upstream | 30s | | flag: `--upstream`
toml: `upstreams` | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://` for static response. Routing is based on the path | | +## Configuration Validation + +The `--config-test` flag validates your configuration file without starting the proxy server. This is useful for: +- **CI/CD pipelines**: Pre-deployment validation +- **Configuration management**: Testing before applying changes +- **Debugging**: Verifying syntax and required fields + +### Usage + +```bash +# Test legacy config +oauth2-proxy --config /etc/oauth2-proxy.cfg --config-test + +# Test alpha config +oauth2-proxy --config /etc/core.cfg --alpha-config /etc/alpha.yaml --config-test + +# CI/CD pre-deployment check +# Returns with exit code 1 if any validation errors occur +oauth2-proxy --config new-config.cfg --config-test +``` + +### Exit Codes + +- **0**: Configuration is valid ✅ +- **1**: Configuration is invalid (errors printed to stderr) ❌ + +### Validation Coverage + +The `--config-test` flag performs the **same comprehensive validation** as normal startup, including: +- Required fields (client ID, client secret, cookie secret, etc.) +- Syntax validation (TOML/YAML parsing) +- Provider configuration +- Upstream server definitions +- Session store connectivity (e.g., Redis network checks if configured) + +**Note**: Cannot be combined with `--convert-config-to-alpha`. + ## Upstreams Configuration `oauth2-proxy` supports having multiple upstreams, and has the option to pass requests on to HTTP(S) servers, unix socket or serve static files from the file system.