outtherelabs/oauth2_proxy repository overview

A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group.

Note: This repository was forked from bitly/OAuth2_Proxy⁠ on 27/11/2018. Versions v3.0.0 and up are from this fork and will have diverged from any changes in the original fork. A list of changes can be seen in the CHANGELOG⁠.

⁠Installation

1. Choose how to deploy:

   a. Download Prebuilt Binary⁠ (current release is v4.0.0)

   b. Build with $ go get github.com/pusher/oauth2_proxy which will put the binary in $GOROOT/bin

   c. Using the prebuilt docker image quay.io/pusher/oauth2_proxy⁠ (AMD64, ARMv6 and ARM64 tags available)

Prebuilt binaries can be validated by extracting the file and verifying it against the sha256sum.txt checksum file provided for each release starting with version v3.0.0.

sha256sum -c sha256sum.txt 2>&1 | grep OK
oauth2_proxy-4.0.0.linux-amd64: OK

1. Select a Provider and Register an OAuth Application with a Provider⁠
2. Configure OAuth2 Proxy using config file, command line options, or environment variables⁠
3. Configure SSL or Deploy behind a SSL endpoint⁠ (example provided for Nginx)

⁠Security

If you are running a version older than v5.0.0 we strongly recommend you please update to a current version. RE: open redirect vulnverability⁠

⁠Docs

Read the docs on our Docs site⁠.

⁠Getting Involved

If you would like to reach out to the maintainers, come talk to us in the #oauth2_proxy channel in the Gophers slack⁠.

⁠Contributing

Please see our Contributing⁠ guidelines. For releasing see our release creation guide⁠.