2021-06-22 11:50:48 +00:00
|
|
|
cdist-type__nginx(7)
|
2021-06-22 11:46:32 +00:00
|
|
|
===================================
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2021-06-22 11:50:48 +00:00
|
|
|
cdist-type__nginx - Serve web content with NGINX
|
2021-06-22 11:46:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2021-06-22 11:50:48 +00:00
|
|
|
Leverages `__nginx_vhost` to serve web content.
|
2021-06-22 11:46:32 +00:00
|
|
|
|
|
|
|
REQUIRED PARAMETERS
|
|
|
|
-------------------
|
|
|
|
domain
|
|
|
|
Domain name to be served.
|
|
|
|
|
|
|
|
OPTIONAL PARAMETERS
|
|
|
|
-------------------
|
|
|
|
config
|
|
|
|
Custom NGINX logic, templated within a standard `server` section with
|
|
|
|
`server_name` and TLS parameters set. Defaults to simple static hosting.
|
|
|
|
|
|
|
|
altdomains
|
|
|
|
Alternative domain names for this vhost and related TLS certificate.
|
|
|
|
|
|
|
|
uacme-hookscript
|
|
|
|
Custom hook passed to the __uacme_obtain type: useful to integrate the
|
|
|
|
dns-01 challenge with third-party DNS providers.
|
|
|
|
|
2021-12-14 11:37:18 +00:00
|
|
|
acme-url
|
|
|
|
ACMEv2 server directory object URL. Lets'Encrypt is used by default.
|
|
|
|
|
|
|
|
acme-eab-credentials
|
|
|
|
Specify RFC8555 External Account Binding credentials according to
|
|
|
|
https://tools.ietf.org/html/rfc8555#section-7.3.4, in order to associate a new
|
|
|
|
ACME account with an existing account in a non-ACME system such as a CA
|
|
|
|
customer database. KEYID must be an ASCII string. KEY must be
|
|
|
|
base64url-encoded.
|
|
|
|
|
2021-07-06 14:43:52 +00:00
|
|
|
EXAMPLES
|
|
|
|
--------
|
|
|
|
|
|
|
|
.. code-block:: sh
|
|
|
|
|
|
|
|
# TLS-enabled vhost serving static files in $WEBROOT/domain.tld (OS-specific,
|
|
|
|
# usually `/var/www` on GNU/Linux systemd).
|
|
|
|
__nginx domain.tld
|
|
|
|
|
|
|
|
# TLS-enabled vhost with custom configuration.
|
|
|
|
__nginx files.domain.tld \
|
|
|
|
--config - <<- EOF
|
|
|
|
root /var/www/files.domain.tld/;
|
|
|
|
autoindex on;
|
|
|
|
EOF
|
|
|
|
|
2021-06-22 11:46:32 +00:00
|
|
|
AUTHORS
|
|
|
|
-------
|
|
|
|
Timothée Floure <timothee.floure@posteo.net>
|
2021-06-22 11:50:48 +00:00
|
|
|
Joachim Desroches <joachim.desroches@epfl.ch>
|
2021-06-22 11:46:32 +00:00
|
|
|
|
|
|
|
COPYING
|
|
|
|
-------
|
|
|
|
Copyright \(C) 2020 Joachim Desroches. You can redistribute it
|
|
|
|
and/or modify it under the terms of the GNU General Public License as
|
|
|
|
published by the Free Software Foundation, either version 3 of the
|
|
|
|
License, or (at your option) any later version.
|