webserver-static-site

Description

This is under development, for now only 'nginx' is supported.

Resources

Variables

Name Type Default Description

document_root

string /var/www/html

The document root.

gzip_enabled

boolean True

Whether to enable gzip (only supported for nginx for now).

hostname

string localhost

The domain name the webserver should listen on.

index

list ['index.html', 'index.htm']

The index file name(s).

letsencrypt_staging

boolean False

Whether to use the letsencrypt staging server (for developing -- production only allows a few requests per day).

server_admin

string --

The server admin email.

skip_cert_request

boolean False

Useful if the https certificate(s) is/are already set up.

use_https

boolean False

Whether to use https (and request a letsencrypt certificate).

webserver

string nginx

The webserver type.

webserver_user

string --

The webserver user.

Command-line

frecklecute webserver-static-site --help

Usage: frecklecute webserver-static-site [OPTIONS]

  This is under development, for now only 'nginx' is supported.

Options:
  --document-root DOCUMENT_ROOT   The document root.  [default: /var/www/html]
  --gzip-enabled / --gzip-disabled
                                  Whether to enable gzip (only supported for
                                  nginx for now).
  --hostname HOSTNAME             The domain name the webserver should listen
                                  on.  [default: localhost]
  --index FILENAME                The index file name(s).  [default:
                                  index.html, index.htm]
  --letsencrypt-staging / --no-letsencrypt-staging
                                  Whether to use the letsencrypt staging
                                  server (for developing -- production only
                                  allows a few requests per day).
  --server-admin EMAIL            The server admin email.
  --skip-cert-request / --no-skip-cert-request
                                  Skip letsencrypt certificate request.
  --use-https / --no-use-https    Whether to use https (and request a
                                  letsencrypt certificate).
  --webserver WEBSERVER           The webserver type.  [default: nginx]
  --webserver-user WEBSERVER_USER
                                  The webserver user.
  --help                          Show this message and exit.