{"id":28497287,"url":"https://github.com/btholt/unifi-ddns","last_synced_at":"2025-07-23T08:33:54.738Z","repository":{"id":287806915,"uuid":"965851783","full_name":"btholt/unifi-ddns","owner":"btholt","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-14T02:32:44.000Z","size":50,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-17T21:09:58.043Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/btholt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-14T02:32:28.000Z","updated_at":"2025-04-19T07:21:03.000Z","dependencies_parsed_at":"2025-04-14T03:34:03.834Z","dependency_job_id":"c67f5a51-ce43-498a-ab52-13143eddde5b","html_url":"https://github.com/btholt/unifi-ddns","commit_stats":null,"previous_names":["btholt/unifi-ddns"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/btholt/unifi-ddns","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btholt%2Funifi-ddns","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btholt%2Funifi-ddns/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btholt%2Funifi-ddns/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btholt%2Funifi-ddns/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/btholt","download_url":"https://codeload.github.com/btholt/unifi-ddns/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btholt%2Funifi-ddns/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266645150,"owners_count":23961658,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-06-08T13:05:44.069Z","updated_at":"2025-07-23T08:33:54.712Z","avatar_url":"https://github.com/btholt.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌩️ Cloudflare DDNS for UniFi OS\n\n[![CodeQL](https://github.com/willswire/unifi-ddns/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/willswire/unifi-ddns/actions/workflows/github-code-scanning/codeql)\n[![Code Coverage](https://github.com/willswire/unifi-ddns/actions/workflows/coverage.yml/badge.svg)](https://github.com/willswire/unifi-ddns/actions/workflows/coverage.yml)\n[![Dependabot Updates](https://github.com/willswire/unifi-ddns/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/willswire/unifi-ddns/actions/workflows/dependabot/dependabot-updates)\n[![Deploy](https://github.com/willswire/unifi-ddns/actions/workflows/deploy.yml/badge.svg)](https://github.com/willswire/unifi-ddns/actions/workflows/deploy.yml)\n\nA Cloudflare Worker script that enables UniFi devices (e.g., UDM-Pro, USG) to dynamically update DNS A/AAAA records on Cloudflare.\n\n## Why Use This?\n\nUniFi devices do not natively support Cloudflare as a DDNS provider. This script bridges that gap, allowing your UniFi device to keep your DNS records updated with your public IP address.\n\n## 🚀 **Setup Overview**\n\n### 1. **Deploy the Cloudflare Worker**\n\n#### **Option 1: Click to Deploy**\n[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/willswire/unifi-ddns)\n\n1. Click the button above.\n2. Complete the deployment.\n3. Note the `*.workers.dev` route.\n\n#### **Option 2: Deploy with Wrangler CLI**\n1. Clone this repository.\n2. Install [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/install-and-update/).\n3. Run:\n   ```sh\n   npm i\n   wrangler login\n   wrangler deploy\n   ```\n4. Note the `*.workers.dev` route.\n\n### 2. **Generate a Cloudflare API Token**\n\n1. Go to the [Cloudflare Dashboard](https://dash.cloudflare.com/).\n2. Navigate to **Profile \u003e API Tokens**\n3. Create a token using the **Edit zone DNS** template.\n4. Scope the token to **one** specific zone.\n5. Save the token securely.\n\n### 3. **Configure UniFi OS**\n\n1. Log in to your [UniFi OS Controller](https://unifi.ui.com/).\n2. Go to **Settings \u003e Internet \u003e WAN \u003e Dynamic DNS**.\n3. Create New Dynamic DNS with the following information:\n   - **Service:** `custom`\n   - **Hostname:** `subdomain.example.com` or `example.com`\n   - **Username:** Cloudflare Account Email Address (e.g., `you@example.com`)\n   - **Password:** Cloudflare User API Token *(not an Account API Token)*\n   - **Server:** `\u003cworker-name\u003e.\u003cworker-subdomain\u003e.workers.dev/update?ip=%i\u0026hostname=%h`\n     *(Omit `https://`)*\n\n## 🛠️ **Testing \u0026 Troubleshooting**\n\nUsing this script with various Ubiquiti devices and different UniFi software versions can introduce unique challenges. If you encounter issues, start by checking the FAQ in `/docs/faq.md`. If you don’t find a solution, you can ask a question on the [discussions page](https://github.com/willswire/unifi-ddns/discussions/new?category=q-a). If the problem persists, please raise an issue [here](https://github.com/willswire/unifi-ddns/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtholt%2Funifi-ddns","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbtholt%2Funifi-ddns","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtholt%2Funifi-ddns/lists"}