mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 23:36:50 +00:00
2c61569273
The guide forgets to call out that the IP for the system must be fixed, which has tripped up more than a few
52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
---
|
|
layout: page
|
|
title: "DuckDNS"
|
|
description: "Automatically update your Duck DNS IP address with integrated HTTPS support via Let's Encrypt."
|
|
date: 2017-04-30 13:28
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
featured: true
|
|
---
|
|
|
|
[Duck DNS](https://duckdns.org/) 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.
|
|
|
|
```json
|
|
{
|
|
"lets_encrypt": {
|
|
"accept_terms": true
|
|
},
|
|
"token": "sdfj-2131023-dslfjsd-12321",
|
|
"domains": ["my-domain.duckdns.org"]
|
|
}
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **token** (*Required*): Your Duck DNS API key.
|
|
- **domains** (*Required*): A list of domains to update DNS.
|
|
- **seconds** (*Optional*): Seconds between updates to Duck DNS.
|
|
- **lets_encrypt.accept_terms** (*Optional*): If you accept the [Let's Encrypt Subscriber Agreement][le], it will generate & update Let's Enrypt certificates for your DuckDNS domain.
|
|
|
|
[le]: https://letsencrypt.org/repository/
|
|
|
|
## {% linkable_title Home Assistant configuration %}
|
|
|
|
Use the following configuration in Home Assistant to use the generated certificate:
|
|
|
|
```yaml
|
|
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](https://portforward.com/) - 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](/hassio/installation/) or via a static lease on your router.
|