Skip to content
README.md 2.04 KiB
Newer Older
Joel Speed's avatar
Joel Speed committed
# oauth2_proxy
Jehiah Czebotar's avatar
Jehiah Czebotar committed

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

Joel Speed's avatar
Joel Speed committed
**Note:** This repository was forked from [bitly/OAuth2_Proxy](https://github.com/bitly/oauth2_proxy) on 27/11/2018.
Joel Speed's avatar
Joel Speed committed
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).
Jehiah Czebotar's avatar
Jehiah Czebotar committed

[![Build Status](https://secure.travis-ci.org/pusher/oauth2_proxy.svg?branch=master)](http://travis-ci.org/pusher/oauth2_proxy)
Jehiah Czebotar's avatar
Jehiah Czebotar committed

Jehiah Czebotar's avatar
Jehiah Czebotar committed
![Sign In Page](https://cloud.githubusercontent.com/assets/45028/4970624/7feb7dd8-6886-11e4-93e0-c9904af44ea8.png)
Jehiah Czebotar's avatar
Jehiah Czebotar committed
## 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)
Joel Speed's avatar
Joel Speed committed
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`.
Joel Speed's avatar
Joel Speed committed

oauth2_proxy-3.2.0.linux-amd64: OK
Joel Speed's avatar
Joel Speed committed

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).
![OAuth2 Proxy Architecture](https://cloud.githubusercontent.com/assets/45028/8027702/bd040b7a-0d6a-11e5-85b9-f8d953d04f39.png)
Joel Speed's avatar
Joel Speed committed
## Contributing

Please see our [Contributing](CONTRIBUTING.md) guidelines.