You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-authenticated-emails-file string: authenticate against emails via file (one per line)
195
195
-basic-auth-password string: the password to set when passing the HTTP Basic Auth header
@@ -240,9 +240,9 @@ See below for provider specific options
240
240
241
241
### Upstream Configuration
242
242
243
-
`oauth2_proxy` supports having multiple upstreams, and has the option to pass requests on to HTTP(S) servers or serve static files from the file system. HTTP and HTTPS upstreams are configured by providing a URL such as `http://127.0.0.1:8080/` for the upstream parameter, that will forward all authenticated requests to be forwarded to the upstream server. If you instead provide `http://127.0.0.1:8080/some/path/` then it will only be requests that start with `/some/path/` which are forwarded to the upstream.
243
+
`oauth-proxy` supports having multiple upstreams, and has the option to pass requests on to HTTP(S) servers or serve static files from the file system. HTTP and HTTPS upstreams are configured by providing a URL such as `http://127.0.0.1:8080/` for the upstream parameter, that will forward all authenticated requests to be forwarded to the upstream server. If you instead provide `http://127.0.0.1:8080/some/path/` then it will only be requests that start with `/some/path/` which are forwarded to the upstream.
244
244
245
-
Static file paths are configured as a file:// URL. `file:///var/www/static/` will serve the files from that directory at `http://[oauth2_proxy url]/var/www/static/`, which may not be what you want. You can provide the path to where the files should be available by adding a fragment to the configured URL. The value of the fragment will then be used to specify which path the files are available at. `file:///var/www/static/#/static/` will ie. make `/var/www/static/` available at `http://[oauth2_proxy url]/static/`.
245
+
Static file paths are configured as a file:// URL. `file:///var/www/static/` will serve the files from that directory at `http://[oauth-proxy url]/var/www/static/`, which may not be what you want. You can provide the path to where the files should be available by adding a fragment to the configured URL. The value of the fragment will then be used to specify which path the files are available at. `file:///var/www/static/#/static/` will ie. make `/var/www/static/` available at `http://[oauth-proxy url]/static/`.
246
246
247
247
Multiple upstreams can either be configured by supplying a comma separated list to the `-upstream` parameter, supplying the parameter multiple times or provinding a list in the [config file](#config-file). When multiple upstreams are used routing to them will be based on the path they are set up with.
248
248
@@ -265,10 +265,10 @@ There are two recommended configurations.
265
265
266
266
1) Configure SSL Terminiation with OAuth2 Proxy by providing a `--tls-cert=/path/to/cert.pem` and `--tls-key=/path/to/cert.key`.
267
267
268
-
The command line to run `oauth2_proxy` in this configuration would look like this:
268
+
The command line to run `oauth-proxy` in this configuration would look like this:
269
269
270
270
```bash
271
-
./oauth2_proxy \
271
+
./oauth-proxy \
272
272
--email-domain="yourcompany.com" \
273
273
--upstream=http://127.0.0.1:8080/ \
274
274
--tls-cert=/path/to/cert.pem \
@@ -283,12 +283,12 @@ The command line to run `oauth2_proxy` in this configuration would look like thi
283
283
284
284
2) Configure SSL Termination with [Nginx](http://nginx.org/) (example config below), Amazon ELB, Google Cloud Platform Load Balancing, or ....
285
285
286
-
Because `oauth2_proxy` listens on `127.0.0.1:4180` by default, to listen on all interfaces (needed when using an
286
+
Because `oauth-proxy` listens on `127.0.0.1:4180` by default, to listen on all interfaces (needed when using an
287
287
external load balancer like Amazon ELB or Google Platform Load Balancing) use `--http-address="0.0.0.0:4180"` or
288
288
`--http-address="http://:4180"`.
289
289
290
-
Nginx will listen on port `443` and handle SSL connections while proxying to `oauth2_proxy` on port `4180`.
291
-
`oauth2_proxy` will then authenticate requests for an upstream application. The external endpoint for this example
290
+
Nginx will listen on port `443` and handle SSL connections while proxying to `oauth-proxy` on port `4180`.
291
+
`oauth-proxy` will then authenticate requests for an upstream application. The external endpoint for this example
292
292
would be `https://internal.yourcompany.com/`.
293
293
294
294
An example Nginx config follows. Note the use of `Strict-Transport-Security` header to pin requests to SSL
@@ -314,10 +314,10 @@ server {
314
314
}
315
315
```
316
316
317
-
The command line to run `oauth2_proxy` in this configuration would look like this:
317
+
The command line to run `oauth-proxy` in this configuration would look like this:
318
318
319
319
```bash
320
-
./oauth2_proxy \
320
+
./oauth-proxy \
321
321
--email-domain="yourcompany.com" \
322
322
--upstream=http://127.0.0.1:8080/ \
323
323
--cookie-secret=... \
@@ -329,14 +329,14 @@ The command line to run `oauth2_proxy` in this configuration would look like thi
329
329
330
330
## Endpoint Documentation
331
331
332
-
OAuth2 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.
332
+
oauth-proxy responds directly to the following endpoints. All other endpoints will be proxied upstream when authenticated. The `/oauth` prefix can be changed with the `--proxy-prefix` config variable.
333
333
334
334
* /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
335
-
* /ping - returns an 200 OK response
336
-
* /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies)
337
-
* /oauth2/start - a URL that will redirect to start the OAuth cycle
338
-
* /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.
339
-
* /oauth2/auth - only returns a 202 Accepted response or a 401 Unauthorized response; for use with the [Nginx `auth_request` directive](#nginx-auth-request)
335
+
* /oauth/healthz - returns an 200 OK response
336
+
* /oauth/sign_in - the login page, which also doubles as a sign out page (it clears cookies)
337
+
* /oauth/start - a URL that will redirect to start the OAuth cycle
338
+
* /oauth/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.
339
+
* /oauth/auth - only returns a 202 Accepted response or a 401 Unauthorized response; for use with the [Nginx `auth_request` directive](#nginx-auth-request)
340
340
341
341
## Request signatures
342
342
@@ -358,15 +358,15 @@ following:
358
358
359
359
## Logging Format
360
360
361
-
OAuth2 Proxy logs requests to stdout in a format similar to Apache Combined Log.
361
+
oauth-proxy logs requests to stdout in a format similar to Apache Combined Log.
## <aname="nginx-auth-request"></a>Configuring for use with the Nginx `auth_request` directive
368
368
369
-
The [Nginx `auth_request` directive](http://nginx.org/en/docs/http/ngx_http_auth_request_module.html) allows Nginx to authenticate requests via the oauth2_proxy's `/auth` endpoint, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the request through. For example:
369
+
The [Nginx `auth_request` directive](http://nginx.org/en/docs/http/ngx_http_auth_request_module.html) allows Nginx to authenticate requests via the oauth-proxy's `/auth` endpoint, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the request through. For example:
0 commit comments