aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiquel Lionel <lionelmiquel@sfr.fr>2020-12-14 10:24:42 +0100
committerlionelmiquel@sfr.fr <lionel@les-miquelots.net>2020-12-14 10:24:42 +0100
commit328fe6daa4f5fabd7020948c305c39c70616bd0c (patch)
tree27f398373e6fbf8c1d50fcd8f8c52f2f23e421a2
parent78b0569b2fbc7702fc9901d0888d7f3e3c8d58ef (diff)
downloadnfsn_authncleanup_hooks-328fe6daa4f5fabd7020948c305c39c70616bd0c.tar.gz
nfsn_authncleanup_hooks-328fe6daa4f5fabd7020948c305c39c70616bd0c.zip
Explain the variables.
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index ac57a41..0823af6 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,13 @@ 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.
+`$USER`: The username for your [nearlyfreespeech.net](https://nearlyfreespeech.net/) account.
+`$API_KEY`: The API key needed to make requests on their backend. You can request it through [here](https://members.nearlyfreespeech.net/lilim/support/request).
+`$ACCOUNT_ID`: The account id tied to the registered domain name
+(a string like A1B2-C3D4E5F6). You'll find it
+[there](https://members.nearlyfreespeech.net/lilim/domains), column
+'Account'.
+
# EXAMPLES
```