From 7a6204c8fd1a7a81758f00515e94651d6589b871 Mon Sep 17 00:00:00 2001 From: Jakub Holy Date: Sat, 15 Feb 2020 15:41:35 +0100 Subject: [PATCH] Fix #384 - link to sessions.md (#391) Co-authored-by: Joel Speed --- docs/README.md | 2 +- docs/configuration/configuration.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index d76b985a..ad5ef46b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ https://pusher.github.io/oauth2_proxy. When making changes to this docs site, please test your changes locally: ```bash -make serve +docs$ make serve ``` To run the docs site locally you will need Ruby at version 2.1.0 or diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md index 7e797264..9c501edf 100644 --- a/docs/configuration/configuration.md +++ b/docs/configuration/configuration.md @@ -38,7 +38,7 @@ An example [oauth2_proxy.cfg]({{ site.gitweb }}/contrib/oauth2_proxy.cfg.example | `-cookie-path` | string | an optional cookie path to force cookies to (ie: `/poc/`) | `"/"` | | `-cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable | | | `-cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | | -| `-cookie-secure` | bool | set secure (HTTPS) cookie flag | true | +| `-cookie-secure` | bool | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag) | true | | `-cookie-samesite` | string | set SameSite cookie attribute (ie: `"lax"`, `"strict"`, `"none"`, or `""`). | `""` | | `-custom-templates-dir` | string | path to custom html templates | | | `-display-htpasswd-form` | bool | display username / password login form if an htpasswd file is provided | true | @@ -94,9 +94,9 @@ An example [oauth2_proxy.cfg]({{ site.gitweb }}/contrib/oauth2_proxy.cfg.example | `-request-logging` | bool | Log requests | true | | `-request-logging-format` | string | Template for request log lines | see [Logging Configuration](#logging-configuration) | | `-resource` | string | The resource that is protected (Azure AD only) | | -| `-reverse-proxy` | bool | are we running behind a reverse proxy, controls whether headers like X-Real-Ip are accepted | false | +| `-reverse-proxy` | bool | are we running behind a reverse proxy, controls whether headers like X-Real-Ip are accepted | false | | `-scope` | string | OAuth scope specification | | -| `-session-store-type` | string | Session data storage backend | cookie | +| `-session-store-type` | string | [Session data storage backend](sessions); redis or cookie | cookie | | `-set-xauthrequest` | bool | set X-Auth-Request-User and X-Auth-Request-Email response headers (useful in Nginx auth_request mode) | false | | `-set-authorization-header` | bool | set Authorization Bearer response header (useful in Nginx auth_request mode) | false | | `-signature-key` | string | GAP-Signature request signature key (algorithm:secretkey) | |