Welcome to certbot-dns-alwaysdata’s documentation!¶
The dns_alwaysdata
plugin automates the process of
completing a dns-01
challenge (DNS01
) by creating, and
subsequently removing, TXT records using the Alwaysdata API.
Named Arguments¶
--dns-alwaysdata-credentials |
Alwaysdata credentials INI file. (Required) |
Credentials¶
Use of this plugin requires a configuration file containing Alwaysdata API key, obtained from your Alwaysdata profile page, and Alwaysdata account name, obtained from your Alwaysdata account page. You must use the account owning the domain for which you are requesting the certificates.
# Alwaysdata API credentials used by Certbot
dns_alwaysdata_api_key = 1234567890abcdef
dns_alwaysdata_account = example
The path to this file can be provided interactively or using the
--dns-alwaysdata-credentials
command-line argument. Certbot records the path
to this file for use during renewal, but does not store the file’s contents.
Caution
You should protect the API key as you would the password to your Alwaysdata
account. Users who can read this file can use these credentials to issue
arbitrary API calls on your behalf. Users who can cause Certbot to run using
these credentials can complete a dns-01
challenge to acquire new
certificates or revoke existing certificates for associated domains, even if
those domains aren’t being managed by this server.
Certbot will emit a warning if it detects that the credentials file can be
accessed by other users on your system. The warning reads “Unsafe permissions
on credentials configuration file”, followed by the path to the credentials
file. This warning will be emitted each time Certbot uses the credentials file,
including for renewal, and cannot be silenced except by addressing the issue
(e.g., by using a command like chmod 600
to restrict access to the file).
Examples¶
example.com
¶certbot certonly \
--dns-alwaysdata \
--dns-alwaysdata-credentials ~/.secrets/certbot/alwaysdata.ini \
-d example.com
example.com
and
www.example.com
¶certbot certonly \
--dns-alwaysdata \
--dns-alwaysdata-credentials ~/.secrets/certbot/alwaysdata.ini \
-d example.com \
-d www.example.com
example.com
, waiting 60 seconds
for DNS propagation¶certbot certonly \
--dns-alwaysdata \
--dns-alwaysdata-credentials ~/.secrets/certbot/alwaysdata.ini \
--dns-alwaysdata-propagation-seconds 60 \
-d example.com