__nginx: add minimal usage example

This commit is contained in:
fnux 2021-07-06 16:43:52 +02:00
parent 653c85e948
commit 735a1dddca
No known key found for this signature in database
GPG Key ID: 4502C902C00A1E12
1 changed files with 16 additions and 0 deletions

View File

@ -28,6 +28,22 @@ uacme-hookscript
Custom hook passed to the __uacme_obtain type: useful to integrate the
dns-01 challenge with third-party DNS providers.
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
AUTHORS
-------
Timothée Floure <timothee.floure@posteo.net>