potyarkin/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity
lego/docs/content/dns/zz_gen_nicmanager.md
Dominik Menke 85f616f85b
docs: refactoring and cleanup (#1658)
2022-06-17 00:25:42 +02:00

2.8 KiB
Raw Blame History

title date draft slug dnsprovider
Nicmanager 2019-03-03T16:39:46+01:00 false nicmanager
since code url
v4.5.0 nicmanager https://www.nicmanager.com/

Configuration for Nicmanager.

  • Code: nicmanager
  • Since: v4.5.0

Here is an example bash command using the Nicmanager provider:

## Login using email

NICMANAGER_API_EMAIL = "you@example.com" \
NICMANAGER_API_PASSWORD = "password" \

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

lego --email you@example.com --dns nicmanager --domains my.example.org 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 --email you@example.com --dns nicmanager --domains my.example.org run

Credentials

Environment Variable Name Description
NICMANAGER_API_EMAIL Email-based login
NICMANAGER_API_LOGIN Login, used for Username-based login
NICMANAGER_API_PASSWORD Password, always required
NICMANAGER_API_USERNAME Username, 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 Name Description
NICMANAGER_API_MODE mode: 'anycast' or 'zone' (default: 'anycast')
NICMANAGER_API_OTP TOTP Secret (optional)
NICMANAGER_HTTP_TIMEOUT API request timeout
NICMANAGER_POLLING_INTERVAL Time between DNS propagation check
NICMANAGER_PROPAGATION_TIMEOUT Maximum waiting time for DNS propagation
NICMANAGER_TTL The TTL of the TXT record used for the DNS challenge

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 login using your account name + username or using your email address. Optionally if TOTP is configured for your account, set NICMANAGER_API_OTP.

More information