Skip to content

Commit c454f67

Browse files
committed
Update README.md
1 parent 2ba65c6 commit c454f67

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
oauth_proxy
22
=================
33

4-
Note: this is a fork of bit.ly's google_oauth_proxy project that works for any oauth provider (where any has actually been tested on Github and Google, YMMV)
4+
Note: this is a fork of bit.ly's google_auth_proxy project that works for any oauth provider (where any has actually been tested on Github and Google, YMMV)
55

66
A reverse proxy that provides authentication using an oauth server to validate
7-
individual accounts, or a whole google apps domain.
7+
individual accounts.
88

99
## Architecture
1010

1111
```
1212
_______ ___________________ __________
13-
|Nginx| ----> |google_auth_proxy| ----> |upstream|
13+
|Nginx| ----> | oauth_proxy | ----> |upstream|
1414
------- ------------------- ----------
1515
||
1616
\/
@@ -21,14 +21,14 @@ individual accounts, or a whole google apps domain.
2121
## Installation
2222

2323
1. [Install Go](http://golang.org/doc/install)
24-
2. `$ go get github.com/bitly/google_auth_proxy`. This should put the binary in `$GOROOT/bin`
24+
2. `$ go get github.com/kevin1024/oauth_proxy`. This should put the binary in `$GOROOT/bin`
2525

2626
## OAuth Configuration
2727

28-
You will need to register an OAuth application with google, and configure it with Redirect URI(s) for the domain you
29-
intend to run google_auth_proxy on.
28+
You will need to register an OAuth application with your chosen oauth provider, and configure it with Redirect URI(s) for the domain you
29+
intend to run oauth_proxy on.
3030

31-
1. Visit to Google Api Console https://code.google.com/apis/console/
31+
1. Visit the provider's API console
3232
2. under "API Access", choose "Create an OAuth 2.0 Client ID"
3333
3. Edit the application settings, and list the Redirect URI(s) where you will run your application. For example:
3434
`https://internalapp.yourcompany.com/oauth2/callback`
@@ -37,9 +37,9 @@ intend to run google_auth_proxy on.
3737
## Command Line Options
3838

3939
```
40-
Usage of ./google_auth_proxy:
40+
Usage of ./gooauth_proxy:
4141
-authenticated-emails-file="": authenticate against emails via file (one per line)
42-
-client-id="": the Google OAuth Client ID: ie: "123456.apps.googleusercontent.com"
42+
-client-id="": the OAuth Client ID: ie: "123456.apps.googleusercontent.com"
4343
-client-secret="": the OAuth Client Secret
4444
-cookie-domain="": an optional cookie domain to force cookies to
4545
-cookie-secret="": the seed string for secure cookies
@@ -59,7 +59,7 @@ Usage of ./google_auth_proxy:
5959

6060
## Example Configuration
6161

62-
This example has a [Nginx](http://nginx.org/) SSL endpoint proxying to `google_auth_proxy` on port `4180`.
62+
This example has a [Nginx](http://nginx.org/) SSL endpoint proxying to `oauth_proxy` on port `4180`.
6363
`google_auth_proxy` then authenticates requests for an upstream application running on port `8080`. The external
6464
endpoint for this example would be `https://internal.yourcompany.com/`.
6565

@@ -98,7 +98,7 @@ The environment variables `google_auth_client_id`, `google_auth_secret` and `goo
9898

9999
## Endpoint Documentation
100100

101-
Google auth proxy responds directly to the following endpoints. All other endpoints will be authenticated.
101+
ogooauth proxy responds directly to the following endpoints. All other endpoints will be authenticated.
102102

103103
* /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies)
104104
* /oauth2/start - a URL that will redirect to start the oauth cycle

0 commit comments

Comments
 (0)