1
0
mirror of https://github.com/go-acme/lego.git synced 2025-10-10 03:02:09 +02:00
Files
lego/docs/content/dns/zz_gen_edgedns.md
Hideki Okamoto 5b06dd7874 edgedns: add account switch key option (#2460)
Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>
2025-03-03 02:57:26 +01:00

4.1 KiB
Generated

title, date, draft, slug, dnsprovider
title date draft slug dnsprovider
Akamai EdgeDNS 2019-03-03T16:39:46+01:00 false edgedns
since code url
v3.9.0 edgedns https://www.akamai.com/us/en/products/security/edge-dns.jsp

Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS

  • Code: edgedns
  • Since: v3.9.0

Here is an example bash command using the Akamai EdgeDNS provider:

AKAMAI_CLIENT_SECRET=abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG= \
AKAMAI_CLIENT_TOKEN=akab-mnbvcxzlkjhgfdsapoiuytrewq1234567 \
AKAMAI_HOST=akab-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.luna.akamaiapis.net \
AKAMAI_ACCESS_TOKEN=akab-1234567890qwerty-asdfghjklzxcvtnu \
lego --email you@example.com --dns edgedns -d '*.example.com' -d example.com run

Credentials

Environment Variable Name Description
AKAMAI_ACCESS_TOKEN Access token, managed by the Akamai EdgeGrid client
AKAMAI_CLIENT_SECRET Client secret, managed by the Akamai EdgeGrid client
AKAMAI_CLIENT_TOKEN Client token, managed by the Akamai EdgeGrid client
AKAMAI_EDGERC Path to the .edgerc file, managed by the Akamai EdgeGrid client
AKAMAI_EDGERC_SECTION Configuration section, managed by the Akamai EdgeGrid client
AKAMAI_HOST API host, managed by the Akamai EdgeGrid client

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable Name Description
AKAMAI_ACCOUNT_SWITCH_KEY Target account ID when the DNS zone and credentials belong to different accounts
AKAMAI_POLLING_INTERVAL Time between DNS propagation check in seconds (Default: 15)
AKAMAI_PROPAGATION_TIMEOUT Maximum waiting time for DNS propagation in seconds (Default: 180)
AKAMAI_TTL The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Akamai's credentials are automatically detected in the following locations and prioritized in the following order:

  1. Section-specific environment variables (where {SECTION} is specified using AKAMAI_EDGERC_SECTION):
  • AKAMAI_{SECTION}_HOST
  • AKAMAI_{SECTION}_ACCESS_TOKEN
  • AKAMAI_{SECTION}_CLIENT_TOKEN
  • AKAMAI_{SECTION}_CLIENT_SECRET
  1. If AKAMAI_EDGERC_SECTION is not defined or is set to default, environment variables:
  • AKAMAI_HOST
  • AKAMAI_ACCESS_TOKEN
  • AKAMAI_CLIENT_TOKEN
  • AKAMAI_CLIENT_SECRET
  1. .edgerc file located at AKAMAI_EDGERC
  • defaults to ~/.edgerc, sections can be specified using AKAMAI_EDGERC_SECTION
  1. Default environment variables:
  • AKAMAI_HOST
  • AKAMAI_ACCESS_TOKEN
  • AKAMAI_CLIENT_TOKEN
  • AKAMAI_CLIENT_SECRET

See also:

More information