Welcome to certbot-dns-sakuracloud’s documentation!

The dns_sakuracloud plugin automates the process of completing a dns-01 challenge (DNS01) by creating, and subsequently removing, TXT records using the Sakura Cloud DNS API.

Note

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.

Named Arguments

--dns-sakuracloud-credentials

Sakura Cloud credentials INI file. (Required)

--dns-sakuracloud-propagation-seconds

The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 90)

Credentials

Use of this plugin requires a configuration file containing Sakura Cloud DNS API credentials, obtained from your Sakura Cloud DNS apikey page.

Example credentials file:
# Sakura Cloud API credentials used by Certbot
dns_sakuracloud_api_token  = 00000000-0000-0000-0000-000000000000
dns_sakuracloud_api_secret = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw

The path to this file can be provided interactively or using the --dns-sakuracloud-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 these API credentials as you would the password to your Sakura Cloud 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

To acquire a certificate for example.com
certbot certonly \
  --dns-sakuracloud \
  --dns-sakuracloud-credentials ~/.secrets/certbot/sakuracloud.ini \
  -d example.com
To acquire a single certificate for both example.com and www.example.com
certbot certonly \
  --dns-sakuracloud \
  --dns-sakuracloud-credentials ~/.secrets/certbot/sakuracloud.ini \
  -d example.com \
  -d www.example.com
To acquire a certificate for example.com, waiting 60 seconds for DNS propagation
certbot certonly \
  --dns-sakuracloud \
  --dns-sakuracloud-credentials ~/.secrets/certbot/sakuracloud.ini \
  --dns-sakuracloud-propagation-seconds 60 \
  -d example.com

Indices and tables