5d7d0c4b4b
* Update README.md * Add changelog entry Co-Authored-By: Joel Speed <Joel.speed@hotmail.co.uk>
44 lines
2.0 KiB
Markdown
44 lines
2.0 KiB
Markdown
# oauth2_proxy
|
|
|
|
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](https://github.com/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](CHANGELOG.md).
|
|
|
|
[](http://travis-ci.org/pusher/oauth2_proxy)
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
1. Choose how to deploy:
|
|
|
|
a. Download [Prebuilt Binary](https://github.com/pusher/oauth2_proxy/releases) (current release is `v3.2.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](https://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-3.2.0.linux-amd64: OK
|
|
```
|
|
|
|
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)
|
|
|
|
## Docs
|
|
|
|
Read the docs on our [Docs site](https://pusher.github.io/oauth2_proxy).
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
Please see our [Contributing](CONTRIBUTING.md) guidelines.
|