3.8 KiB
ddns
- Dynamic DNS
A self-hosted Dynamic DNS solution similar to DynDNS or NO-IP.
You can use a hosted version at ddns.pboehm.de where you can register a
host under the d.pboehm.de
domain (e.g test.d.pboehm.de
).
Recent Changes
ddns
has been fully restructured and now uses the PowerDNS
Remote Backend instead
of the Pipe Backend, which
is far easier to deploy. It now serves both the frontend and the backend over HTTP using different ports.
The old ddns
source code can be found at the legacy tag.
How can I update my IP if it changes?
ddns
is built around a small webservice, so that you can update your IP address simply by calling
an URL periodically through curl
. Hosts that haven't been updated for 10 days will
be automatically removed. This can be configured in your own instance.
An API similar to DynDNS/NO-IP has not been implemented yet.
Self-Hosting
Requirements
- A custom domain where the registrar allows setting
NS
records for subdomains. This is important because not all DNS providers support this. - A server with docker and docker-compose installed
- The following ports should be opened in the firewall:
53/udp
80/tcp
443/tcp
DNS-Setup
For the domain you want to use with ddns
(example.net
in the following sections, please adjust this to your domain)
you have to create the following two DNS records:
ddns.example.net
as aCNAME
orA
/AAAA
record pointing to the serverddns
will be running on. This record will be used for accessing theddns
frontend in your browser or viacurl
. It is also the target for the correspondingNS
record.d.example.net
as anNS
record pointing to the previously createdddns.example.net
record. This will delegate all subdomains underd.example.net
to the PowerDNS server running onddns.example.net
.
ddns
-Setup
Setting up ddns
was kind of a hassle in the legacy version, because there are multiple components that have to
work together:
ddns
that runs the frontend and provides an API compatible with the Remote Backend- Redis as storage backend for
ddns
- PowerDNS as DNS server, which uses the
ddns
backend API on Port8053
- A web server that makes the
ddns
frontend accessible to the Internet through HTTPS
The setup is now automated using docker-compose and only some customization has
to be made in a docker-compose.override.yml
file
(a sample is available here).
Configuring the Setup
The setup included in this repository contains all the components described above and uses caddy as a web server, because it provides automatic HTTPS using Lets Encrypt.
git clone git@github.com:pboehm/ddns.git
cd ddns/docker
cp docker-compose.override.yml.sample docker-compose.override.yml
Please adjust the settings in docker-compose.override.yml
marked with the #<<< ....
comments as follows:
- adjust the domain part in lines marked with
# <<< ADJUST DOMAIN
according to your DNS-Setup - insert your email address in lines marked with
# <<< INSERT EMAIL
which is required for getting certificates from Lets Encrypt - adjust the path component before the
:
in lines marked with# <<< ADJUST LOCAL PATH
if the shown path does not meet your requirements
Finally execute the following docker-compose
command, which creates 4 containers in detached mode which are also
started automatically after reboot.
docker-compose --project-name ddns up -d