The login/account of the NearlyFreeSpeech.NET user. This is used to authenticate API requests.

• Command line option: --api-login
• Configuration key: api-login (str)
• Environment variable: NFSN_DDNS_API_LOGIN

The token to use when authenticating API requests. Members can acquire an API token by viewing their profiles and selecting Manage API Key. In this page, users can request to generate an API token.

• Command line option: --api-token
• Configuration key: api-token (str)
• Environment variable: NFSN_DDNS_API_TOKEN

The DNS resource to update, which includes the DNS record which to update with a dynamically detected IP address, along with its domain. For example:

ddns.example.com

Multiple domains can be provided, for users who want a DDNS record across multiple domains (although the use of CNAME's are recommended when attempting to updated multiple records for a single domain).

• Command line option: --ddns-domain
• Configuration key: domains (str-list)
• Environment variable: NFSN_DDNS_DOMAINS (;-separated)

Configure whether a detected public IP will be cached into a local file. his feature can be used to avoid NFSN API calls if it is believed the public IP of a host is believed to have not changed. After a successful verification of a configured DNS record, the detected public IP can be stored in a cache file for future considerations. Next time this utility runs and detects a public IP address, if the address matches that of the cached file, no API requests to NFSN will be made. The cache will be considered a valid source of information for configured number of days (see "Cache Days").

By default, this setting is not enabled (except in container environments).

• Command line option: --cache
• Configuration key: cache (bool)
• Environment variable: NFSN_DDNS_CACHE

When using the cache capability, this value configures the total number of days before the cache is considered to be stale. A stale cache will cause this utility to perform an API request with NFSN to verify the DNS record matches.

By default, a cache is considered valid for seven (7) days.

• Command line option: --cache-days
• Configuration key: cache-days (int)
• Environment variable: NFSN_DDNS_CACHE_DAYS

When using the cache capability, the specific file where cached content is stored if set by this option.

By default, the cache file location used will be the first available path that is writable by this utility:

/run/nfsn-ddns/cached-ip
 (or)
/run/user/(UID)/cached-ip
 (or)
nfsn-ddns-cached-ip

• Command line option: --cache-file
• Configuration key: cache-file
• Environment variable: NFSN_DDNS_CACHE_FILE

IP API endpoints are web services used to help determine the public IP address of the instance running this utility. The detected IP will be used to update the configured DNS record.

The endpoint used is chosen at random each run. If a given endpoint cannot be accessed, other endpoints are used until an IP address is provided or all endpoints have been exhausted.

The default endpoints used are as follows:

• https://api.ipify.org
• https://checkip.amazonaws.com/
• https://ifconfig.me/ip
• https://ipinfo.io/ip
• https://trackip.net/ip

Users can override what endpoints to use by configuring this option.

• Configuration key: myip-api-endpoints (str-list)
• Environment variable: NFSN_DDNS_MYIP_API_ENDPOINTS (;-separated)

Configures the timeout (in seconds) until any requests to external sources (i.e. NFSN API or IP providers) are considered timed out. The default timeout for all requests is configured to ten (10) seconds.

• Command line option: --timeout
• Configuration key: timeout
• Environment variable: NFSN_DDNS_TIMEOUT

The API endpoint for NearlyFreeSpeech.NET. In almost all cases, this option never needs to be changed. However, the option is provided if a use case requires a different endpoint to be used.

This value is configured to https://api.nearlyfreespeech.net/dns by default.

• Configuration key: nfsn-api-endpoint (str)
• Environment variable: NFSN_DDNS_NFSN_API_ENDPOINT