14 KiB
title |
---|
duckdns |
linuxserver/duckdns
Duckdns is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence.
Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/duckdns:latest
should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture | Available | Tag |
---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ❌ |
Application Setup
- Go to the duckdns website, register your subdomain(s) and retrieve your token
- Create a container with your subdomain(s) and token. If you own user.duckdns.org, you put
SUBDOMAINS=user
you would NOT put a sub subdomain like overseerr from overseerr.user.ducksdns.org - It will update your IP with the DuckDNS service every 5 minutes (with a random jitter)
Notice regarding automatic detection
Using the UPDATE_IP
variable whatever its value (ipv4
, ipv6
or both
) uses external Cloudflare whoami service to detect public IP addresses.
Be aware that using this variable will query a third-party service other than DuckDNS.
Omitting the UPDATE_IP
variable uses DuckDNS for detection and only supports IPv4.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
---
services:
duckdns:
image: lscr.io/linuxserver/duckdns:latest
container_name: duckdns
network_mode: host #optional
environment:
- PUID=1000 #optional
- PGID=1000 #optional
- TZ=Etc/UTC #optional
- SUBDOMAINS=subdomain1,subdomain2
- TOKEN=token
- UPDATE_IP=ipv4 #optional
- LOG_FILE=false #optional
volumes:
- /path/to/duckdns/config:/config #optional
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=duckdns \
--net=host `#optional` \
-e PUID=1000 `#optional` \
-e PGID=1000 `#optional` \
-e TZ=Etc/UTC `#optional` \
-e SUBDOMAINS=subdomain1,subdomain2 \
-e TOKEN=token \
-e UPDATE_IP=ipv4 `#optional` \
-e LOG_FILE=false `#optional` \
-v /path/to/duckdns/config:/config `#optional` \
--restart unless-stopped \
lscr.io/linuxserver/duckdns:latest
Parameters
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal>
respectively. For example, -p 8080:80
would expose port 80
from inside the container to be accessible from the host's IP on port 8080
outside the container.
Ports (-p
)
Parameter | Function |
---|
Networking (--net
)
Parameter | Function |
---|---|
--net=host |
Use host networking for IPv6 detection |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Etc/UTC |
specify a timezone to use, see this list. |
SUBDOMAINS=subdomain1,subdomain2 |
multiple subdomains allowed, comma separated, no spaces, if your domain is user.duckdns.org you put user, not a sub-subdomain |
TOKEN=token |
DuckDNS token |
UPDATE_IP=ipv4 |
Set to ipv6 or ipv4 to update only your public IPv4/6 address. Set to both to update IPv6 and IPv4 address. This variable makes use of a third-party service. Omitting this variable uses DuckDNS for detection and only supports IPv4. both and ipv6 modes needs host networking. |
LOG_FILE=false |
Set to true to log to file (also need to map /config). |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
Persistent config files |
Miscellaneous Options
Parameter | Function |
---|
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable
Will set the environment variable MYVAR
based on the contents of the /run/secrets/mysecretvariable
file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022
setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v
flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID
and group PGID
.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000
and PGID=1000
, to find yours use id your_user
as below:
id your_user
Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
You only need to set the PUID and PGID variables if you are mounting the /config folder
Docker Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
-
Shell access whilst the container is running:
docker exec -it duckdns /bin/bash
-
To monitor the logs of the container in realtime:
docker logs -f duckdns
-
Container version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' duckdns
-
Image version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/duckdns:latest
Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Via Docker Compose
-
Update images:
-
All images:
docker-compose pull
-
Single image:
docker-compose pull duckdns
-
-
Update containers:
-
All containers:
docker-compose up -d
-
Single container:
docker-compose up -d duckdns
-
-
You can also remove the old dangling images:
docker image prune
Via Docker Run
-
Update the image:
docker pull lscr.io/linuxserver/duckdns:latest
-
Stop the running container:
docker stop duckdns
-
Delete the container:
docker rm duckdns
-
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/config
folder and settings will be preserved) -
You can also remove the old dangling images:
docker image prune
Image Update Notifications - Diun (Docker Image Update Notifier)
!!! tip
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-duckdns.git
cd docker-duckdns
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/duckdns:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.
Versions
- 23.12.23: - Rebase to Alpine 3.19.
- 14.10.23: - Rework shell script for case insensitivity and update readme to be more clear.
- 13.10.23: - Add support for public IPv6 address update using Cloudflare.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.03.23: - Rework shell scripts and cron logic.
- 13.02.23: - Rebase to alpine 3.17.
- 23.09.22: - Rebase to alpine 3.16 and s6v3.
- 19.09.22: - Rebase to alpine 3.15.
- 17.05.22: - Don't allow insecure connections and add timeout.
- 17.05.22: - Add random jitter to update time.
- 23.02.22: - Append to log file instead of overwriting every time.
- 03.05.21: - Re-adjust cron timings to prevent peak times, update code formatting.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 13.04.20: - Add donation links for DuckDNS.
- 19.12.19: - Rebasing to alpine 3.11.
- 24.09.19: - Fix perms on github and remove chmod that can stall the container.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 08.02.19: - Update readme with optional parameters.
- 10.12.18: - Fix docker compose example.
- 15.10.18: - Multi-arch image.
- 22.08.18: - Rebase to alpine 3.8.
- 08.12.17: - Rebase to alpine 3.7.
- 28.05.17: - Rebase to alpine 3.6.
- 09.02.17: - Rebase to alpine 3.5.
- 17.11.16: - Initial release.