From 735a1dddca4912bfafeda4e8478adc23942dffac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Tue, 6 Jul 2021 16:43:52 +0200 Subject: [PATCH] __nginx: add minimal usage example --- type/__nginx/man.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/type/__nginx/man.rst b/type/__nginx/man.rst index fa4c5db..71d47e7 100644 --- a/type/__nginx/man.rst +++ b/type/__nginx/man.rst @@ -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