potyarkin/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity
lego/docs/content/dns/zz_gen_vinyldns.md
Ludovic Fernandez 5ab212cf8d
docs: update theme (#2240)
2024-08-14 23:55:11 +02:00

2.1 KiB
Raw Blame History

title date draft slug dnsprovider
VinylDNS 2019-03-03T16:39:46+01:00 false vinyldns
since code url
v4.4.0 vinyldns https://www.vinyldns.io

Configuration for VinylDNS.

  • Code: vinyldns
  • Since: v4.4.0

Here is an example bash command using the VinylDNS provider:

VINYLDNS_ACCESS_KEY=xxxxxx \
VINYLDNS_SECRET_KEY=yyyyy \
VINYLDNS_HOST=https://api.vinyldns.example.org:9443 \
lego --email you@example.com --dns vinyldns --domains my.example.org run

Credentials

Environment Variable Name Description
VINYLDNS_ACCESS_KEY The VinylDNS API key
VINYLDNS_HOST The VinylDNS API URL
VINYLDNS_SECRET_KEY The VinylDNS API Secret key

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
VINYLDNS_POLLING_INTERVAL Time between DNS propagation check
VINYLDNS_PROPAGATION_TIMEOUT Maximum waiting time for DNS propagation
VINYLDNS_TTL The TTL of the TXT record used for the DNS challenge

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" %}}).

The vinyldns integration makes use of dotted hostnames to ease permission management. Users are required to have DELETE ACL level or zone admin permissions on the VinylDNS zone containing the target host.

More information