From a9ae11e061bda18d2d2bc8ddee2f2f427ea832d6 Mon Sep 17 00:00:00 2001 From: jens Date: Sun, 13 Sep 2020 14:12:56 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 54 +++++++++++++++++++++++------------------------------- 1 file changed, 23 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 5292651..c83c585 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,11 @@ Configuration of transip In `https://www.transip.be/cp/account/api/` you need to have to a keypair -.. _transip: https://www.transip.org/ -.. _certbot: https://certbot.eff.org/ Installation ------------ -:: + pip install certbot-dns-transip @@ -28,31 +26,25 @@ Named Arguments To start using DNS authentication for transip, pass the following arguments on certbot's command line: -============================================================= ============================================== -``--authenticator certbot-dns-transip:dns-transip`` select the authenticator plugin (Required) +`--authenticator certbot-dns-transip:dns-transip`: select the authenticator plugin (Required) -``--dns-transip-credentials`` transip Remote User credentials - INI file. (Required) +`--dns-transip-credentials`: transip Remote User credentials INI file. (Required) -``--dns-transip-propagation-seconds`` | waiting time for DNS to propagate before asking - | the ACME server to verify the DNS record. - | (Default: 10, Recommended: >= 600) -============================================================= ============================================== +`--dns-transip-propagation-seconds`: waiting time for DNS to propagate before asking the ACME server to verify the DNS record. Default: 10, Recommended: >= 600) Credentials ----------- -An example ``credentials.ini`` file: - -.. code-block:: ini - - dns_transip_username = myremoteuser - :dns_transip_api_key_file = path/to/transip_api_key +An example `credentials.ini` file: +```ini +dns_transip_username = myremoteuser +dns_transip_api_key_file = path/to/transip_api_key +``` The path to this file can be provided interactively or using the -``--dns-transip-credentials`` command-line argument. Certbot +`--dns-transip-credentials` command-line argument. Certbot records the path to this file for use during renewal, but does not store the file's contents. @@ -74,21 +66,21 @@ including for renewal, and cannot be silenced except by addressing the issue Examples -------- -To acquire a single certificate for both ``example.com`` and -``*.example.com``, waiting 900 seconds for DNS propagation: +To acquire a single certificate for both `example.com` and +`*.example.com`, waiting 900 seconds for DNS propagation: -.. code-block:: bash - - certbot certonly \ - --authenticator dns-transip \ - --dns-transip-credentials /etc/letsencrypt/.secrets/domain.tld.ini \ - --dns-transip-propagation-seconds 900 \ - --server https://acme-v02.api.letsencrypt.org/directory \ - --agree-tos \ - --rsa-key-size 4096 \ - -d 'example.com' \ - -d '*.example.com' +```bash +certbot certonly \ + --authenticator dns-transip \ + --dns-transip-credentials /etc/letsencrypt/.secrets/domain.tld.ini \ + --dns-transip-propagation-seconds 900 \ + --server https://acme-v02.api.letsencrypt.org/directory \ + --agree-tos \ + --rsa-key-size 4096 \ + -d 'example.com' \ + -d '*.example.com' +``` It is suggested to secure the folder as follows:: chown root:root /etc/letsencrypt/.secrets