cmc/cleberg.net
My personal web garden & blog.
clone: git clone https://gitbay.org/cmc/cleberg.net.git
36b5ec4ece3149394998af4690d3316ba7d75ec3
unsigned
author: Christian Cleberg <hello@cleberg.net> · 2024-03-15T15:04:44Z
.../blog/2024-03-15-self-hosting-ddns-updater.md | 61 +++++++++++++++------- 1 file changed, 43 insertions(+), 18 deletions(-) @@ -4,19 +4,25 @@ title = "Self-Hosting DDNS Updater" description = "A guide to self-hosting the DDNS Updater container." +++ - + -[DDNS Updater](https://github.com/qdm12/ddns-updater) is a program to keep DNS A and/or AAAA records updated for multiple DNS providers. +[DDNS Updater](https://github.com/qdm12/ddns-updater) is a program to keep DNS A +and/or AAAA records updated for multiple DNS providers. -If you've read any of my other posts, you'll notice that I have been searching for and using a few different DDNS updating solutions for years. You'll also notice that I love any projects that offer a Docker Compose solution. +If you've read any of my other posts, you'll notice that I have been searching +for and using a few different DDNS updating solutions for years. You'll also +notice that I love any projects that offer a Docker Compose solution. Luckily, DDNS Upater fits both of these preferences. ## Installation -To get started, always make sure to review the project's [README](https://github.com/qdm12/ddns-updater/blob/master/README.md). I'll be documenting my steps below, but they may have changed by the time you read this. +To get started, always make sure to review the project's +[README](https://github.com/qdm12/ddns-updater/blob/master/README.md). I'll be +documenting my steps below, but they may have changed by the time you read this. -The first step is to set up the directories and files required for the project. +The first step is to set up the directories and files required for the project. ```sh mkdir ~/ddns-updater @@ -26,7 +32,9 @@ touch ~/ddns-updater/data/config.json ### Configuration -The main configuration you need to update is the `data/config.json` file. There is a large list of supported providers in the README, but I'm going to use Cloudflare in this example. +The main configuration you need to update is the `data/config.json` file. There +is a large list of supported providers in the README, but I'm going to use +Cloudflare in this example. ```sh nano ~/ddns-updater/data/config.json @@ -35,17 +43,27 @@ nano ~/ddns-updater/data/config.json When setting up the configuration for Cloudflare, you'll need the following: - Required Parameters - - `"zone_identifier"` is the Zone ID of your site from the domain overview page - - `"host"` is your host and can be `"@"`, a subdomain or the wildcard `"*"`. See [this issue comment for context](https://github.com/qdm12/ddns-updater/issues/243#issuecomment-928313949). + - `"zone_identifier"` is the Zone ID of your site from the domain overview + page + - `"host"` is your host and can be `"@"`, a subdomain or the wildcard `"*"`. + See [this issue comment for + context](https://github.com/qdm12/ddns-updater/issues/243#issuecomment-928313949). - `"ttl"` integer value for record TTL in seconds (specify 1 for automatic) - - One of the following ([how to find API keys](https://developers.cloudflare.com/fundamentals/api/get-started/)): + - One of the following ([how to find API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/)): - Email `"email"` and Global API Key `"key"` - User service key `"user_service_key"` - - API Token `"token"`, configured with DNS edit permissions for your DNS name's zone + - API Token `"token"`, configured with DNS edit permissions for your DNS + name's zone - Optional Parameters - `"proxied"` can be set to `true` to use the proxy services of Cloudflare - - `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`. - - `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating. + - `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 + or ipv6` (update one of the two, depending on the public ip found). It + defaults to `ipv4 or ipv6`. + - `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be + for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to + no suffix and the raw public IPv6 address obtained is used in the record + updating. ```conf { @@ -65,7 +83,8 @@ When setting up the configuration for Cloudflare, you'll need the following: } ``` -Once you have configured the provider of your choice, correct the file and directory permissions and ownership. +Once you have configured the provider of your choice, correct the file and +directory permissions and ownership. ```sh cd ~/ddns_updater @@ -79,7 +98,8 @@ chmod 400 data/config.json ### Docker Compose -After creating the project structure, let's create the `docker-compose.yml` file. +After creating the project structure, let's create the `docker-compose.yml` +file. ```sh nano ~/ddns_-pdater/docker-compose.yml @@ -123,18 +143,22 @@ services: restart: always ``` -After configuring your preferences in the `docker-compose.yml`, launch the container. +After configuring your preferences in the `docker-compose.yml`, launch the +container. ```sh cd ~/ddns-updater sudo docker-compose up -d ``` -If you've launched this on your local machine, you can launch `localhost:8097` in your browser to see the results. +If you've launched this on your local machine, you can launch `localhost:8097` +in your browser to see the results. ### Nginx Reverse Proxy -If you launched this service on a server, other machine, or just want to access it remotely via a domain name, you can use Nginx as a reverse proxy to expose the service publicly. +If you launched this service on a server, other machine, or just want to access +it remotely via a domain name, you can use Nginx as a reverse proxy to expose +the service publicly. Start by creating the Nginx configuration file. @@ -162,7 +186,8 @@ server { } ``` -Here's a full example that uses my Authelia authentication service to require authentication before someone can access the web page. +Here's a full example that uses my Authelia authentication service to require +authentication before someone can access the web page. ```conf server {