home-assistant.io/source/_addons/duckdns.markdown
DubhAd 1db842f371 Need an account (#6336)
A few people have wondered why this doesn't magically work. Adding a note that an account is required, and how to get the API key.
2018-09-22 20:10:24 +02:00

2.3 KiB

layout, title, description, date, sidebar, comments, sharing, footer, featured
layout title description date sidebar comments sharing footer featured
page DuckDNS Automatically update your Duck DNS IP address with integrated HTTPS support via Let's Encrypt. 2017-04-30 13:28 true false true true true

Duck DNS is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. This add-on includes support for Let's Encrypt and will automatically create and renew your certificates. You will need to sign up for a Duck DNS account before using this add-on.

{
  "lets_encrypt": {
    "accept_terms": true,
    "certfile": "fullchain.pem",
    "keyfile": "privkey.pem"
  },
  "token": "sdfj-2131023-dslfjsd-12321",
  "domains": ["my-domain.duckdns.org"],
  "seconds": 300
}

Configuration variables:

  • lets_encrypt.accept_terms (Required): If you accept the Let's Encrypt Subscriber Agreement, it will generate and update Let's Encrypt certificates for your DuckDNS domain.
  • token (Required): Your Duck DNS API key, from your DuckDNS account page.
  • domains (Required): A list of domains to update DNS.
  • seconds (Required): Seconds between updates to Duck DNS.

{% linkable_title Home Assistant configuration %}

Use the following configuration in Home Assistant to use the generated certificate:

http:
  base_url: https://my-domain.duckdns.org:8123
  ssl_certificate: /ssl/fullchain.pem
  ssl_key: /ssl/privkey.pem

If you use a port other than 8123 or an SSL proxy, change the port number accordingly.

{% linkable_title Router configuration %}

You'll need to forward the port you listed in your configuration (8123 in the example above) on your router to your Home Assistant system. You can find guides on how to do this on Port Forward. Noting that you'll only need to forward the TCP port.

Ensure that you allocate the Home Assistant system a fixed IP on your network before you configure port forwarding. You can do this either on the computer itself (see the install guide or via a static lease on your router.

Restart Home Assistant for the configured changes to take effect. When you access the Home Assistant frontend you will now need to use https, even when accessing local instances, for example at https://192.168.0.1:8123.