cfd82da · typeable/oauth2-proxy

docs/docs/configuration/alpha_config.md+4−4

@@ -212,7 +212,7 @@ response header.

212| Field | Type | Description |

213| ----- | ---- | ----------- |

214| `name` | _string_ | Name is the header name to be used for this set of values. Names should be unique within a list of Headers. |

215−| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header should be preserved for the request to the upstream server. This option only takes effet on injected request headers. Defaults to false (headers that match this header will be stripped). |

215+| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header should be preserved for the request to the upstream server. This option only applies to injected request headers. Defaults to false (headers that match this header will be stripped). |

216| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |

217

218### HeaderValue

@@ -335,8 +335,8 @@ Server represents the configuration for an HTTP(S) server

335

336| Field | Type | Description |

337| ----- | ---- | ----------- |

338−| `BindAddress` | _string_ | BindAddress is the the address on which to serve traffic. Leave blank or set to "-" to disable. |

338+| `BindAddress` | _string_ | BindAddress is the address on which to serve traffic. Leave blank or set to "-" to disable. |

339−| `SecureBindAddress` | _string_ | SecureBindAddress is the the address on which to serve secure traffic. Leave blank or set to "-" to disable. |

339+| `SecureBindAddress` | _string_ | SecureBindAddress is the address on which to serve secure traffic. Leave blank or set to "-" to disable. |

340| `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the secure traffic. |

341

342### TLS

@@ -347,7 +347,7 @@ TLS contains the information for loading a TLS certifcate and key.

347

348| Field | Type | Description |

349| ----- | ---- | ----------- |

350−| `Key` | _[SecretSource](#secretsource)_ | Key is the the TLS key data to use. Typically this will come from a file. |

350+| `Key` | _[SecretSource](#secretsource)_ | Key is the TLS key data to use. Typically this will come from a file. |

351| `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use. Typically this will come from a file. |

352

353### Upstream

docs/docs/configuration/sessions.md+1−1

@@ -33,7 +33,7 @@ users to re-authenticate

33### Redis Storage

34

35The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information

36−back the the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

36+back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

37to the user as the cookie value instead.

38

39A ticket is composed as the following:

docs/versioned_docs/version-6.1.x/configuration/sessions.md+1−1

@@ -33,7 +33,7 @@ users to re-authenticate

33### Redis Storage

34

35The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information

36−back the the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

36+back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

37to the user as the cookie value instead.

38

39A ticket is composed as the following:

docs/versioned_docs/version-7.0.x/configuration/alpha_config.md+1−1

@@ -151,7 +151,7 @@ response header.

151| Field | Type | Description |

152| ----- | ---- | ----------- |

153| `name` | _string_ | Name is the header name to be used for this set of values. Names should be unique within a list of Headers. |

154−| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header should be preserved for the request to the upstream server. This option only takes effet on injected request headers. Defaults to false (headers that match this header will be stripped). |

154+| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header should be preserved for the request to the upstream server. This option only applies to injected request headers. Defaults to false (headers that match this header will be stripped). |

155| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |

156

157### HeaderValue

docs/versioned_docs/version-7.0.x/configuration/sessions.md+1−1

@@ -33,7 +33,7 @@ users to re-authenticate

33### Redis Storage

34

35The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information

36−back the the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

36+back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

37to the user as the cookie value instead.

38

39A ticket is composed as the following:

docs/versioned_docs/version-7.1.x/configuration/alpha_config.md+4−4

@@ -153,7 +153,7 @@ response header.

153| Field | Type | Description |

154| ----- | ---- | ----------- |

155| `name` | _string_ | Name is the header name to be used for this set of values. Names should be unique within a list of Headers. |

156−| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header should be preserved for the request to the upstream server. This option only takes effet on injected request headers. Defaults to false (headers that match this header will be stripped). |

156+| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header should be preserved for the request to the upstream server. This option only applies to injected request headers. Defaults to false (headers that match this header will be stripped). |

157| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |

158

159### HeaderValue

@@ -193,8 +193,8 @@ 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. Leave blank or set to "-" to disable. |

196+| `BindAddress` | _string_ | BindAddress is the address on which to serve traffic. Leave blank or set to "-" to disable. |

197−| `SecureBindAddress` | _string_ | SecureBindAddress is the the address on which to serve secure traffic. Leave blank or set to "-" to disable. |

197+| `SecureBindAddress` | _string_ | SecureBindAddress is the address on which to serve secure traffic. Leave blank or set to "-" to disable. |

198| `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the secure traffic. |

199

200### TLS

@@ -205,7 +205,7 @@ 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. Typically this will come from a file. |

208+| `Key` | _[SecretSource](#secretsource)_ | Key is the TLS key data to use. Typically this will come from a file. |

209| `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use. Typically this will come from a file. |

210

211### Upstream

docs/versioned_docs/version-7.1.x/configuration/sessions.md+1−1

@@ -33,7 +33,7 @@ users to re-authenticate

33### Redis Storage

34

35The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information

36−back the the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

36+back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

37to the user as the cookie value instead.

38

39A ticket is composed as the following:

pkg/apis/options/header.go+1−1

@@ -9,7 +9,7 @@ type Header struct {

9

10 // PreserveRequestValue determines whether any values for this header

11 // should be preserved for the request to the upstream server.

12− // This option only takes effet on injected request headers.

12+ // This option only applies to injected request headers.

13 // Defaults to false (headers that match this header will be stripped).

14 PreserveRequestValue bool `json:"preserveRequestValue,omitempty"`

15

pkg/apis/options/server.go+3−3

@@ -2,11 +2,11 @@ package options

2

3// Server represents the configuration for an HTTP(S) server

4type Server struct {

5− // BindAddress is the the address on which to serve traffic.

5+ // BindAddress is the address on which to serve traffic.

6 // Leave blank or set to "-" to disable.

7 BindAddress string

8

9− // SecureBindAddress is the the address on which to serve secure traffic.

9+ // SecureBindAddress is the address on which to serve secure traffic.

10 // Leave blank or set to "-" to disable.

11 SecureBindAddress string

12

@@ -17,7 +17,7 @@ type Server struct {

17

18// TLS contains the information for loading a TLS certifcate and key.

19type TLS struct {

20− // Key is the the TLS key data to use.

20+ // Key is the TLS key data to use.

21 // Typically this will come from a file.

22 Key *SecretSource

23

pkg/app/pagewriter/error_page.go+1−1

@@ -9,7 +9,7 @@ import (

9 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/logger"

10)

11

12−// errorMessages are default error messages for each of the the different

12+// errorMessages are default error messages for each of the different

13// http status codes expected to be rendered in the error page.

14var errorMessages = map[int]string{

15 http.StatusInternalServerError: "Oops! Something went wrong. For more information contact your server administrator.",

pkg/requests/result.go+1−1

@@ -50,7 +50,7 @@ func (r *result) Body() []byte {

50 return r.body

51}

52

53−// UnmarshalInto attempts to unmarshal the response into the the given interface.

53+// UnmarshalInto attempts to unmarshal the response into the given interface.

54// The response body is assumed to be JSON.

55// The response must have a 200 status otherwise an error will be returned.

56func (r *result) UnmarshalInto(into interface{}) error {