Back to Lego

VinylDNS

docs/content/dns/zz_gen_vinyldns.md

4.35.22.2 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/vinyldns/vinyldns.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Configuration for VinylDNS.

<!--more-->
  • Code: vinyldns
  • Since: v4.4.0

Here is an example bash command using the VinylDNS provider:

bash
VINYLDNS_ACCESS_KEY=xxxxxx \
VINYLDNS_SECRET_KEY=yyyyy \
VINYLDNS_HOST=https://api.vinyldns.example.org:9443 \
lego --dns vinyldns -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
VINYLDNS_ACCESS_KEYThe VinylDNS API key
VINYLDNS_HOSTThe VinylDNS API URL
VINYLDNS_SECRET_KEYThe 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 NameDescription
VINYLDNS_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
VINYLDNS_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 4)
VINYLDNS_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 120)
VINYLDNS_QUOTE_VALUEAdds quotes around the TXT record value (Default: false)
VINYLDNS_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 30)

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

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/vinyldns/vinyldns.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->