Some typos (#1222)

* Some typos

* Also corrected the typo's in the src code

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>
This commit is contained in:
Frederic Pape 2021-06-02 20:41:30 +02:00 committed by GitHub
parent f648c54d87
commit cfd82daaf0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 19 additions and 19 deletions

View File

@ -212,7 +212,7 @@ response header.
| Field | Type | Description | | Field | Type | Description |
| ----- | ---- | ----------- | | ----- | ---- | ----------- |
| `name` | _string_ | Name is the header name to be used for this set of values.<br/>Names should be unique within a list of Headers. | | `name` | _string_ | Name is the header name to be used for this set of values.<br/>Names should be unique within a list of Headers. |
| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header<br/>should be preserved for the request to the upstream server.<br/>This option only takes effet on injected request headers.<br/>Defaults to false (headers that match this header will be stripped). | | `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header<br/>should be preserved for the request to the upstream server.<br/>This option only applies to injected request headers.<br/>Defaults to false (headers that match this header will be stripped). |
| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header | | `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |
### HeaderValue ### HeaderValue
@ -335,8 +335,8 @@ Server represents the configuration for an HTTP(S) server
| Field | Type | Description | | Field | Type | Description |
| ----- | ---- | ----------- | | ----- | ---- | ----------- |
| `BindAddress` | _string_ | BindAddress is the the address on which to serve traffic.<br/>Leave blank or set to "-" to disable. | | `BindAddress` | _string_ | BindAddress is the address on which to serve traffic.<br/>Leave blank or set to "-" to disable. |
| `SecureBindAddress` | _string_ | SecureBindAddress is the the address on which to serve secure traffic.<br/>Leave blank or set to "-" to disable. | | `SecureBindAddress` | _string_ | SecureBindAddress is the address on which to serve secure traffic.<br/>Leave blank or set to "-" to disable. |
| `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the<br/>secure traffic. | | `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the<br/>secure traffic. |
### TLS ### TLS
@ -347,7 +347,7 @@ TLS contains the information for loading a TLS certifcate and key.
| Field | Type | Description | | Field | Type | Description |
| ----- | ---- | ----------- | | ----- | ---- | ----------- |
| `Key` | _[SecretSource](#secretsource)_ | Key is the the TLS key data to use.<br/>Typically this will come from a file. | | `Key` | _[SecretSource](#secretsource)_ | Key is the TLS key data to use.<br/>Typically this will come from a file. |
| `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. | | `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. |
### Upstream ### Upstream

View File

@ -33,7 +33,7 @@ users to re-authenticate
### Redis Storage ### Redis Storage
The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information
back the the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back
to the user as the cookie value instead. to the user as the cookie value instead.
A ticket is composed as the following: A ticket is composed as the following:

View File

@ -33,7 +33,7 @@ users to re-authenticate
### Redis Storage ### Redis Storage
The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information
back the the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back
to the user as the cookie value instead. to the user as the cookie value instead.
A ticket is composed as the following: A ticket is composed as the following:

View File

@ -151,7 +151,7 @@ response header.
| Field | Type | Description | | Field | Type | Description |
| ----- | ---- | ----------- | | ----- | ---- | ----------- |
| `name` | _string_ | Name is the header name to be used for this set of values.<br/>Names should be unique within a list of Headers. | | `name` | _string_ | Name is the header name to be used for this set of values.<br/>Names should be unique within a list of Headers. |
| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header<br/>should be preserved for the request to the upstream server.<br/>This option only takes effet on injected request headers.<br/>Defaults to false (headers that match this header will be stripped). | | `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header<br/>should be preserved for the request to the upstream server.<br/>This option only applies to injected request headers.<br/>Defaults to false (headers that match this header will be stripped). |
| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header | | `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |
### HeaderValue ### HeaderValue

View File

@ -33,7 +33,7 @@ users to re-authenticate
### Redis Storage ### Redis Storage
The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information
back the the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back
to the user as the cookie value instead. to the user as the cookie value instead.
A ticket is composed as the following: A ticket is composed as the following:

View File

@ -153,7 +153,7 @@ response header.
| Field | Type | Description | | Field | Type | Description |
| ----- | ---- | ----------- | | ----- | ---- | ----------- |
| `name` | _string_ | Name is the header name to be used for this set of values.<br/>Names should be unique within a list of Headers. | | `name` | _string_ | Name is the header name to be used for this set of values.<br/>Names should be unique within a list of Headers. |
| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header<br/>should be preserved for the request to the upstream server.<br/>This option only takes effet on injected request headers.<br/>Defaults to false (headers that match this header will be stripped). | | `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header<br/>should be preserved for the request to the upstream server.<br/>This option only applies to injected request headers.<br/>Defaults to false (headers that match this header will be stripped). |
| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header | | `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |
### HeaderValue ### HeaderValue
@ -193,8 +193,8 @@ Server represents the configuration for an HTTP(S) server
| Field | Type | Description | | Field | Type | Description |
| ----- | ---- | ----------- | | ----- | ---- | ----------- |
| `BindAddress` | _string_ | BindAddress is the the address on which to serve traffic.<br/>Leave blank or set to "-" to disable. | | `BindAddress` | _string_ | BindAddress is the address on which to serve traffic.<br/>Leave blank or set to "-" to disable. |
| `SecureBindAddress` | _string_ | SecureBindAddress is the the address on which to serve secure traffic.<br/>Leave blank or set to "-" to disable. | | `SecureBindAddress` | _string_ | SecureBindAddress is the address on which to serve secure traffic.<br/>Leave blank or set to "-" to disable. |
| `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the<br/>secure traffic. | | `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the<br/>secure traffic. |
### TLS ### TLS
@ -205,7 +205,7 @@ TLS contains the information for loading a TLS certifcate and key.
| Field | Type | Description | | Field | Type | Description |
| ----- | ---- | ----------- | | ----- | ---- | ----------- |
| `Key` | _[SecretSource](#secretsource)_ | Key is the the TLS key data to use.<br/>Typically this will come from a file. | | `Key` | _[SecretSource](#secretsource)_ | Key is the TLS key data to use.<br/>Typically this will come from a file. |
| `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. | | `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. |
### Upstream ### Upstream

View File

@ -33,7 +33,7 @@ users to re-authenticate
### Redis Storage ### Redis Storage
The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information
back the the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back
to the user as the cookie value instead. to the user as the cookie value instead.
A ticket is composed as the following: A ticket is composed as the following:

View File

@ -9,7 +9,7 @@ type Header struct {
// PreserveRequestValue determines whether any values for this header // PreserveRequestValue determines whether any values for this header
// should be preserved for the request to the upstream server. // should be preserved for the request to the upstream server.
// This option only takes effet on injected request headers. // This option only applies to injected request headers.
// Defaults to false (headers that match this header will be stripped). // Defaults to false (headers that match this header will be stripped).
PreserveRequestValue bool `json:"preserveRequestValue,omitempty"` PreserveRequestValue bool `json:"preserveRequestValue,omitempty"`

View File

@ -2,11 +2,11 @@ package options
// Server represents the configuration for an HTTP(S) server // Server represents the configuration for an HTTP(S) server
type Server struct { type Server struct {
// BindAddress is the the address on which to serve traffic. // BindAddress is the address on which to serve traffic.
// Leave blank or set to "-" to disable. // Leave blank or set to "-" to disable.
BindAddress string BindAddress string
// SecureBindAddress is the the address on which to serve secure traffic. // SecureBindAddress is the address on which to serve secure traffic.
// Leave blank or set to "-" to disable. // Leave blank or set to "-" to disable.
SecureBindAddress string SecureBindAddress string
@ -17,7 +17,7 @@ type Server struct {
// TLS contains the information for loading a TLS certifcate and key. // TLS contains the information for loading a TLS certifcate and key.
type TLS struct { type TLS struct {
// Key is the the TLS key data to use. // Key is the TLS key data to use.
// Typically this will come from a file. // Typically this will come from a file.
Key *SecretSource Key *SecretSource

View File

@ -9,7 +9,7 @@ import (
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/logger" "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/logger"
) )
// errorMessages are default error messages for each of the the different // errorMessages are default error messages for each of the different
// http status codes expected to be rendered in the error page. // http status codes expected to be rendered in the error page.
var errorMessages = map[int]string{ var errorMessages = map[int]string{
http.StatusInternalServerError: "Oops! Something went wrong. For more information contact your server administrator.", http.StatusInternalServerError: "Oops! Something went wrong. For more information contact your server administrator.",

View File

@ -50,7 +50,7 @@ func (r *result) Body() []byte {
return r.body return r.body
} }
// UnmarshalInto attempts to unmarshal the response into the the given interface. // UnmarshalInto attempts to unmarshal the response into the given interface.
// The response body is assumed to be JSON. // The response body is assumed to be JSON.
// The response must have a 200 status otherwise an error will be returned. // The response must have a 200 status otherwise an error will be returned.
func (r *result) UnmarshalInto(into interface{}) error { func (r *result) UnmarshalInto(into interface{}) error {