2019-10-30 10:04:41 +00:00
2012-12-10 20:34:58 -05:00
2020-03-29 14:54:36 +01:00
[](http://travis-ci.org/oauth2-proxy/oauth2-proxy)
[](https://goreportcard.com/report/github.com/oauth2-proxy/oauth2-proxy)
[](https://godoc.org/github.com/oauth2-proxy/oauth2-proxy)
2019-10-14 02:33:18 +04:00
[](./LICENSE)
2016-11-18 09:31:22 -08:00
A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others)
2015-05-21 09:54:21 -04:00
to validate accounts by email, domain or group.
2012-12-10 20:34:58 -05: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
2020-03-29 16:24:41 +01:00
**Note:** This project was formerly hosted as `pusher/oauth2_proxy` but has been renamed as of 29/03/2020 to `oauth2-proxy/oauth2-proxy` .
Going forward, all images shall be available at `quay.io/oauth2-proxy/oauth2-proxy` and binaries wiil been named `oauth2-proxy` .
2015-06-07 21:51:47 -04:00
2014-11-09 22:06:40 -05:00
2012-12-26 18:19:03 +00:00
## Installation
2018-12-20 14:28:13 +00:00
1. Choose how to deploy:
2020-03-29 14:54:36 +01:00
a. Download [Prebuilt Binary ](https://github.com/oauth2-proxy/oauth2-proxy/releases ) (current release is `v5.1.0` )
2018-12-20 14:28:13 +00:00
2020-03-29 14:54:36 +01:00
b. Build with `$ go get github.com/oauth2-proxy/oauth2-proxy` which will put the binary in `$GOROOT/bin`
2018-12-20 14:28:13 +00:00
2020-03-29 14:54:36 +01:00
c. Using the prebuilt docker image [quay.io/oauth2-proxy/oauth2-proxy ](https://quay.io/oauth2-proxy/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 14:35:59 -05:00
```
sha256sum -c sha256sum.txt 2>& 1 | grep OK
2020-03-29 14:54:36 +01:00
oauth2-proxy-x.y.z.linux-amd64: OK
2017-11-20 14:35:59 -05:00
```
2018-11-27 11:23:37 +00:00
2020-03-29 14:54:36 +01:00
2. [Select a Provider and Register an OAuth Application with a Provider ](https://oauth2-proxy.github.io/oauth2-proxy/auth-configuration )
3. [Configure OAuth2 Proxy using config file, command line options, or environment variables ](https://oauth2-proxy.github.io/oauth2-proxy/configuration )
4. [Configure SSL or Deploy behind a SSL endpoint ](https://oauth2-proxy.github.io/oauth2-proxy/tls-configuration ) (example provided for Nginx)
2019-03-26 16:04:59 +00:00
2020-01-29 12:45:19 +00:00
## Security
2020-03-29 14:54:36 +01:00
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 ](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-qqxw-m5fj-f7gv )
2020-01-29 12:45:19 +00:00
2019-05-10 12:25:05 +01:00
## Docs
2019-03-26 16:04:59 +00:00
2020-03-29 14:54:36 +01:00
Read the docs on our [Docs site ](https://oauth2-proxy.github.io/oauth2-proxy ).
2019-03-26 16:04:59 +00:00
2019-05-10 12:25:05 +01:00
2019-03-26 16:04:59 +00:00
2019-08-06 12:16:03 +01: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
2019-12-16 16:08:44 +00:00
Please see our [Contributing ](CONTRIBUTING.md ) guidelines. For releasing see our [release creation guide ](RELEASE.md ).
