git.iko.soy/typeable/oauth2-proxy
on master help sign in
Update generated docs reference
86e672eJoel Speed
docs/docs/configuration/alpha_config.md+26−1
@@ -117,6 +117,8 @@ They may change between releases without notice.
117| `upstreams` | _[Upstreams](#upstreams)_ | Upstreams is used to configure upstream servers.<br/>Once a user is authenticated, requests to the server will be proxied to<br/>these upstream servers based on the path mappings defined in this list. |
117| `upstreams` | _[Upstreams](#upstreams)_ | Upstreams is used to configure upstream servers.<br/>Once a user is authenticated, requests to the server will be proxied to<br/>these upstream servers based on the path mappings defined in this list. |
118| `injectRequestHeaders` | _[[]Header](#header)_ | InjectRequestHeaders is used to configure headers that should be added<br/>to requests to upstream servers.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
118| `injectRequestHeaders` | _[[]Header](#header)_ | InjectRequestHeaders is used to configure headers that should be added<br/>to requests to upstream servers.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
119| `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. |
119| `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. |
120+| `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. |
121+| `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. |
120
122
121### ClaimSource
123### ClaimSource
122
124
@@ -172,7 +174,7 @@ make up the header value
172
174
173### SecretSource
175### SecretSource
174
176
175−(**Appears on:** [ClaimSource](#claimsource), [HeaderValue](#headervalue))
177+(**Appears on:** [ClaimSource](#claimsource), [HeaderValue](#headervalue), [TLS](#tls))
176
178
177SecretSource references an individual secret value.
179SecretSource references an individual secret value.
178Only one source within the struct should be defined at any time.
180Only one source within the struct should be defined at any time.
@@ -183,6 +185,29 @@ Only one source within the struct should be defined at any time.
183| `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |
185| `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |
184| `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |
186| `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |
185
187
188+### Server
189+
190+(**Appears on:** [AlphaOptions](#alphaoptions))
191+
192+Server represents the configuration for an HTTP(S) server
193+
194+| Field | Type | Description |
195+| ----- | ---- | ----------- |
196+| `BindAddress` | _string_ | BindAddress is the the address on which to serve traffic.<br/>Leave blank or set to "-" to disable. |
197+| `SecureBindAddress` | _string_ | SecureBindAddress is the the address on which to serve secure traffic.<br/>Leave blank or set to "-" to disable. |
198+| `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the<br/>secure traffic. |
199+
200+### TLS
201+
202+(**Appears on:** [Server](#server))
203+
204+TLS contains the information for loading a TLS certifcate and key.
205+
206+| Field | Type | Description |
207+| ----- | ---- | ----------- |
208+| `Key` | _[SecretSource](#secretsource)_ | Key is the the TLS key data to use.<br/>Typically this will come from a file. |
209+| `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. |
210+
186### Upstream
211### Upstream
187
212
188(**Appears on:** [Upstreams](#upstreams))
213(**Appears on:** [Upstreams](#upstreams))