Back to Lego

NS1

docs/content/dns/zz_gen_ns1.md

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

Configuration for NS1.

<!--more-->
  • Code: ns1
  • Since: v0.4.0

Here is an example bash command using the NS1 provider:

bash
NS1_API_KEY=xxxx \
lego --dns ns1 -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
NS1_API_KEYAPI 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
NS1_HTTP_TIMEOUTAPI request timeout in seconds (Default: 10)
NS1_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
NS1_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 60)
NS1_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/ns1/ns1.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->