Skip to main content

certbot-dns-dnscale

DNScale DNS Authenticator plugin for certbot.

Automates Let's Encrypt DNS-01 challenges by creating and cleaning up TXT records via the DNScale API.

Installation

pip install certbot-dns-dnscale

Or install from source:

pip install git+https://github.com/dnscaleou/certbot-dns-dnscale.git

Credentials

Create an API key at dnscale.eu with the following scopes:

  • zones:read
  • records:read
  • records:write

Save it to a credentials file:

# /etc/letsencrypt/dnscale.ini
dns_dnscale_api_token = your-api-token-here

Restrict permissions:

chmod 600 /etc/letsencrypt/dnscale.ini

Usage

Obtain a certificate

certbot certonly \
  --authenticator dns-dnscale \
  --dns-dnscale-credentials /etc/letsencrypt/dnscale.ini \
  -d example.com \
  -d "*.example.com"

Renew certificates

certbot renew

Certbot remembers the authenticator used for each certificate and will automatically use the DNScale plugin for renewal.

Propagation delay

By default, the plugin waits 60 seconds for DNS propagation. Adjust if needed:

certbot certonly \
  --authenticator dns-dnscale \
  --dns-dnscale-credentials /etc/letsencrypt/dnscale.ini \
  --dns-dnscale-propagation-seconds 120 \
  -d example.com

Docker

docker run --rm \
  -v /etc/letsencrypt:/etc/letsencrypt \
  certbot/certbot \
  pip install certbot-dns-dnscale && \
  certbot certonly \
    --authenticator dns-dnscale \
    --dns-dnscale-credentials /etc/letsencrypt/dnscale.ini \
    -d example.com

Configuration

Option Description Default
--dns-dnscale-credentials Path to credentials INI file Required
--dns-dnscale-propagation-seconds Seconds to wait for DNS propagation 60

Credentials file options

Key Description Required
dns_dnscale_api_token DNScale API token Yes
dns_dnscale_api_url API base URL No (default: https://api.dnscale.eu)

License

Apache License 2.0. See LICENSE.

Metadata

Release files for certbot-dns-dnscale 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for certbot-dns-dnscale 1.0.2
File Size Uploaded
certbot_dns_dnscale-1.0.2.tar.gz 9.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for certbot-dns-dnscale 1.0.2
File Interpreter ABI Platform
certbot_dns_dnscale-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 18.4 kB

Release files / certbot_dns_dnscale-1.0.2.tar.gz

Download URL certbot_dns_dnscale-1.0.2.tar.gz
Size 9.7 kB
Tags Source
SHA-256 checksum
How to use checksums
928a36d394e99cf8bb1ce2bf5cce9ba449d6c10a5947f86b752f4c5490deb475
BLAKE2b-256 checksum
How to use checksums
c859f9625262be8d01e185e16045ce4a67f9aba2a8a3e2c00cb10b068a6645a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.6

Release files / certbot_dns_dnscale-1.0.2-py3-none-any.whl

Download URL certbot_dns_dnscale-1.0.2-py3-none-any.whl
Size 8.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
474fa83cd635bdd99fd39d2cd51f7d471252af0ae3d1e5cd4998016a54d0cb3e
BLAKE2b-256 checksum
How to use checksums
2a364b5a1eb9167b74424f024e40538d71f397a85c9ccc415ebde3dbec3cd82d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.6

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page