Home Assistant

Duck DNS

The DuckDNS integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to keep your DuckDNS subdomain always in sync with your public IP address. DuckDNS is a free service that allows you to bind your own favorite subdomain under duckdns.org to the public IP address in use from your router, even though such address is dynamically allocated by your internet service provider and therefore changes over time.

If you are running the Home Assistant DuckDNS add-on this integration is not required. The add-on will keep your IP updated with DuckDNS.

Configuration

To use the integration in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.[Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.[Learn more] file, restart Home Assistant to apply the changes.

# Example configuration.yaml entry
duckdns:
  domain: YOUR_SUBDOMAIN
  access_token: YOUR_ACCESS_TOKEN

Configuration Variables

Looking for your configuration file?
domain string Required

Your duckdns subdomain (without the .duckdns.org suffix).

access_token string Required

Your DuckDNS access token. Log in to the site to get one.

Service set_txt

Set the TXT record of your DuckDNS subdomain.

Service data attribute Optional Description
txt no Payload for the TXT record.

Related topics