git.iko.soy/typeable/oauth2-proxy
on master help sign in
docs/conf/overview: Add hint about cookie prefixes to --cookie-name (#1744)
723f6ccFelix Stupp
docs/docs/configuration/overview.md+1−1
compare with master
unifiedsplit
@@ -89,7 +89,7 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
89| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
89| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
90| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
90| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
91| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
91| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
92−| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates | `"_oauth2_proxy"` |
92+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
93| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
93| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
94| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
94| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
95| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
95| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
docs/versioned_docs/version-6.1.x/configuration/overview.md+1−1
@@ -88,7 +88,7 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
88| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
88| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
89| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
89| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
90| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
90| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
91−| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates | `"_oauth2_proxy"` |
91+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
92| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
92| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
93| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
93| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
94| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
94| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
docs/versioned_docs/version-7.0.x/configuration/overview.md+1−1
@@ -88,7 +88,7 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
88| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
88| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
89| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
89| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
90| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
90| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
91−| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates | `"_oauth2_proxy"` |
91+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
92| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
92| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
93| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
93| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
94| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
94| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
docs/versioned_docs/version-7.1.x/configuration/overview.md+1−1
@@ -33,7 +33,7 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
33| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
33| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
34| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
34| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
35| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
35| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
36−| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates | `"_oauth2_proxy"` |
36+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
37| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
37| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
38| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
38| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
39| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
39| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
docs/versioned_docs/version-7.2.x/configuration/overview.md+1−1
@@ -88,7 +88,7 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
88| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
88| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
89| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
89| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
90| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
90| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
91−| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates | `"_oauth2_proxy"` |
91+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
92| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
92| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
93| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
93| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
94| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
94| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
docs/versioned_docs/version-7.3.x/configuration/overview.md+1−1
@@ -89,7 +89,7 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
89| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
89| `--cookie-domain` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
90| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
90| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |
91| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
91| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |
92−| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates | `"_oauth2_proxy"` |
92+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
93| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
93| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
94| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
94| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers \[[1](#footnote1)\] | |
95| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
95| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |