Skip to content

Commit

Permalink
Add releases info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
thomseddon committed Jun 10, 2019
1 parent d33ecc0 commit 2c148d3
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

A minimal forward authentication service that provides Google oauth based login and authentication for the [traefik](https://github.com/containous/traefik) reverse proxy/load balancer.


## Why?

- Seamlessly overlays any http service with a single endpoint (see: `url-path` in [Configuration](#configuration))
Expand All @@ -16,6 +15,7 @@ A minimal forward authentication service that provides Google oauth based login

# Contents

- [Releases](#releases)
- [Usage](#usage)
- [Simple](#simple)
- [Advanced](#advanced)
Expand All @@ -32,6 +32,16 @@ A minimal forward authentication service that provides Google oauth based login
- [Copyright](#copyright)
- [License](#license)

## Releases

We recommend using the `2` tag on docker hub.

You can also use the latest incremental releases found on [docker hub](https://hub.docker.com/r/thomseddon/traefik-forward-auth/tags) and [github](https://github.com/thomseddon/traefik-forward-auth/releases).

#### Upgrade Guide

v2 was released in June 2019, whilst this is fully backwards compatible, a number of configuration options were modified, please see the [upgrade guide](https://github.com/thomseddon/traefik-forward-auth/wiki/v2-Upgrade-Guide) to prevent warnings on startup and ensure you are using the current configuration.

## Usage

#### Simple:
Expand Down Expand Up @@ -96,10 +106,6 @@ Create a new project then search for and select "Credentials" in the search bar.

Click "Create Credentials" > "OAuth client ID". Select "Web Application", fill in the name of your app, skip "Authorized JavaScript origins" and fill "Authorized redirect URIs" with all the domains you will allow authentication from, appended with the `url-path` (e.g. https://app.test.com/_oauth)

#### Upgrade Guide

v2 was released in April 2019, whilst this is fully backwards compatible, a number of configuration options were modified, please see the [upgrade guide](https://github.com/thomseddon/traefik-forward-auth/wiki/v2-Upgrade-Guide) to prevent warnings on startup and ensure you are using the current configuration.

## Configuration

### Overview
Expand Down

0 comments on commit 2c148d3

Please sign in to comment.