Back to Lego

Nicmanager

docs/content/dns/zz_gen_nicmanager.md

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

Configuration for Nicmanager.

<!--more-->
  • Code: nicmanager
  • Since: v4.5.0

Here is an example bash command using the Nicmanager provider:

bash
## Login using email

NICMANAGER_API_EMAIL = "[email protected]" \
NICMANAGER_API_PASSWORD = "password" \

# Optionally, if your account has TOTP enabled, set the secret here
NICMANAGER_API_OTP = "long-secret" \

lego --dns nicmanager -d '*.example.com' -d example.com run

## Login using account name + username

NICMANAGER_API_LOGIN = "myaccount" \
NICMANAGER_API_USERNAME = "myuser" \
NICMANAGER_API_PASSWORD = "password" \

# Optionally, if your account has TOTP enabled, set the secret here
NICMANAGER_API_OTP = "long-secret" \

lego --dns nicmanager -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
NICMANAGER_API_EMAILEmail-based login
NICMANAGER_API_LOGINLogin, used for Username-based login
NICMANAGER_API_PASSWORDPassword, always required
NICMANAGER_API_USERNAMEUsername, used for Username-based login

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
NICMANAGER_API_MODEmode: 'anycast' or 'zones' (for FreeDNS) (default: 'anycast')
NICMANAGER_API_OTPTOTP Secret (optional)
NICMANAGER_HTTP_TIMEOUTAPI request timeout in seconds (Default: 10)
NICMANAGER_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
NICMANAGER_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 300)
NICMANAGER_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 900)

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

Description

You can log in using your account name + username or using your email address. Optionally, if TOTP is configured for your account, set NICMANAGER_API_OTP.

More information

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