Portainer Templates logo

Portainer Templates

Duckdns Duckdns

NetworkDNS

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.

Image details

Pulls: 212.0M
Architectures: amd64, arm64
Image size: 15 MB
User: linuxserver
Created: Nov 17, 2016
Updated: 4 days ago
Status: active

Configuration

Type
Container
Platform
linux
Image
linuxserver/duckdns:latest
Ports
80:80/tcp
Volumes
/config : /srv/lsio/duckdns/config/config : /srv/lsio/duckdns/config
Env vars
PUID=1000PGID=1000TZ=Etc/UTCSUBDOMAINS=subdomain1,subdomain2TOKEN=tokenUPDATE_IP=ipv4LOG_FILE=false
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/duckdns/config
mkdir -p /srv/lsio/duckdns/config

Installation

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

docker run -d --name Duckdns \
  --network host \
  -p 80:80/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -e 'SUBDOMAINS=subdomain1,subdomain2' \
  -e 'TOKEN=token' \
  -e 'UPDATE_IP=ipv4' \
  -e 'LOG_FILE=false' \
  -v /srv/lsio/duckdns/config:/config \
  -v /srv/lsio/duckdns/config:/config \
  --restart=unless-stopped \
  linuxserver/duckdns:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  duckdns:
    image: linuxserver/duckdns:latest
    ports:
      - 80:80/tcp
    volumes:
      - /srv/lsio/duckdns/config:/config
      - /srv/lsio/duckdns/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      SUBDOMAINS: subdomain1,subdomain2
      TOKEN: token
      UPDATE_IP: ipv4
      LOG_FILE: 'false'
    network_mode: host
    restart: unless-stopped

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

duckdns-deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: duckdns
  labels:
    app: duckdns
spec:
  replicas: 1
  selector:
    matchLabels:
      app: duckdns
  template:
    metadata:
      labels:
        app: duckdns
    spec:
      hostNetwork: true
      containers:
        - name: duckdns
          image: linuxserver/duckdns:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: SUBDOMAINS
              value: subdomain1,subdomain2
            - name: TOKEN
              value: token
            - name: UPDATE_IP
              value: ipv4
            - name: LOG_FILE
              value: 'false'
          ports:
            - containerPort: 80
              protocol: TCP
          volumeMounts:
            - name: duckdns-data-0
              mountPath: /config
            - name: duckdns-data-1
              mountPath: /config
      volumes:
        - name: duckdns-data-0
          hostPath:
            path: /srv/lsio/duckdns/config
        - name: duckdns-data-1
          hostPath:
            path: /srv/lsio/duckdns/config

Save this file as ~/.config/containers/systemd/duckdns.container

[Unit]
Description=Duckdns

[Container]
Image=linuxserver/duckdns:latest
ContainerName=duckdns
PublishPort=80:80/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=SUBDOMAINS=subdomain1,subdomain2
Environment=TOKEN=token
Environment=UPDATE_IP=ipv4
Environment=LOG_FILE=false
Volume=/srv/lsio/duckdns/config:/config
Volume=/srv/lsio/duckdns/config:/config
Network=host

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start duckdns

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

linuxserver.io
Blog Discord Discourse GitHub Open Collective
The LinuxServer.io team brings you another container release featuring:
  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/duckdns

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
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.
duckdns

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-\ | | arm64 | ✅ | arm64v8-\ |

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 set SUBDOMAINS=user. You would NOT set 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.

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

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.
| Parameter | Function | | :----: | --- | | --net=host | Use host networking for IPv6 detection | | -e PUID=1000 | for UserID - see below for explanation | | -e PGID=1000 | for GroupID - see below for explanation | | -e TZ=Etc/UTC | specify a timezone to use, see this list. | | -e SUBDOMAINS=subdomain1,subdomain2 | multiple subdomains allowed, comma separated, no spaces, if your domain is user.duckdns.org you put user, not a sub-subdomain | | -e TOKEN=token | DuckDNS token | | -e 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. | | -e LOG_FILE=false | Set to true to log to file (also need to map /config). | | -v /config | Persistent config files. Also set LOG_FILE=true to keep address history. | | --read-only=true | Run container with a read-only filesystem. Please read the docs. |

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

Docker Mods Docker Universal 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:
```bash
docker exec -it duckdns /bin/bash
```
  • To monitor the logs of the container in realtime:
```bash
docker logs -f duckdns
```
  • Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' duckdns
```
  • Image version number:
```bash
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:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull duckdns
    ```
  • Update containers:
* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d duckdns
    ```
  • You can also remove the old dangling images:
```bash
docker image prune
```

Via Docker Run

  • Update the image:
```bash
docker pull lscr.io/linuxserver/duckdns:latest
```
  • Stop the running container:
```bash
docker stop duckdns
```
  • Delete the container:
```bash
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:
```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend 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 x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 15.07.26: - Rebase to Alpine 3.24.
  • 27.07.25: - Rebase to Alpine 3.22.
  • 27.01.25: - Rebase to Alpine 3.21.
  • 24.06.24: - Rebase to Alpine 3.20.
  • 17.06.24: - Bump CIDELAY to 120 seconds as ARM builds were failing.
  • 30.03.24: - Added IP address to logging output when IP changes.
  • 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.

Serve Duckdns on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying duckdns.example.com to http://localhost:80

Add this to your Caddyfile

duckdns.example.com {
	reverse_proxy http://localhost:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Duckdns
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Runs on the host network

This container shares your server's network directly, so port mappings are ignored and every port the app opens binds straight to the host.

  • If a port won't bind, find the clash with sudo ss -tlnp and stop the other service, or change the port in Duckdns's own settings.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:80. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Duckdns can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 80

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/duckdns/config
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/duckdns:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Duckdns --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Similar apps