aa0a725 · typeable/oauth2-proxy

git.iko.soy/typeable/oauth2-proxy

Readme: doc updates

commitaa0a725a3adf8735daa387becb7e83b843e34044 authorJehiah Czebotar <jehiah@gmail.com> dateTue 23 Jun 2015, 14:01 (11 years ago) parent8d50b37

2 files changed+4−2

unifiedsplit

README.md+3−1

@@ -50,6 +50,8 @@ For Google, the registration steps are:

5050 * Fill in the necessary fields and Save (this is _required_)

51515. 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

55571. 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+1−1

@@ -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