dnsimple.toml raw

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