Skip to content

Commit

Permalink
Update readme to mention branch on Traefik 1
Browse files Browse the repository at this point in the history
  • Loading branch information
avvertix committed Apr 30, 2020
1 parent 194a6f9 commit 76e34c7
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
# Reverse Proxy
This role sets up a reverse proxy, to route HTTP traffic to the containers. Currently this is facilitated by traefik.

This role sets up a reverse proxy, to route HTTP traffic to the containers. Currently this is facilitated by [Traefik](https://containo.us/traefik/).

> Current `master` targets Traefik 2.x, for Traefik 1.x support use [`traefik-1.x` branch](https://github.com/OneOffTech/ansible-role-reverseproxy/tree/traefik-1.x)
## Requirements
A working Docker installation on the host system is all you need. For automatic certificate generation via LetsEncrypt a domain name has to point toward your host address.

A working Docker installation on the host system is all you need.

For automatic certificate generation via LetsEncrypt a domain name has to point toward your host address.

## Configuration Variables

```yaml
path: "/home/user/reverseproxy" # Where the VPN proxy service will reside
data: "/data/reverseproxy/cert" # Where the certificates will be persisted
Expand All @@ -13,5 +20,6 @@ letsencrypt_email: "[email protected]" # Email of the admin, will be used for not
```

## Upgrading installations

To upgrade the installation it is sufficient to simply run this playbook again after increasing
the version number.

0 comments on commit 76e34c7

Please sign in to comment.