hurricane.toml 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. Name = "Hurricane Electric DNS"
  2. Description = ''''''
  3. URL = "https://dns.he.net/"
  4. Code = "hurricane"
  5. Since = "v4.3.0"
  6. Example = '''
  7. HURRICANE_TOKENS=example.org:token \
  8. lego --email you@example.com --dns hurricane -d '*.example.com' -d example.com run
  9. HURRICANE_TOKENS=my.example.org:token1,demo.example.org:token2 \
  10. lego --email you@example.com --dns hurricane -d my.example.org -d demo.example.org
  11. '''
  12. Additional = """
  13. Before using lego to request a certificate for a given domain or wildcard (such as `my.example.org` or `*.my.example.org`),
  14. create a TXT record named `_acme-challenge.my.example.org`, and enable dynamic updates on it.
  15. Generate a token for each URL with Hurricane Electric's UI, and copy it down.
  16. Stick to alphanumeric tokens for greatest reliability.
  17. To authenticate with the Hurricane Electric API,
  18. add each record name/token pair you want to update to the `HURRICANE_TOKENS` environment variable, as shown in the examples.
  19. Record names (without the `_acme-challenge.` component) and their tokens are separated with colons,
  20. while the credential pairs are concatenated into a comma-separated list, like so:
  21. ```
  22. HURRICANE_TOKENS=my.example.org:token1,demo.example.org:token2
  23. ```
  24. If you are issuing both a wildcard certificate and a standard certificate for a given subdomain,
  25. you should not have repeat entries for that name, as both will use the same credential.
  26. ```
  27. HURRICANE_TOKENS=example.org:token
  28. ```
  29. """
  30. [Configuration]
  31. [Configuration.Credentials]
  32. HURRICANE_TOKENS = "TXT record names and tokens"
  33. [Configuration.Additional]
  34. HURRICANE_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
  35. HURRICANE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation (Default: 300)"
  36. HURRICANE_SEQUENCE_INTERVAL = "Time between sequential requests in seconds (Default: 60)"
  37. HURRICANE_HTTP_TIMEOUT = "API request timeout in seconds (Default: 30)"
  38. [Links]
  39. API = "https://dns.he.net/"