edgedns.toml 2.8 KB

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