readme-vars.yml

---

# project information
project_name: ddclient
project_url: "https://github.com/ddclient/ddclient"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ddclient-logo.png"
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) 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
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
readonly_supported: true
readonly_message: |
  `/tmp` must also be mounted to tmpfs for this image.
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Edit the `ddclient.conf` file found in your `/config` volume (also see official [ddclient documentation](https://ddclient.net)). 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`:
  ````
  use=cmd, cmd=/etc/ddclient/get-ip-from-fritzbox
  ````
# init diagram
init_diagram: |
  "ddclient:latest": {
    docker-mods
    base {
      fix-attr +\nlegacy cont-init
    }
    docker-mods -> base
    legacy-services
    custom services
    init-services -> legacy-services
    init-services -> custom services
    custom services -> legacy-services
    legacy-services -> ci-service-check
    init-migrations -> init-adduser
    init-os-end -> init-config
    init-config -> init-config-end
    init-ddclient-config -> init-config-end
    init-os-end -> init-crontab-config
    init-mods-end -> init-custom-files
    init-config -> init-ddclient-config
    base -> init-envfile
    base -> init-migrations
    base -> init-mods
    init-config-end -> init-mods
    init-mods -> init-mods-end
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    base -> init-os-end
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-migrations -> init-os-end
    init-custom-files -> init-services
    init-mods-end -> init-services
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-ddclient
    svc-ddclient -> legacy-services
    init-services -> svc-inotify
    svc-inotify -> legacy-services
  }
  Base Images: {
    "baseimage-alpine:3.20"
  }
  "ddclient:latest" <- Base Images
# changelog
changelogs:
  - {date: "08.07.24:", desc: "Fix cache issue."}
  - {date: "08.07.24:", desc: "Don't copy config from `/config/ddclient.conf` to `/ddclient.conf` at runtime."}
  - {date: "27.06.24:", desc: "Rebase to Alpine 3.20."}
  - {date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
  - {date: "25.08.23:", desc: "Rebase to Alpine 3.18."}
  - {date: "04.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "13.02.23:", desc: "Rebase to Alpine 3.17, migrate to s6v3."}
  - {date: "20.10.22:", desc: "Update build instructions for 3.10.0. Update default `ddclient.conf`."}
  - {date: "15.01.22:", desc: "Rebase to Alpine 3.15"}
  - {date: "15.05.21:", desc: "Distribute script 'sample-get-ip-from-fritzbox' from ddclient repo"}
  - {date: "08.03.21:", desc: "Added bind-tools to provide nsupdate"}
  - {date: "01.06.20:", desc: "Rebasing to alpine 3.12."}
  - {date: "08.02.20:", desc: "Ingest from Github."}
  - {date: "06.02.19:", desc: "Fix permissions."}
  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "10.03.19:", desc: "Add perl-io-socket-inet6 for ipv6 support."}
  - {date: "22.02.19:", desc: "Rebasing to alpine 3.9."}
  - {date: "11.02.19:", desc: "Add pipeline logic and multi arch."}
  - {date: "22.08.18:", desc: "Rebase to alpine 3.8."}
  - {date: "10.08.18:", desc: "Update to ddclient v3.9.0. For Cloudflare users, please ensure you remove the line `server=www.cloudflare.com` from your `ddclient.conf`."}
  - {date: "07.12.17:", desc: "Rebase to alpine 3.7."}
  - {date: "28.05.17:", desc: "Rebase to alpine 3.6."}
  - {date: "10.02.17:", desc: "Rebase to alpine 3.5."}
  - {date: "26.11.16:", desc: "Update README to new standard and add icon and other small details."}
  - {date: "29.08.16:", desc: "Initial release."}