dnsimple.toml 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. Name = "DNSimple"
  2. Description = ''''''
  3. URL = "https://dnsimple.com/"
  4. Code = "dnsimple"
  5. Since = "v0.3.0"
  6. Example = '''
  7. DNSIMPLE_OAUTH_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
  8. lego --email you@example.com --dns dnsimple -d '*.example.com' -d example.com run
  9. '''
  10. Additional = '''
  11. ## Description
  12. `DNSIMPLE_BASE_URL` is optional and must be set to production (https://api.dnsimple.com).
  13. if `DNSIMPLE_BASE_URL` is not defined or empty, the production URL is used by default.
  14. While you can manage DNS records in the [DNSimple Sandbox environment](https://developer.dnsimple.com/sandbox/),
  15. DNS records will not resolve, and you will not be able to satisfy the ACME DNS challenge.
  16. To authenticate you need to provide a valid API token.
  17. HTTP Basic Authentication is intentionally not supported.
  18. ### API tokens
  19. You can [generate a new API token](https://support.dnsimple.com/articles/api-access-token/) from your account page.
  20. Only Account API tokens are supported, if you try to use a User API token you will receive an error message.
  21. '''
  22. [Configuration]
  23. [Configuration.Credentials]
  24. DNSIMPLE_OAUTH_TOKEN = "OAuth token"
  25. [Configuration.Additional]
  26. DNSIMPLE_BASE_URL = "API endpoint URL"
  27. DNSIMPLE_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
  28. DNSIMPLE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)"
  29. DNSIMPLE_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)"
  30. [Links]
  31. API = "https://developer.dnsimple.com/v2/"
  32. GoClient = "https://github.com/dnsimple/dnsimple-go"