docs(PARAMS): update comments for clarity
This commit is contained in:
parent
dcd3dbeac6
commit
6f4b2509b4
@ -7,20 +7,20 @@
|
|||||||
|
|
||||||
|
|
||||||
### Network options
|
### Network options
|
||||||
# If you want to specify a network to which this container should bind or one
|
# If you want to specify a network to which this container should bind or one
|
||||||
# that should be created, then use this variable. If you don't know what this
|
# that should be created, then use this variable. If you don't know what this
|
||||||
# means or if you just want to use the default, leave this line/variable
|
# means or if you just want to use the default, leave this line/variable
|
||||||
# commented-out.
|
# commented-out.
|
||||||
#NETWORK=nginx_network
|
#NETWORK=nginx_network
|
||||||
|
|
||||||
# If you want to specify a particular IP subnet for the network to be created
|
# If you want to specify a particular IP subnet for the network to be created
|
||||||
# as per the above variable, specify it here. Again, if you don't know what
|
# as per the above variable, specify it here. Again, if you don't know what
|
||||||
# this means, just leave this commented-out.
|
# this means, just leave this commented-out.
|
||||||
#SUBNET='172.31.254.0/24'
|
#SUBNET='172.31.254.0/24'
|
||||||
|
|
||||||
|
|
||||||
### Timezone
|
### Timezone
|
||||||
# This doesn't impact any functionality of the container, but it does make your
|
# This doesn't impact any functionality of the container, but it does make your
|
||||||
# logs easier to understand if they report the correct local time, right?
|
# logs easier to understand if they report the correct local time, right?
|
||||||
# (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
# (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||||
TZ=Area/Location
|
TZ=Area/Location
|
||||||
@ -28,64 +28,65 @@ TZ=Area/Location
|
|||||||
|
|
||||||
### NGINX options
|
### NGINX options
|
||||||
# Hostnames to which this instance of NGINX should answer:
|
# Hostnames to which this instance of NGINX should answer:
|
||||||
# By default, this is set to '_' meaning 'match anything'. However, that won't
|
# By default, this is set to '_' meaning 'match anything'. However, that won't
|
||||||
# work if you're using SSL certificates! Multiple hostnames must be space
|
# work if you're using SSL certificates! Multiple hostnames must be space
|
||||||
# delimited and "enclosed in quotes".
|
# delimited and "enclosed in quotes".
|
||||||
# This is NOT required if you are supplying your own server blocks via
|
# This is NOT required if you are supplying your own server blocks via
|
||||||
# 'SERVERS_DIR'
|
# 'SERVERS_DIR'
|
||||||
HOSTNAMES="domain.tld www.domain.tld server.domain.tld alt.domain.tld"
|
HOSTNAMES="domain.tld www.domain.tld server.domain.tld alt.domain.tld"
|
||||||
|
|
||||||
# Ports to expose on the HOST machine (container ALWAYS internally uses 80/443):
|
# Ports to listen on:
|
||||||
# If you need to use ports other than HTTP=80 and HTTPS=443, remember to set up
|
# If you need to use ports other than HTTP=80 and HTTPS=443, remember to set up
|
||||||
# your server blocks accordingly! See 'test_secured.conf.disabled' in the
|
# your server blocks accordingly! See 'test_secured.conf.disabled' in the
|
||||||
# container if you need help. If you're using the 'test blocks', they
|
# container if you need help. If you're using the default configuration, the
|
||||||
# automatically adjust for non-standard ports
|
# 'test blocks' automatically adjust for non-standard ports.
|
||||||
# If you want to use the defaults, either leave these lines as-is, comment them
|
# If you want to use the defaults, either leave these lines as-is, comment them
|
||||||
# out or just delete them.
|
# out or just delete them.
|
||||||
#HTTP_PORT=80
|
#HTTP_PORT=80
|
||||||
#HTTPS_PORT=443
|
#HTTPS_PORT=443
|
||||||
|
|
||||||
# Access logging (global preference):
|
# Access logging (global preference):
|
||||||
# Unless overridden in a server/location block, access logging will be handled
|
# Unless overridden in a server/location block, access logging will be handled
|
||||||
# according to this setting. Default is OFF. Choices are 'ON' or 'OFF'.
|
# according to this setting. Default is OFF. Choices are 'ON' or 'OFF'.
|
||||||
# Logs will be printed to the console so they are accessible via
|
# Logs will be printed to the console so they are accessible via
|
||||||
# 'docker logs ...'
|
# 'docker logs ...'
|
||||||
ACCESS_LOG=OFF
|
ACCESS_LOG=OFF
|
||||||
|
|
||||||
### Content files
|
### Content files
|
||||||
# Whatever you specify here will replace the default files in the container
|
# Whatever you specify here will replace the default files in the container
|
||||||
# with your content/configurations.
|
# with your content/configurations. You may comment any/all of the following
|
||||||
|
# lines to disable them use the container defaults.
|
||||||
|
|
||||||
# Specify a directory containing your NGINX configurations (if any)
|
# Specify a directory containing your NGINX configurations (if any)
|
||||||
# Remember that these will be all be applied in the HTTP configuration
|
# Remember that these will be all be applied in the HTTP configuration
|
||||||
# context.
|
# context.
|
||||||
# Only files with a ".conf" extension will be loaded! If you want to disable a
|
# Only files with a ".conf" extension will be loaded! If you want to disable a
|
||||||
# file, simply change it's extension (i.e. '.conf.disabled').
|
# file, simply change its extension (i.e. '.conf.disabled').
|
||||||
CONFIG_DIR=$(pwd)/config
|
CONFIG_DIR=$(pwd)/config
|
||||||
|
|
||||||
# Specify a directory containing your NGINX server-block configurations (if any)
|
# Specify a directory containing your NGINX server-block configurations (if any)
|
||||||
# If you are just serving static content from the 'webroot', you can use the
|
# If you are just serving static content from the 'webroot', you can use the
|
||||||
# hard-coded 'test blocks' in the container and specify a webroot with your
|
# hard-coded 'test blocks' in the container and specify a webroot with your
|
||||||
# files below.
|
# files below.
|
||||||
# More likely, you will have your own server blocks. Remember, files are
|
# More likely, you will have your own server blocks. Remember, files are
|
||||||
# processed in order so consider starting file names with numbers
|
# processed in order so consider starting file names with numbers
|
||||||
# (i.e. 00-first_server.conf, 05-second_server.conf)
|
# (i.e. 00-first_server.conf, 05-second_server.conf)
|
||||||
# Only files with a ".conf" extension will be loaded! If you want to disable a
|
# Only files with a ".conf" extension will be loaded! If you want to disable a
|
||||||
# file, simply change it's extension (i.e. '.conf.disabled').
|
# file, simply change its extension (i.e. '.conf.disabled').
|
||||||
SERVERS_DIR=$(pwd)/sites
|
SERVERS_DIR=$(pwd)/sites
|
||||||
|
|
||||||
# Specify a directory containing 'snippets' of NGINX code you want/need to
|
# Specify a directory containing 'snippets' of NGINX code you want/need to
|
||||||
# reference in various other configuration files. Pointers to additional SSL
|
# reference in various other configuration files. Pointers to additional SSL
|
||||||
# certificates for other hosted domains is a good example of this.
|
# certificates for other hosted domains is a good example of this.
|
||||||
SNIPPETS_DIR=$(pwd)/snippets
|
SNIPPETS_DIR=$(pwd)/snippets
|
||||||
|
|
||||||
# Specify a directory that contains files for your 'webroot'. This includes
|
# Specify a directory that contains files for your 'webroot'. This includes
|
||||||
# things like HTML, CSS, etc.
|
# things like HTML, CSS, etc.
|
||||||
WEBROOT_DIR=/var/www
|
WEBROOT_DIR=/var/www
|
||||||
|
|
||||||
|
|
||||||
### SSL options:
|
### SSL options:
|
||||||
# Enable HSTS only AFTER you've tested SSL implementation! Container sets the
|
# Enable HSTS only AFTER you've tested SSL implementation! Container sets the
|
||||||
# header to require SSL for 6 months! Subdomains are NOT included.
|
# header to require SSL for 6 months! Subdomains are NOT included.
|
||||||
HSTS=FALSE
|
HSTS=FALSE
|
||||||
|
|
||||||
@ -94,7 +95,7 @@ HSTS=FALSE
|
|||||||
TLS13_ONLY=FALSE
|
TLS13_ONLY=FALSE
|
||||||
|
|
||||||
### Certificate files to be bind-mounted
|
### Certificate files to be bind-mounted
|
||||||
# Remember, if you are mounting symlinks (like when using Let's Encrypt), you
|
# Remember, if you are mounting symlinks (like when using Let's Encrypt), you
|
||||||
# MUST specify the full path of the symlink so the target is resolved!
|
# MUST specify the full path of the symlink so the target is resolved!
|
||||||
# DH (Diffie-Hellman Parameters file) is only required if using TLS 1.2
|
# DH (Diffie-Hellman Parameters file) is only required if using TLS 1.2
|
||||||
#SSL_CERT=/path/to/your/ssl-certificate/fullchain.pem
|
#SSL_CERT=/path/to/your/ssl-certificate/fullchain.pem
|
||||||
|
Loading…
Reference in New Issue
Block a user