sonic.toml 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. Name = "Sonic"
  2. Description = ''''''
  3. URL = "https://www.sonic.com/"
  4. Code = "sonic"
  5. Since = "v4.4.0"
  6. Example = '''
  7. SONIC_USER_ID=12345 \
  8. SONIC_API_KEY=4d6fbf2f9ab0fa11697470918d37625851fc0c51 \
  9. lego --email you@example.com --dns sonic -d '*.example.com' -d example.com run
  10. '''
  11. Additional = '''
  12. ## API keys
  13. The API keys must be generated by calling the `dyndns/api_key` endpoint.
  14. Example:
  15. ```bash
  16. $ curl -X POST -H "Content-Type: application/json" --data '{"username":"notarealuser","password":"notarealpassword","hostname":"example.com"}' https://public-api.sonic.net/dyndns/api_key
  17. {"userid":"12345","apikey":"4d6fbf2f9ab0fa11697470918d37625851fc0c51","result":200,"message":"OK"}
  18. ```
  19. See https://public-api.sonic.net/dyndns/#requesting_an_api_key for additional details.
  20. This `userid` and `apikey` combo allow modifications to any DNS entries connected to the managed domain (hostname).
  21. Hostname should be the toplevel domain managed e.g. `example.com` not `www.example.com`.
  22. '''
  23. [Configuration]
  24. [Configuration.Credentials]
  25. SONIC_USER_ID = "User ID"
  26. SONIC_API_KEY = "API Key"
  27. [Configuration.Additional]
  28. SONIC_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
  29. SONIC_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)"
  30. SONIC_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)"
  31. SONIC_SEQUENCE_INTERVAL = "Time between sequential requests in seconds (Default: 60)"
  32. SONIC_HTTP_TIMEOUT = "API request timeout in seconds (Default: 10)"
  33. [Links]
  34. API = "https://public-api.sonic.net/dyndns/"