Nicmanager

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 run --dns nicmanager -d '*.example.com' -d example.com

## 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 run --dns nicmanager -d '*.example.com' -d example.com

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.

Additional Configuration

Environment Variable Name Description
NICMANAGER_API_MODE mode: ‘anycast’ or ‘zones’ (for FreeDNS) (default: ‘anycast’)
NICMANAGER_API_OTP TOTP Secret (optional)
NICMANAGER_HTTP_TIMEOUT API request timeout in seconds (Default: 10)
NICMANAGER_POLLING_INTERVAL Time between DNS propagation check in seconds (Default: 2)
NICMANAGER_PROPAGATION_TIMEOUT Maximum waiting time for DNS propagation in seconds (Default: 300)
NICMANAGER_TTL The 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.

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