updated README

This commit is contained in:
nd 2019-02-11 23:16:29 +01:00
parent e8205007bb
commit 2d8e15d369
No known key found for this signature in database
GPG key ID: 21B5CD4DEE3670E9

View file

@ -2,8 +2,7 @@
## Supported ## Supported
Nginx: 1.10.3 Only Nginx 1.10.3 and Debian Stretch.
Debian: Stretch
Other versions might work but are not tested. Other versions might work but are not tested.
@ -36,7 +35,7 @@ force_ssl: True
# array of upstream servers # array of upstream servers
server: server:
- -
# can be "unix:/path/to/socket" or "https://foo.bar" or "http://foo.bar" # can be "unix:/path/to/socket" or "foo.bar" or "foo.bar:443"
address: *mandatory* address: *mandatory*
# monitor dns for changes # monitor dns for changes
@ -45,7 +44,7 @@ server:
**vhosts**: **vhosts**:
``` ```
# Array of server names, example: foo.bar # array of server names, example: foo.bar
servername: [] servername: []
# set this server as default # set this server as default
@ -57,10 +56,10 @@ listen:
nossl: False nossl: False
nossl_port: 80 nossl_port: 80
# Example: https://upstream; If set to none no reverse proxy will be set up. # example: "https://upstream". If set to None no reverse proxy will be set up.
backend: None backend: None
# Set ssl certs to letsencrypt paths and enable letsencrypt for this vhost # sets ssl certs to letsencrypt paths and enable letsencrypt for this vhost
letsencrypt: False letsencrypt: False
# array of locations, see below # array of locations, see below
@ -72,7 +71,7 @@ locations: [*locationconfig*, .. ]
# a match definition, for example "/", see nginx docu: https://nginx.org/en/docs/http/ngx_http_core_module.html#location # a match definition, for example "/", see nginx docu: https://nginx.org/en/docs/http/ngx_http_core_module.html#location
match: '' match: ''
# path, only set if not none # an absolut unix path, only set if not none
alias: None alias: None
``` ```