@@ -48,7 +48,7 @@ Valid providers are :
4848- [GitHub](#github-auth-provider)
4949- [GitLab](#gitlab-auth-provider)
5050- [LinkedIn](#linkedin-auth-provider)
51−- [login.gov](#login.gov-provider)
51+- [login.gov](#logingov-provider)
5252
5353The provider can be selected using the `provider` configuration value.
5454
@@ -172,12 +172,12 @@ OpenID Connect is a spec for OAUTH 2.0 + identity that is implemented by many ma
172172login.gov is an OIDC provider for the US Government.
173173If you are a US Government agency, you can contact the login.gov team through the contact information
174174that you can find on https://login.gov/developers/ and work with them to understand how to get login.gov
175−accounts for integration/test and production access.
175+accounts for integration/test and production access.
176176
177177A developer guide is available here: https://developers.login.gov/, though this proxy handles everything
178178but the data you need to create to register your application in the login.gov dashboard.
179179
180−As a demo, we will assume that you are running your application that you want to secure locally on
180+As a demo, we will assume that you are running your application that you want to secure locally on
181181http://localhost:3000/, that you will be starting your proxy up on http://localhost:4180/, and that
182182you have an agency integration account for testing.
183183
@@ -261,6 +261,7 @@ Usage of oauth2_proxy:
261261 -client-secret string: the OAuth Client Secret
262262 -config string: path to config file
263263 -cookie-domain string: an optional cookie domain to force cookies to (ie: .yourcompany.com)
264+ -cookie-path string: an optional cookie path to force cookies to (ie: /foo)
264265 -cookie-expire duration: expire timeframe for cookie (default 168h0m0s)
265266 -cookie-httponly: set HttpOnly cookie flag (default true)
266267 -cookie-name string: the name of the cookie that the oauth_proxy creates (default "_oauth2_proxy")
@@ -272,6 +273,7 @@ Usage of oauth2_proxy:
272273 -email-domain value: authenticate emails with the specified domain (may be given multiple times). Use * to authenticate any email
273274 -flush-interval: period between flushing response buffers when streaming responses (default "1s")
274275 -footer string: custom footer string. Use "-" to disable default footer.
276+ -gcp-healthchecks: will enable /liveness_check, /readiness_check, and / (with the proper user-agent) endpoints that will make it work well with GCP App Engine and GKE Ingresses (default false)
275277 -github-org string: restrict logins to members of this organisation
276278 -github-team string: restrict logins to members of any of these teams (slug), separated by a comma
277279 -google-admin-email string: the google admin to impersonate for api calls
@@ -335,6 +337,7 @@ The following environment variables can be used in place of the corresponding co
335337- `OAUTH2_PROXY_COOKIE_NAME`
336338- `OAUTH2_PROXY_COOKIE_SECRET`
337339- `OAUTH2_PROXY_COOKIE_DOMAIN`
340+- `OAUTH2_PROXY_COOKIE_PATH`
338341- `OAUTH2_PROXY_COOKIE_EXPIRE`
339342- `OAUTH2_PROXY_COOKIE_REFRESH`
340343- `OAUTH2_PROXY_SIGNATURE_KEY`
@@ -411,7 +414,7 @@ The command line to run `oauth2_proxy` in this configuration would look like thi
411414OAuth2 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.
412415
413416- /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
414−- /ping - returns a 200 OK response, which is intended for use with health checks
417+- /ping - returns a 200 OK response, which is intended for use with health checks
415418- /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies)
416419- /oauth2/start - a URL that will redirect to start the OAuth cycle
417420- /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.
@@ -505,7 +508,7 @@ server {
505508 auth_request_set $auth_cookie $upstream_http_set_cookie;
506509 add_header Set-Cookie $auth_cookie;
507510
508− # When using the --set-authorization flag, some provider's cookies can exceed the 4kb
511+ # When using the --set-authorization-header flag, some provider's cookies can exceed the 4kb
509512 # limit and so the OAuth2 Proxy splits these into multiple parts.
510513 # Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,
511514 # so if your cookies are larger than 4kb, you will need to extract additional cookies manually.