2019-03-08 18:47:06 +00:00
|
|
|
Name = "DNSimple"
|
|
|
|
|
Description = ''''''
|
|
|
|
|
URL = "https://dnsimple.com/"
|
|
|
|
|
Code = "dnsimple"
|
2019-04-17 19:32:38 +00:00
|
|
|
Since = "v0.3.0"
|
2019-03-08 18:47:06 +00:00
|
|
|
|
2020-05-10 15:22:48 +00:00
|
|
|
Example = '''
|
|
|
|
|
DNSIMPLE_OAUTH_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
|
2020-11-27 19:40:44 +00:00
|
|
|
lego --email myemail@example.com --dns dnsimple --domains my.example.org run
|
2020-05-10 15:22:48 +00:00
|
|
|
'''
|
|
|
|
|
|
|
|
|
|
Additional = '''
|
|
|
|
|
## 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](https://developer.dnsimple.com/sandbox/),
|
|
|
|
|
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](https://support.dnsimple.com/articles/api-access-token/) from your account page.
|
|
|
|
|
Only Account API tokens are supported, if you try to use an User API token you will receive an error message.
|
|
|
|
|
'''
|
2019-03-08 18:47:06 +00:00
|
|
|
|
|
|
|
|
[Configuration]
|
|
|
|
|
[Configuration.Credentials]
|
|
|
|
|
DNSIMPLE_OAUTH_TOKEN = "OAuth token"
|
|
|
|
|
[Configuration.Additional]
|
2020-05-10 15:22:48 +00:00
|
|
|
DNSIMPLE_BASE_URL = "API endpoint URL"
|
2019-03-08 18:47:06 +00:00
|
|
|
DNSIMPLE_POLLING_INTERVAL = "Time between DNS propagation check"
|
|
|
|
|
DNSIMPLE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
|
|
|
|
DNSIMPLE_TTL = "The TTL of the TXT record used for the DNS challenge"
|
|
|
|
|
|
|
|
|
|
[Links]
|
|
|
|
|
API = "https://developer.dnsimple.com/v2/"
|
|
|
|
|
GoClient = "https://github.com/dnsimple/dnsimple-go"
|
