diff --git a/README.md b/README.md index cc12822..7f1cd9f 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ ## Supported -Nginx: 1.10.3 -Debian: Stretch +Only Nginx 1.10.3 and Debian Stretch. Other versions might work but are not tested. @@ -36,7 +35,7 @@ force_ssl: True # array of upstream servers 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* # monitor dns for changes @@ -45,7 +44,7 @@ server: **vhosts**: ``` -# Array of server names, example: foo.bar +# array of server names, example: foo.bar servername: [] # set this server as default @@ -57,10 +56,10 @@ listen: nossl: False 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 -# 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 # 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 match: '' -# path, only set if not none +# an absolut unix path, only set if not none alias: None ```