Search…
Images
Powered By GitBook
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.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. 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/ddclient 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
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

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.

Get dynamic IP from Fritz.Box

If ddclient shall fetch the dynamic (public) IP-address from a fritz.box (AVM) add the following line to /config/ddclient.conf:
1
use=cmd, cmd=/etc/ddclient/get-ip-from-fritzbox
Copied!

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
ddclient:
5
image: lscr.io/linuxserver/ddclient
6
container_name: ddclient
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=Europe/London
11
volumes:
12
- <path to data>:/config
13
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=ddclient \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-v <path to data>:/config \
7
--restart unless-stopped \
8
lscr.io/linuxserver/ddclient
Copied!

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)

Parameter
Function

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.

Volume Mappings (-v)

Volume
Function
/config
Where ddclient should store its 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:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
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:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

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

Versions

    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.com from your ddclient.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 22d ago