linuxserver/ddclient
Ddclient is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. It was originally written by Paul Burry and is now mostly by wimpunk. It has the capability to update more than just dyndns and it can fetch your WAN-ipaddress in a few different ways.
Simply pulling
lscr.io/linuxserver/ddclient: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> |
Edit the
ddclient.conf file found in your /config volume (also see official ddclient documentation). This config file has many providers to choose from and you basically just have to uncomment your provider and add username/password where requested. If you modify ddclient.conf, ddclient will automaticcaly restart and read the config.If ddclient shall fetch the dynamic (public) IP-address from a fritz.box (AVM) add the following line to
/config/ddclient.conf:use=cmd, cmd=/etc/ddclient/get-ip-from-fritzbox
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:
ddclient:
image: lscr.io/linuxserver/ddclient:latest
container_name: ddclient
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/data:/config
restart: unless-stopped
docker run -d \
--name=ddclient \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-v /path/to/data:/config \
--restart unless-stopped \
lscr.io/linuxserver/ddclient:latest
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.Env | Function |
|---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
TZ=Etc/UTC |
Volume | Function |
|---|---|
/config | Where ddclient should store its config files. |
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.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.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)
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.
- Shell access whilst the container is running:
docker exec -it ddclient /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f ddclient
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ddclient
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ddclient:latest
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 20.10.22: - Update build instructions for 3.10.0. Update default
ddclient.conf. - 15.01.22: - Rebase to Alpine 3.15
- 15.05.21: - Distribute script 'sample-get-ip-from-fritzbox' from ddclient repo
- 08.03.21: - Added bind-tools to provide nsupdate
- 01.06.20: - Rebasing to alpine 3.12.
- 08.02.20: - Ingest from Github.
- 06.02.19: - Fix permissions.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.03.19: - Add perl-io-socket-inet6 for ipv6 support.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 22.08.18: - Rebase to alpine 3.8.
- 10.08.18: - Update to ddclient v3.9.0. For Cloudflare users, please ensure you remove the line
server=www.cloudflare.comfrom yourddclient.conf. - 07.12.17: - Rebase to alpine 3.7.
- 28.05.17: - Rebase to alpine 3.6.
- 10.02.17: - Rebase to alpine 3.5.
- 26.11.16: - Update README to new standard and add icon and other small details.
- 29.08.16: - Initial release.
Last modified 3mo ago