Back to Lego

Virtualname

docs/content/dns/zz_gen_virtualname.md

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

Configuration for Virtualname.

<!--more-->
  • Code: virtualname
  • Since: v4.30.0

Here is an example bash command using the Virtualname provider:

bash
VIRTUALNAME_TOKEN=xxxxxx \
lego --dns virtualname -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
VIRTUALNAME_TOKENAPI token

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
VIRTUALNAME_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
VIRTUALNAME_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 10)
VIRTUALNAME_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 300)
VIRTUALNAME_TTLThe 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" %}}).

More information

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