Back to Lego

Gname

docs/content/dns/zz_gen_gname.md

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

Configuration for Gname.

<!--more-->
  • Code: gname
  • Since: v5.0.0

Here is an example bash command using the Gname provider:

bash
GNAME_APP_ID="xxx" \
GNAME_APP_KEY="yyy" \
lego run --dns gname -d '*.example.com' -d example.com

Credentials

Environment Variable NameDescription
GNAME_APP_IDApp ID
GNAME_APP_KEYApp 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
GNAME_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
GNAME_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
GNAME_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 60)
GNAME_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/gname/gname.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->