Skip to content
This repository was archived by the owner on Jan 24, 2019. It is now read-only.

Commit aa0a725

Browse files
committed
Readme: doc updates
1 parent 8d50b37 commit aa0a725

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ For Google, the registration steps are:
5050
* Fill in the necessary fields and Save (this is _required_)
5151
5. Take note of the **Client ID** and **Client Secret**
5252

53+
It's recommended to refresh sessions on a short interval (1h) with `cookie-refresh` setting which validates that the account is still authorized.
54+
5355
### GitHub Auth Provider
5456

5557
1. Create a new project: https://github.com/settings/developers
@@ -100,7 +102,7 @@ Usage of oauth2_proxy:
100102
-cookie-expire=168h0m0s: expire timeframe for cookie
101103
-cookie-httponly=true: set HttpOnly cookie flag
102104
-cookie-key="_oauth2_proxy": the name of the cookie that the oauth_proxy creates
103-
-cookie-refresh=0: refresh the cookie when less than this much time remains before expiration; 0 to disable
105+
-cookie-refresh=0: refresh the cookie after this duration; 0 to disable
104106
-cookie-secret="": the seed string for secure cookies
105107
-cookie-secure=true: set secure (HTTPS) cookie flag
106108
-custom-templates-dir="": path to custom html templates

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func main() {
5050
flagSet.String("cookie-secret", "", "the seed string for secure cookies")
5151
flagSet.String("cookie-domain", "", "an optional cookie domain to force cookies to (ie: .yourcompany.com)*")
5252
flagSet.Duration("cookie-expire", time.Duration(168)*time.Hour, "expire timeframe for cookie")
53-
flagSet.Duration("cookie-refresh", time.Duration(0), "refresh the cookie when less than this much time remains before expiration; 0 to disable")
53+
flagSet.Duration("cookie-refresh", time.Duration(0), "refresh the cookie after this duration; 0 to disable")
5454
flagSet.Bool("cookie-secure", true, "set secure (HTTPS) cookie flag")
5555
flagSet.Bool("cookie-httponly", true, "set HttpOnly cookie flag")
5656

0 commit comments

Comments
 (0)