{"id":19608917,"url":"https://github.com/fire1ce/udm-cloudflare-ddns","last_synced_at":"2025-06-26T22:35:48.064Z","repository":{"id":109807468,"uuid":"517095964","full_name":"fire1ce/UDM-Cloudflare-DDNS","owner":"fire1ce","description":"Cloudflare DDNS container for UDM","archived":false,"fork":false,"pushed_at":"2025-02-24T08:29:25.000Z","size":20,"stargazers_count":14,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-16T04:33:42.689Z","etag":null,"topics":["cloudflare","cloudflare-dns","ddns","udm","udm-pro","unifi"],"latest_commit_sha":null,"homepage":"https://3os.org","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fire1ce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"fire1ce","patreon":"fire1ce","custom":["https://www.buymeacoffee.com/fire1ce"]}},"created_at":"2022-07-23T15:34:51.000Z","updated_at":"2025-03-20T00:23:18.000Z","dependencies_parsed_at":"2025-02-24T09:25:25.762Z","dependency_job_id":"a1685ba6-1628-4b2c-b735-2712c764ca02","html_url":"https://github.com/fire1ce/UDM-Cloudflare-DDNS","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fire1ce/UDM-Cloudflare-DDNS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fire1ce%2FUDM-Cloudflare-DDNS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fire1ce%2FUDM-Cloudflare-DDNS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fire1ce%2FUDM-Cloudflare-DDNS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fire1ce%2FUDM-Cloudflare-DDNS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fire1ce","download_url":"https://codeload.github.com/fire1ce/UDM-Cloudflare-DDNS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fire1ce%2FUDM-Cloudflare-DDNS/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260096890,"owners_count":22958124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudflare","cloudflare-dns","ddns","udm","udm-pro","unifi"],"created_at":"2024-11-11T10:18:33.304Z","updated_at":"2025-06-26T22:35:48.045Z","avatar_url":"https://github.com/fire1ce.png","language":"Shell","funding_links":["https://github.com/sponsors/fire1ce","https://patreon.com/fire1ce","https://www.buymeacoffee.com/fire1ce"],"categories":[],"sub_categories":[],"readme":"# UDM-Cloudflare-DDNS\n\n## Change Log\n\n- 2024-07-02 - Added support for Unifi OS v4.x\n- 2023-12-14 - Updated installation and uninstallation scripts for better user experience, flexibility, and removed support for v1.x firmware versions.\n- 2023-02-10 - Major Update for UDM v2.x and v3.x\n\n## What It Does\n\nThis project provides a script to set up a DDNS (Dynamic DNS) service using Cloudflare as the DNS provider on Ubiquiti's UDM devices. The script sets up a systemd service and timer to handle DDNS updates for your main internet IP address at regular intervals.\n\n## Compatibility\n\n- Tested on [UDM PRO][amz-udm-pro-url] with UDM OS v3.2.7\n\n## Requirements\n\n- UDM OS 2.x or 3.x\n- ssh root access to the UDM\n- Cloudflare API Toke\n\n### Creating a Cloudflare API token\n\nTo create a CloudFlare API token for your DNS zone go to [https://dash.cloudflare.com/profile/api-tokens][cloudflare-api-token-url] and follow these steps:\n\n1. Click Create Token\n2. Select Create Custom Token\n3. Provide the token a name, for example, `example.com-dns-zone`\n4. Grant the token the following permissions:\n   - Zone - DNS - Edit\n5. Set the zone resources to:\n   - Include - Specific Zone - `example.com`\n6. Complete the wizard.\n7. Use the generated token at the `API_KEY` variable for the container\n\n## Installation\n\nRun the following command to install the Cloudflare DDNS service as root on your UDM:\n\n```shell\nsudo curl -s -o install.sh https://raw.githubusercontent.com/fire1ce/UDM-Cloudflare-DDNS/main/install.sh\nsudo chmod +x install.sh\nsudo ./install.sh\n```\n\nThis script will:\n\nDetermine the appropriate data directory.\nDownload and install the DDNS script and configuration file.\nSet up a systemd service and timer to run the DDNS script at regular intervals (configurable by the user).\n\n## Configuration\n\nAfter installation, you can find and edit the configuration file typically located at `/data/cloudflare-ddns/update-cloudflare-dns.conf` or `/mnt/data/cloudflare-ddns/update-cloudflare-dns.conf`, depending on your UDM model and firmware version. Update this file with your Cloudflare details.\n\n## Uninstallation\n\nTo uninstall the Cloudflare DDNS service, you will need to run an uninstallation script that:\n\nStops and disables the systemd service and timer.\nRemoves the DDNS script, configuration files, and systemd files.\nOptionally removes log files, if generated by the service.\n\nRun the following command to uninstall the Cloudflare DDNS service as root on your UDM:\n\n```shell\nsudo curl -s https://raw.githubusercontent.com/fire1ce/UDM-Cloudflare-DDNS/main/uninstall.sh | bash\n```\n\n## Acknowledgments\n\nThis UDM-Cloudflare-DDNS project is based on the [DDNS-Cloudflare-Bash][DDNS-Cloudflare-Bash-git-url] script by the same author. It has been adapted and extended specifically for use with Ubiquiti's UDM devices.\n\n\u003c!-- --- --\u003e\n\n[amz-udm-pro-url]: https://amzn.to/3J4fezk 'Amazon Unifi UDM Pro'\n[cloudflare-api-token-url]: https://dash.cloudflare.com/profile/api-tokens 'Cloudflare API Token'\n[DDNS-Cloudflare-Bash-git-url]: https://github.com/fire1ce/DDNS-Cloudflare-Bash 'DDNS-Cloudflare-Bash'\n\n\u003c!-- --- --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffire1ce%2Fudm-cloudflare-ddns","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffire1ce%2Fudm-cloudflare-ddns","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffire1ce%2Fudm-cloudflare-ddns/lists"}