Welcome to certbot-dns-nsone’s documentation!¶
dns_nsone plugin automates the process of completing
dns-01 challenge (
DNS01) by creating, and subsequently
removing, TXT records using the NS1 API.
The plugin is not installed by default. It can be installed by heading to certbot.eff.org, choosing your system and selecting the Wildcard tab.
NS1 credentials INI file. (Required)
The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 30)
Use of this plugin requires a configuration file containing NS1 API credentials, obtained from your NS1 account page.
# NS1 API credentials used by Certbot dns_nsone_api_key = MDAwMDAwMDAwMDAwMDAw
The path to this file can be provided interactively or using the
--dns-nsone-credentials command-line argument. Certbot records the path
to this file for use during renewal, but does not store the file’s contents.
You should protect these API credentials as you would the password to your
NS1 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).
certbot certonly \ --dns-nsone \ --dns-nsone-credentials ~/.secrets/certbot/nsone.ini \ -d example.com
certbot certonly \ --dns-nsone \ --dns-nsone-credentials ~/.secrets/certbot/nsone.ini \ -d example.com \ -d www.example.com
certbot certonly \ --dns-nsone \ --dns-nsone-credentials ~/.secrets/certbot/nsone.ini \ --dns-nsone-propagation-seconds 60 \ -d example.com