</code></pre><h2id=usage>Usage</h2><p>To help you get started creating a container from this image you can either use docker-compose or the docker cli.</p><h3id=docker-compose-recommended-click-here-for-more-info>docker-compose (recommended, <ahref=https://docs.linuxserver.io/general/docker-compose>click here for more info</a>)</h3><pre><codeclass=language-yaml>---
version: "2.1"
services:
ddclient:
image: lscr.io/linuxserver/ddclient:latest
container_name: ddclient
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- <path to data>:/config
restart: unless-stopped
</code></pre><h3id=docker-cli-click-here-for-more-info>docker cli (<ahref=https://docs.docker.com/engine/reference/commandline/cli/>click here for more info</a>)</h3><pre><codeclass=language-bash>docker run -d \
--name=ddclient \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-v <path to data>:/config \
--restart unless-stopped \
lscr.io/linuxserver/ddclient:latest
</code></pre><h2id=parameters>Parameters</h2><p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><h3id=ports-p>Ports (<code>-p</code>)</h3><table><thead><tr><thalign=center>Parameter</th><th>Function</th></tr></thead><tbody><tr><td></td><td></td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)</h3><table><thead><tr><thalign=center>Env</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><tdalign=center><code>PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><tdalign=center><code>TZ=Europe/London</code></td><td>Specify a timezone to use EG Europe/London.</td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)</h3><table><thead><tr><thalign=center>Volume</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>/config</code></td><td>Where ddclient should store its config files.</td></tr></tbody></table><h4id=miscellaneous-options>Miscellaneous Options</h4><table><thead><tr><thalign=center>Parameter</th><th>Function</th></tr></thead><tbody><tr><td></td><td></td></tr></tbody></table><h2id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)</h2><p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p><p>As an example:</p><pre><codeclass=language-bash>-e FILE__PASSWORD=/run/secrets/mysecretpassword
</code></pre><p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p><h2id=umask-for-running-applications>Umask for running applications</h2><p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <ahref=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p><h2id=user-group-identifiers>User / Group Identifiers</h2><p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p><p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p><p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p><pre><codeclass=language-bash> $ id username
</code></pre><h2id=docker-mods>Docker Mods</h2><p><ahref="https://mods.linuxserver.io/?mod=ddclient"title="view available mods for this container."><imgalt="Docker Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=ddclient&query=%24.mods%5B%27ddclient%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a><ahref="https://mods.linuxserver.io/?mod=universal"title="view available universal mods."><imgalt="Docker Universal Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a></p><p>We publish various <ahref=https://github.com/linuxserver/docker-mods>Docker Mods</a> 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.</p><h2id=support-info>Support Info</h2><ul><li>Shell access whilst the container is running:</li><li><code>docker exec -it ddclient /bin/bash</code></li><li>To monitor the logs of the container in realtime:</li><li><code>docker logs -f ddclient</code></li><li>Container version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' ddclient</code></li><li>Image version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ddclient:latest</code></li></ul><h2id=versions>Versions</h2><ul><li><strong>20.10.22:</strong> - Update build instructions for 3.10.0. Update default <code>ddclient.conf</code>.</li><li><strong>15.01.22:</strong> - Rebase to Alpine 3.15</li><li><strong>15.05.21:</strong> - Distribute script 'sample-get-ip-from-fritzbox' from ddclient repo</li><li><strong>08.03.21:</strong> - Added bind-tools to provide nsupdate</li><li><strong>01.06.20:</strong> - Rebasing to alpine 3.12.</li><li><strong>08.02.20:</strong> - Ingest from Github.</li><li><strong>06.02.19:</strong> - Fix permissions.</li><li><strong>19.12.19:</strong> - Rebasing to alpine 3.11.</li><li><strong>28.06.19:</strong> - Rebasing to alpine 3.10.</li><li><strong>23.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li><li><strong>10.03.19:</strong> - Add perl-io-socket-inet6 for ipv6 support.</li><li><strong>22.02.19:</strong> - Rebasing to alpine 3.9.</li><li><strong>11.02.19:</strong> - Add pipeline logic and multi arch.</li><li><strong>22.08.18:</strong> - Rebase to alpine 3.8.</li><li><strong>10.08.18:</strong> - Update to ddclient v3.9.0. For Cloudflare users, please ensure you remove the line <code>server=www.cloudflare.com</code> from your <code>ddclient.conf</code>.</li><li><strong>07.12.17:</strong> - Rebase to alpine 3.7.</li><li><strong>28.05.17:</strong> - Rebase to alpine 3.6.</li><li><strong>10.02.17:</strong> - Rebase to alpine 3.5.</li><li><strong>26.11.16:</strong> - Update README to new standard and add icon and other small details.</li><li><strong>29.08.16:</strong> - Initial release.</li></ul></article></div></div></main><footerclass=md-footer><navclass="md-footer__inner md-grid"aria-label=Footer><ahref=../docker-davos/class="md-footer__link md-footer__link--prev"aria-label="Previous: davos"rel=prev><divclass="md-footer__button md-icon"><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg></div><divclass=md-footer__title><divclass=md-ellipsis><spanclass=md-footer__direction> Previous </span> davos </div></div></a><ahref=../docker-deluge/class="md-footer__link md-footer__link--next"aria-label="Next: deluge"rel=next><divclass=md-footer__title><divclass=md-ellipsis><spanclass=md-footer__direction> Next </span> deluge </div>
