aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiquel Lionel <lionelmiquel@sfr.fr>2020-12-10 11:47:06 +0100
committerlionelmiquel@sfr.fr <lionel@les-miquelots.net>2020-12-10 11:47:06 +0100
commit2c029663c1c7fdfdf365c433af5a297615af4321 (patch)
treee7229b6d64fe327d0de2b21c145d3af4786b7f43
parent2512f660b5796a7a84d281d0304b473c319a9000 (diff)
downloadnfsn_authncleanup_hooks-2c029663c1c7fdfdf365c433af5a297615af4321.tar.gz
nfsn_authncleanup_hooks-2c029663c1c7fdfdf365c433af5a297615af4321.zip
Clarifying README
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 186b3fa..ac57a41 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,11 @@
-# Nearlyfreespeech.net auth and cleanup certbot hooks
+# Nearlyfreespeech.net auth and cleanup certbot hooks for `dns01` challenge
These perl scripts goes in hand with the `--manual-auth-hook` and
`--manual-cleanup-hook` flags of the `certbot` command line utility.
Don't forget to edit the user, api key and account id variable.
+
+# EXAMPLES
+
+```
+certbot --manual --manual-auth-hook /path/to/nfsn_auth.pl --manual-cleanup-hook /path/to/nfsn_cleanup.pl --agree-tos --email yourmail@example.org --preferred-challenges dns certonly -d example.org
+```