2018-11-27 11:23:37 +00:00
# oauth2_proxy
2012-12-11 01:34:58 +00:00
2016-11-18 17:31:22 +00:00
A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others)
2015-05-21 13:54:21 +00:00
to validate accounts by email, domain or group.
2012-12-11 01:34:58 +00:00
2019-01-07 16:43:27 +00:00
**Note:** This repository was forked from [bitly/OAuth2_Proxy ](https://github.com/bitly/oauth2_proxy ) on 27/11/2018.
2018-11-27 11:23:37 +00:00
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 ](CHANGELOG.md ).
2012-12-26 18:18:56 +00:00
2018-11-27 11:56:26 +00:00
[](http://travis-ci.org/pusher/oauth2_proxy)
2012-12-11 01:34:58 +00:00
2015-06-08 01:51:47 +00:00
2014-11-10 03:06:40 +00:00
2012-12-26 18:19:03 +00:00
## Installation
2018-12-20 14:28:13 +00:00
1. Choose how to deploy:
2019-08-16 14:06:53 +00:00
a. Download [Prebuilt Binary ](https://github.com/pusher/oauth2_proxy/releases ) (current release is `v4.0.0` )
2018-12-20 14:28:13 +00:00
b. Build with `$ go get github.com/pusher/oauth2_proxy` which will put the binary in `$GOROOT/bin`
2019-02-08 11:57:17 +00:00
c. Using the prebuilt docker image [quay.io/pusher/oauth2_proxy ](https://quay.io/pusher/oauth2_proxy ) (AMD64, ARMv6 and ARM64 tags available)
2018-12-20 14:28:13 +00:00
2019-01-14 10:07:22 +00:00
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` .
2018-11-27 11:23:37 +00:00
2017-11-20 19:35:59 +00:00
```
sha256sum -c sha256sum.txt 2>& 1 | grep OK
2019-08-16 14:06:53 +00:00
oauth2_proxy-4.0.0.linux-amd64: OK
2017-11-20 19:35:59 +00:00
```
2018-11-27 11:23:37 +00:00
2019-05-10 11:25:05 +00:00
2. [Select a Provider and Register an OAuth Application with a Provider ](https://pusher.github.io/oauth2_proxy/auth-configuration )
3. [Configure OAuth2 Proxy using config file, command line options, or environment variables ](https://pusher.github.io/oauth2_proxy/configuration )
4. [Configure SSL or Deploy behind a SSL endpoint ](https://pusher.github.io/oauth2_proxy/tls-configuration ) (example provided for Nginx)
2019-03-26 16:04:59 +00:00
2019-05-10 11:25:05 +00:00
## Docs
2019-03-26 16:04:59 +00:00
2019-05-10 11:25:05 +00:00
Read the docs on our [Docs site ](https://pusher.github.io/oauth2_proxy ).
2019-03-26 16:04:59 +00:00
2019-05-10 11:25:05 +00:00
2019-03-26 16:04:59 +00:00
2019-08-06 11:16:03 +00:00
## 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 ](http://gophers.slack.com/ ).
2018-12-20 14:14:04 +00:00
## Contributing
Please see our [Contributing ](CONTRIBUTING.md ) guidelines.
