DNSimple - Lego — ContextQMD

Configuration for DNSimple.

Code: dnsimple
Since: v0.3.0

Here is an example bash command using the DNSimple provider:

bash

DNSIMPLE_OAUTH_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
lego --dns dnsimple -d '*.example.com' -d example.com run

Credentials

Environment Variable Name	Description
`DNSIMPLE_OAUTH_TOKEN`	OAuth token

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 Name	Description
`DNSIMPLE_BASE_URL`	API endpoint URL
`DNSIMPLE_POLLING_INTERVAL`	Time between DNS propagation check in seconds (Default: 2)
`DNSIMPLE_PROPAGATION_TIMEOUT`	Maximum waiting time for DNS propagation in seconds (Default: 60)
`DNSIMPLE_TTL`	The 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" %}}).

Description

DNSIMPLE_BASE_URL is optional and must be set to production (https://api.dnsimple.com). if DNSIMPLE_BASE_URL is not defined or empty, the production URL is used by default.

While you can manage DNS records in the DNSimple Sandbox environment, DNS records will not resolve, and you will not be able to satisfy the ACME DNS challenge.

To authenticate you need to provide a valid API token. HTTP Basic Authentication is intentionally not supported.

API tokens

You can generate a new API token from your account page. Only Account API tokens are supported, if you try to use a User API token you will receive an error message.

More information