git.iko.soy/typeable/oauth2-proxy
on master help sign in
Small clarification around health checks (#84)

Type: docs I simply added the word health check. I was searching all over the package for a health check, to only realise that it had been called ping. I think the small addition might help others avoid my troubles.

commit66c5eb3174376098463348889bca431578fcb303 authorBen <9087625+benfdking@users.noreply.github.com> dateTue 5 Mar 2019, 14:09 (8 years ago) parenteacba4e
1 file changed+1−1
compare with master
unifiedsplit
README.md+1−1
README.md+1−1
@@ -361,7 +361,7 @@ The command line to run `oauth2_proxy` in this configuration would look like thi
361361OAuth2 Proxy responds directly to the following endpoints. All other endpoints will be proxied upstream when authenticated. The `/oauth2` prefix can be changed with the `--proxy-prefix` config variable.
362362
363363- /robots.txt - returns a 200 OK response that disallows all User-agents from all paths; see [robotstxt.org](http://www.robotstxt.org/) for more info
364−- /ping - returns an 200 OK response
364+- /ping - returns a 200 OK response, which is intended for use with health checks
365365- /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies)
366366- /oauth2/start - a URL that will redirect to start the OAuth cycle
367367- /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.