Back to Lego

PowerDNS

docs/content/dns/zz_gen_pdns.md

4.35.22.6 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/pdns/pdns.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Configuration for PowerDNS.

<!--more-->
  • Code: pdns
  • Since: v0.4.0

Here is an example bash command using the PowerDNS provider:

bash
PDNS_API_URL=http://pdns-server:80/ \
PDNS_API_KEY=xxxx \
lego --dns pdns -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
PDNS_API_KEYAPI key
PDNS_API_URLAPI URL

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable NameDescription
PDNS_API_VERSIONSkip API version autodetection and use the provided version number.
PDNS_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
PDNS_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
PDNS_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 120)
PDNS_SERVER_NAMEName of the server in the URL, 'localhost' by default
PDNS_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 120)

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Information

Tested and confirmed to work with PowerDNS authoritative server 3.4.8 and 4.0.1. Refer to PowerDNS documentation instructions on how to enable the built-in API interface.

PowerDNS Notes:

  • PowerDNS API does not currently support SSL, therefore you should take care to ensure that traffic between lego and the PowerDNS API is over a trusted network, VPN etc.
  • In order to have the SOA serial automatically increment each time the _acme-challenge record is added/modified via the API, set SOA-EDIT-API to INCEPTION-INCREMENT for the zone in the domainmetadata table
  • Some PowerDNS servers doesn't have root API endpoints enabled and API version autodetection will not work. In that case version number can be defined using PDNS_API_VERSION.

More information

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/pdns/pdns.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->