update and add commentary to template file

ab-nginx.params.template

@@ -1,8 +1,73 @@
+#####
+# Parameters for use by ab-nginx convenience script
+#
+# NOTE: 'TRUE' and 'FALSE' MUST BE IN CAPITALS!
+#
+# If you are not using the 'ab-nginx.sh' script file to start the container,
+# then you don't have to do anything with this file.
+#####
+
+
+### NGINX options
+# Hostnames to which this instance of NGINX should answer:
+# 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 
+#   delimited.
+# This is NOT required if you are supplying your own server blocks via 
+#   'SERVERS_DIR'
 SERVER_NAMES="domain.tld www.domain.tld server.domain.tld alt.domain.tld"
+
+# Ports to expose on the HOST machine (container ALWAYS internally uses 80/443):
+# 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 
+#   container if you need help.  If you're using the 'test blocks', they 
+#   automatically adjust for non-standard ports
+# If you want to use the defaults, either leave these lines as-is, comment them 
+#   out or just delete them.
+HTTP_PORT=80
+HTTPS_PORT=443
+
+
+### Content files
+# Whatever you specify here will replace the default files in the container 
+#   with your content/configurations.
+
+# Specify a directory containing your NGINX configurations (if any)
+#   Remember that these will be all be applied in the HTTP configuration 
+#   context.
+# 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').
+CONFIG_DIR=$(pwd)/config/
+
+# 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 
+#   hard-coded 'test blocks' in the container and specify a webroot with your 
+#   files below.
+# More likely, you will have your own server blocks.  Remember, files are 
+#   processed in order so consider starting file names with numbers
+#   (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 
+#   file, simply change it's extension (i.e. '.conf.disabled').
+SERVERS_DIR=/home/user/server_blocks/
+
+# Specify a directory that contains files for your 'webroot'.  This includes 
+#   things like HTML, CSS, etc.
+WEBROOT_DIR=/home/user/my_web_stuff/
+
+
+### SSL options:
+# Enable HSTS only AFTER you've tested SSL implementation!  Container sets the 
+#   header to require SSL for 6 months! Subdomains are NOT included.
 HSTS=FALSE
+
+# If 'FALSE' (default), NGINX will accept both TLS 1.2 and 1.3 connections.
+# If 'TRUE', only TLS 1.3 connections will be accepted.
 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 
+#   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
 SSL_CERT=/path/to/your/ssl-certificate/fullchain.pem
 SSL_KEY=/path/to/your/ssl-private-key/privkey.pem
 SSL_CHAIN=/path/to/your/ssl-certificate-chain/chain.pem