Search…
⌃K

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
arm32v7-<version tag>

Application Setup

  • Go to the duckdns website, register your subdomain(s) and retrieve your token
  • Create a container with your subdomain(s) and token
  • It will update your IP with the DuckDNS service every 5 minutes (with a random jitter)

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
duckdns:
image: lscr.io/linuxserver/duckdns:latest
container_name: duckdns
environment:
- PUID=1000 #optional
- PGID=1000 #optional
- TZ=Europe/London
- SUBDOMAINS=subdomain1,subdomain2
- TOKEN=token
- LOG_FILE=false #optional
volumes:
- /path/to/appdata/config:/config #optional
restart: unless-stopped
docker run -d \
--name=duckdns \
-e PUID=1000 `#optional` \
-e PGID=1000 `#optional` \
-e TZ=Europe/London \
-e SUBDOMAINS=subdomain1,subdomain2 \
-e TOKEN=token \
-e LOG_FILE=false `#optional` \
-v /path/to/appdata/config:/config `#optional` \
--restart unless-stopped \
lscr.io/linuxserver/duckdns:latest

Parameters

Docker images 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)

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=Europe/London
Specify a timezone to use EG Europe/London
SUBDOMAINS=subdomain1,subdomain2
multiple subdomains allowed, comma separated, no spaces
TOKEN=token
DuckDNS token
LOG_FILE=false
Set to true to log to file (also need to map /config).

Volume Mappings (-v)

Volume
Function
/config
Used in conjunction with logging to file.
Miscellaneous Options

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__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword 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 user as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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

Versions

  • 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.