merged reverse proxy role, added docu

This commit is contained in:
nd 2019-02-10 21:21:12 +01:00
parent 2ebc49541a
commit d0e8250cbc
No known key found for this signature in database
GPG key ID: 21B5CD4DEE3670E9
6 changed files with 165 additions and 0 deletions

66
README.md Normal file
View file

@ -0,0 +1,66 @@
# Nginx
## Supported
Nginx: 1.10.3
Debian: Stretch
Other versions might work but are not tested.
## Parameters and defaults
DNS resolver have to be defined in the `resolver` array. Defaults:
```
resolver:
- 8.8.8.8
- 8.8.4.4
```
All other configuration is to be placed inside the `nginx` dict.
```
# name: *upstreamconfig*, see below for definition
upstreams: {}
# name: *vhostconfig*, see below for definition
vhosts: {}
# force all traffic on ssl, except letsencrypt challenges
force_ssl: True
```
** upstreamconfig **:
```
# array of upstream servers
server:
-
# can be "unix:/path/to/socket" or "https://foo.bar" or "http://foo.bar"
address: *mandatory*
# monitor dns for changes
resolve: true
```
** vhosts **:
```
# Array of server names, example: foo.bar
servername: []
# set this server as default
default_server: False
listen:
ssl: True
ssl_port: 443
nossl: False
nossl_port: 80
# Example: https://upstream; If set to none no reverse proxy will be set up.
backend: None
# Set ssl certs to letsencrypt paths and enable letsencrypt for this vhost
letsencrypt: True
```