[{"_1":2,"_164":-5,"_165":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_91":-5,"_92":93,"_132":-5,"_133":11,"_134":17,"_135":11,"_136":-5,"_137":11,"_138":-5,"_139":140},"canonicalUrl","https://hub.docker.com/r/chuck1041/ddclient-extended/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","chuck1041","reponame","ddclient-extended","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_46":47,"_49":50,"_51":52,"_53":11,"_54":55,"_56":57,"_58":59,"_39":31,"_28":29,"_61":62,"_63":48,"_64":65,"_66":65,"_67":68,"_69":-5,"_70":71,"_72":73,"_74":11,"_75":29,"_76":77,"_82":11,"_83":84,"_88":29,"_89":90},"categories",[38,43],{"_39":40,"_41":42},"name","Networking","slug","networking",{"_39":44,"_41":45},"Integration & delivery","integration-and-delivery","content_types",[48],"image","date_registered","2024-10-24T15:30:30.390247Z","description","Implementation of ddclient with additional features","is_private","last_updated","2024-10-24T15:35:53.422795Z","last_modified","2024-10-24T16:18:04.803239Z","media_types",[60],"application/vnd.docker.container.image.v1+json","pull_count",209,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","

\n \n $\"ddclient-extended-logo\"$ \n \n

\n\n

\n DDClient Extended\n

\n
\n\n

\n ddclient packaged into a Docker container with a FastAPI-based backend API and optional integragion with healthchecks.io.\n

\n\n

\n $\"GitHub$ \n \n $\"Docker$ \n \n $\"GitHub$ \n \n $\"GitHub$ \n

\n
\n\n# Features\n\n- Runs `ddclient` to update dynamic DNS records.\n- Exposes a FastAPI-based API to expose execution information.\n- Pings `healthchecks.io` with the status of `ddclient` runs (see [API Endpoints](#api-endpoints)).\n- Allows mounting a custom `ddclient.conf` configuration file.\n\n \n\n# Getting Started\n\n## Prerequisites\n\n- Docker\n- Docker Compose (optional)\n\n \n\n> [!IMPORTANT]\n> The default [`ddclient.conf`](src/config/ddclient.conf.example) file does not contain any valid DNS domain configurations and will result in nothing happening. While the default file can be used for testing, this container is designed to have a custom `ddclient.conf` file supplied as a mount.\n\n \n\n## With Docker\n\nTo run the container using Docker Compose, modify the sample [`docker-compose.yml`](docker-compose.yml) file to meet your requirements or create a `docker-compose.yml` with the following content:\n\n```yaml\nservices:\n ddclient-api:\n image: ghcr.io/smith8ca/ddclient-extended:latest\n container_name: ddclient-api\n ports:\n - \"8000:8000\"\n environment:\n - DDCLIENT_INTERVAL=360m\n - HEALTHCHECKS_URL=YOUR-HC-URL\n - HEALTHCHECKS_ID=YOUR-UUID\n volumes:\n - /path/to/your/ddclient.conf:/tmp/ddclient.conf:ro\n```\n\nTo launch with Docker Run:\n\n```bash\ndocker run -d -p 8000:8000 --name ddclient-api \\\n -e DDCLIENT_INTERVAL=360m \\\n -e HEALTHCHECKS_URL=YOUR-HC-URL \\\n -e HEALTHCHECKS_ID=YOUR-UUID \\\n -v /path/to/your/ddclient.conf:/tmp/ddclient.conf:ro \\\n ghcr.io/smith8ca/ddclient-extended:latest\n```\n\nBe sure to update the environment variables accordingly. See the [Environment Variables](#environment-variables) section for more information.\n\n \n\n## From Source\n\nFirst, clone the repository:\n\n```bash\ngit clone https://github.com/smith8ca/ddclient-extended.git\n```\n\nBuild the Docker image by running the following:\n\n```bash\ndocker build -t ddclient-extended .\n```\n\n \n\n## Self-Signed Certificates\n\nBy default, the `curl` command used to ping healthchecks has the `--insecure` flag enabled to avoid issues with self-signed certificates typically used in self-hosted environments. Otherwise, the `curl` commands will fail. You can read more about this behavior [here](https://curl.se/docs/sslcerts.html).\n\nIf you are self-hosting Healthchecks and you would like the healthcheck pings to communicate over HTTPS, you may supply your Certificate Authority to the container by mounting a custom `ca.pem` file to `/etc/ssl/certs/ca.pem:ro` and setting the `HEALTHCHECKS_CUSTOM_CA` environment variable to `true` as shown below:\n\n```yaml\nservices:\n ddclient-api:\n image: ghcr.io/smith8ca/ddclient-extended:latest\n container_name: ddclient-api\n ports:\n - \"8000:8000\"\n environment:\n - HEALTHCHECKS_URL=https://example.lan\n - HEALTHCHECKS_ID=YOUR-UUID\n - HEALTHCHECKS_CUSTOM_CA=true\n volumes:\n - /path/to/your/ca.pem:/etc/ssl/certs/ca.pem:ro\n```\n\nThis will force the `curl` command to execute healthcheck pings over HTTPS using your certificate authority.\n\n \n\n## Environment Variables\n\nThe following environment variables can be used to configure the Docker container:\n\n| **Variable** | **Description** | **Default** | **Required** |\n| ------------------------ | --------------------------------------------- | :---------: | :----------: |\n| `DDCLIENT_INTERVAL` | The interval between ddclient runs | 360m | No |\n| `HEALTHCHECKS_URL` | The base URL for healthchecks.io | _N/A_ | No |\n| `HEALTHCHECKS_ID` | The UUID for the healthchecks.io check | _N/A_ | No |\n| `HEALTHCHECKS_CUSTOM_CA` | Whether to use a custom certificate authority | false | No |\n\n \n\n# API Endpoints\n\nThe FastAPI application exposes the following API endpoints:\n\n- **GET /last_healthcheck_status**: Returns the status of the last health check.\n- **GET /last_healthcheck_timestamp**: Returns the timestamp of the last health check.\n- **GET /last_update_ip**: Returns the IP address of the last `ddclient` update.\n- **GET /last_update_status**: Returns the status of the last `ddclient` update.\n- **GET /last_update_timestamp**: Returns the timestamp of the last `ddclient` update.\n- **POST /run_ddclient**: Manually triggers the `ddclient` to run once and returns the output.\n\n## Accessing the API Documentation\n\nFastAPI automatically generates interactive API documentation. You can access it at:\n\n- **Swagger UI**: `http://localhost:8000/docs`\n- **ReDoc**: `http://localhost:8000/redoc`\n\n \n\n# Contributing\n\nContributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.\n\n## Roadmap\n\nTo see the project's wishlist for upcoming features and planned improvements, please refer to the [ROADMAP.md](ROADMAP.md) file.\n\n \n\n# Credits\n\n- **ddclient**: This project uses [ddclient](https://github.com/ddclient/ddclient), a Perl client used to update dynamic DNS entries for accounts on various DNS providers.\n- **FastAPI**: This project uses [FastAPI](https://fastapi.tiangolo.com/), a modern, fast (high-performance), web framework for building APIs with Python 3.7+ based on standard Python type hints.\n- **Healthchecks**: This project is built to work with [healthchecks](https://github.com/healthchecks/healthchecks), an open-source cron job and background task monitoring service\n\n \n\n# License\n\nThis project is licensed under the [GNU General Public License v3.0](LICENSE).\n","has_starred","hub_user","immutable_tags_settings",{"_78":11,"_79":80},"enabled","rules",[81],".*","is_automated","permissions",{"_85":17,"_86":11,"_87":11},"read","write","admin","user","storage_size",240745391,"orgData","recentTags",[94],{"_95":48,"_96":97,"_98":99,"_100":101,"_102":103,"_104":105,"_54":121,"_122":97,"_123":29,"_124":60,"_39":125,"_126":127,"_128":112,"_129":121,"_130":68,"_131":17},"content_type","creator",18858216,"digest","sha256:24d7dce2b1e815d395c9b1a9126f5f78a5d821e2582429f693fdfdae71dc0d79","full_size",240740300,"id",780779973,"images",[106],{"_107":108,"_98":99,"_109":110,"_111":112,"_113":114,"_115":116,"_117":110,"_118":-5,"_119":101,"_66":68,"_120":-5},"architecture","amd64","features","","last_pulled","2026-09-25T11:13:28.680415989Z","last_pushed","2024-10-24T15:35:53Z","os","linux","os_features","os_version","size","variant","2024-10-24T15:35:52.648822Z","last_updater","last_updater_username","media_type","latest","repository",25476052,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":143,"_152":153,"_139":162,"_163":11},{"_36":144,"_46":147,"_49":50,"_51":52,"_53":11,"_54":55,"_56":57,"_58":148,"_39":31,"_28":29,"_61":62,"_63":48,"_64":65,"_66":65,"_67":68,"_69":-5,"_70":71,"_72":73,"_74":11,"_75":29,"_76":149,"_82":11,"_83":151,"_88":29,"_89":90},[145,146],{"_39":40,"_41":42},{"_39":44,"_41":45},[48],[60],{"_78":11,"_79":150},[81],{"_85":17,"_86":11,"_87":11},"tags",{"_154":65,"_155":-5,"_156":-5,"_157":158},"count","next","previous","results",[159],{"_95":48,"_96":97,"_98":99,"_100":101,"_102":103,"_104":160,"_54":121,"_122":97,"_123":29,"_124":60,"_39":125,"_126":127,"_128":112,"_129":121,"_130":68,"_131":17},[161],{"_107":108,"_98":99,"_109":110,"_111":112,"_113":114,"_115":116,"_117":110,"_118":-5,"_119":101,"_66":68,"_120":-5},[],"canDeleteTags","actionData","errors"]

chuck1041/ddclient-extended

Tags for chuck1041/ddclient-extended