Configuration
NAME
ddnsd-config - Configuration file for the DDNSD client
SYNOPSIS
/usr/bin/ddnsd
[ start | stop | restart | status | version | help ]
DESCRIPTION
- The ddnsd.conf file is the configuration file for the DDNSD client. It contains settings that control how the client operates, including the domain or subdomain to update, the update interval, and the API keys for Cloudflare or DuckDNS.
-
Verify the provided is set and valid.
-
Verify the domain: this includes ping the domain and checking the DNS records.
-
Check that the provided API key is valid and active, this
CONFIGURATION FILE
The configuration file is located at /etc/ddnsd.conf.
GLOBAL SETTINGS
IP_LOOKUP
The method to use for looking up the current public IP address. Valid values are icanhazip, ipinfo or ifconfig. These services return the public IP address of the host running the DDNSD client.
- Default: icanhazip
-
Example: IP_LOOKUP=ipinfo
DDNS_PROVIDER
- The DNS provider to use for updates. Valid values are cloudflare or duckdns.
-
Default: cloudflare
-
Example: DDNS_PROVIDER=cloudflare
DOMAIN_NAME
- The domain or subdomain to update. This is the full domain name, including any subdomains.
-
Default:
-
Example: DOMAIN_NAME=example.com
API_KEY
- The API key for the DNS provider. This is required for authentication when updating the DNS records.
-
Default: (empty)
-
Example: API_KEY=your_api_key_here
CLOUDFLARE SETTINGS
CLOUDFLARE_EMAIL
- The email address associated with the Cloudflare account.
-
Default: (empty)
-
Example: [email protected]
CLOUDFLARE_METHOD
- The method to use for updating the DNS records. Valid values are token or global. In most cases, token is preferred as it provides better security and control. Global is used for legacy support.
-
Default: token
-
Example: CLOUDFLARE_METHOD=token
CLOUDFLARE_ZONE_ID
- The zone ID for the domain in Cloudflare. This is required for updating the DNS records.
-
Default: (empty)
-
Example: CLOUDFLARE_ZONE_ID=your_zone_id_here
CLOUDFLARE_PROXY
- The proxy setting for Cloudflare. If set to true, the DNS records will be proxied through Cloudflare’s network, providing additional security with a negligible performance impact. However, this may not be suitable if you are using a VPN service: this applies to if you self-host your own VPN service like WireGuard or OpenVPN.
-
Default: false
-
Example: CLOUDFLARE_PROXY=true
CLOUDFLARE_TTL
The time-to-live (TTL) for the DNS records in Cloudflare. This controls how long the DNS records are cached by resolvers. A lower value means the records will be updated more frequently, while a higher value means they will be cached longer.
- Values: 60, 120, 300, 600, 1800, 3600, 7200, 14400, 28800, 43200, 86400
-
Default: 300 (5 minutes)
-
Example: CLOUDFLARE_TTL=3600 (1 hour)
DUCKDNS SETTINGS
DUCKDNS_INSECURE
- The insecure setting for DuckDNS. If set to true, the client will not verify the SSL certificate when making requests to DuckDNS. This is not recommended for production use, as it can expose you to security risks.
-
Default: false
-
Example: DUCKDNS_INSECURE=true
DUCKDNS_VERBOSE
- The verbose setting for DuckDNS. If set to true, the client will log additional information about the update process, which can be useful for debugging.
-
Default: false
-
Example: DUCKDNS_VERBOSE=true
SEE ALSO
ddnsd(8)
COPYRIGHT
Copyright (c) under the terms of the GPL-3.0 license.