edgedns.toml 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. Name = "Akamai EdgeDNS"
  2. Description = '''
  3. Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS
  4. '''
  5. URL = "https://www.akamai.com/us/en/products/security/edge-dns.jsp"
  6. Code = "edgedns"
  7. Aliases = ["fastdns"] # "fastdns" is for compatibility with v3, must be dropped in v5
  8. Since = "v3.9.0"
  9. Example = '''
  10. AKAMAI_CLIENT_SECRET=abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG= \
  11. AKAMAI_CLIENT_TOKEN=akab-mnbvcxzlkjhgfdsapoiuytrewq1234567 \
  12. AKAMAI_HOST=akab-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.luna.akamaiapis.net \
  13. AKAMAI_ACCESS_TOKEN=akab-1234567890qwerty-asdfghjklzxcvtnu \
  14. lego --email you@example.com --dns edgedns -d '*.example.com' -d example.com run
  15. '''
  16. Additional = '''
  17. Akamai's credentials are automatically detected in the following locations and prioritized in the following order:
  18. 1. Section-specific environment variables (where `{SECTION}` is specified using `AKAMAI_EDGERC_SECTION`):
  19. - `AKAMAI_{SECTION}_HOST`
  20. - `AKAMAI_{SECTION}_ACCESS_TOKEN`
  21. - `AKAMAI_{SECTION}_CLIENT_TOKEN`
  22. - `AKAMAI_{SECTION}_CLIENT_SECRET`
  23. 2. If `AKAMAI_EDGERC_SECTION` is not defined or is set to `default`, environment variables:
  24. - `AKAMAI_HOST`
  25. - `AKAMAI_ACCESS_TOKEN`
  26. - `AKAMAI_CLIENT_TOKEN`
  27. - `AKAMAI_CLIENT_SECRET`
  28. 3. `.edgerc` file located at `AKAMAI_EDGERC`
  29. - defaults to `~/.edgerc`, sections can be specified using `AKAMAI_EDGERC_SECTION`
  30. 4. Default environment variables:
  31. - `AKAMAI_HOST`
  32. - `AKAMAI_ACCESS_TOKEN`
  33. - `AKAMAI_CLIENT_TOKEN`
  34. - `AKAMAI_CLIENT_SECRET`
  35. See also:
  36. - [Setting up Akamai credentials](https://developer.akamai.com/api/getting-started)
  37. - [.edgerc Format](https://developer.akamai.com/legacy/introduction/Conf_Client.html#edgercformat)
  38. - [API Client Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html)
  39. - [Config from Env](https://github.com/akamai/AkamaiOPEN-edgegrid-golang/blob/master/pkg/edgegrid/config.go#L118)
  40. '''
  41. [Configuration]
  42. [Configuration.Credentials]
  43. AKAMAI_HOST = "API host, managed by the Akamai EdgeGrid client"
  44. AKAMAI_CLIENT_TOKEN = "Client token, managed by the Akamai EdgeGrid client"
  45. AKAMAI_CLIENT_SECRET = "Client secret, managed by the Akamai EdgeGrid client"
  46. AKAMAI_ACCESS_TOKEN = "Access token, managed by the Akamai EdgeGrid client"
  47. AKAMAI_EDGERC = "Path to the .edgerc file, managed by the Akamai EdgeGrid client"
  48. AKAMAI_EDGERC_SECTION = "Configuration section, managed by the Akamai EdgeGrid client"
  49. [Configuration.Additional]
  50. AKAMAI_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 15)"
  51. AKAMAI_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 180)"
  52. AKAMAI_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)"
  53. [Links]
  54. API = "https://developer.akamai.com/api/cloud_security/edge_dns_zone_management/v2.html"
  55. GoClient = "https://github.com/akamai/AkamaiOPEN-edgegrid-golang"