{"id":13588540,"url":"https://github.com/joshuaavalon/docker-cloudflare","last_synced_at":"2025-04-08T06:32:13.982Z","repository":{"id":37743095,"uuid":"104037740","full_name":"joshuaavalon/docker-cloudflare","owner":"joshuaavalon","description":"Cloudflare DDNS minimal docker.","archived":true,"fork":false,"pushed_at":"2023-11-20T06:48:44.000Z","size":1510,"stargazers_count":241,"open_issues_count":5,"forks_count":39,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-06T08:40:59.996Z","etag":null,"topics":["cloudflare","ddns","docker"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/joshava/cloudflare-ddns/","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/joshuaavalon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":["joshuaavalon"]}},"created_at":"2017-09-19T06:51:15.000Z","updated_at":"2024-10-16T23:35:23.000Z","dependencies_parsed_at":"2023-11-20T04:24:45.925Z","dependency_job_id":"599894ee-f8e1-4d01-9f08-df2d90b08d0e","html_url":"https://github.com/joshuaavalon/docker-cloudflare","commit_stats":null,"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuaavalon%2Fdocker-cloudflare","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuaavalon%2Fdocker-cloudflare/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuaavalon%2Fdocker-cloudflare/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuaavalon%2Fdocker-cloudflare/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshuaavalon","download_url":"https://codeload.github.com/joshuaavalon/docker-cloudflare/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247792092,"owners_count":20996877,"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","ddns","docker"],"created_at":"2024-08-01T15:06:46.854Z","updated_at":"2025-04-08T06:32:11.556Z","avatar_url":"https://github.com/joshuaavalon.png","language":"TypeScript","funding_links":["https://github.com/sponsors/joshuaavalon"],"categories":["HarmonyOS","TypeScript"],"sub_categories":["Windows Manager"],"readme":"# Cloudflare DDNS\n\n[![GitHub Actions][actions-badge]][actions]\n[![License][license-badge]][license]\n\nCloudflare DDNS is a Docker image that update DNS records on Cloudflare on schedule.\n\n## Table of Content\n\n- [Getting Started](#getting-started)\n- [Guide](#guide)\n  - [Authentication](#authentication)\n    - [API Token](#api-token)\n    - [Global API Key](#global-api-key)\n    - [Zone ID](#zone-id)\n  - [Configuration](#configuration)\n    - [File](#file)\n    - [Environment Variables](#environment-variables)\n- [Migration](#migration)\n\n## Getting Started\n\n```bash\ndocker run -d -v ./config.yaml:/app/config.yaml ghcr.io/joshuaavalon/cloudflare-ddns:\u003cTAG\u003e\n```\n\nThe Docker image now supports multiple architecture. `arm32v6` will no longer be used.\nBecause of Docker Hub removal of free team plan, `joshava/cloudflare-ddns` is no longer supported.\n\nIt is recommended to use tagged version instead of `latest`.\n\n### Authentication\n\n#### API Token\n\nAPI Token is needed to set the DNS records.\n\nSee [API Token](./guide/api-token.md) on how to create it.\n\n#### Global API Key\n\nGlobal API is no longer supported. Please use [API token](#api-token).\n\n#### Zone ID\n\nGo to you domain overview page and scroll to the bottom. Copy the `Zone ID` in the API section.\n\n![Zone ID](./guide/zone-id.png)\n\n### Configuration\n\nThere are 2 types of configuration supported: environment variables or file.\n\nNote that `CF_DNS__CRON` and `CF_DNS__LOG_TYPE` can only configure via environment variables because it is used before the application start.\n\nFrom v3, you should use either environment variables or file configuration. They will no longer be merged. (Except `CF_DNS__CRON` and `CF_DNS__LOG_TYPE`)\n\nYou can verify your configuration with [JSON Schema](https://joshuaavalon.github.io/docker-cloudflare/config.schema.json)\n\nFor file configuration, the configuration should be place at `/app/config.yaml`. It can be changed by defining `CF_DNS__CONFIG` in environment variables.\n\n```yaml\nauth:\n  scopedToken: QPExdfoNLwndJPDbt4nK1-yF1z_srC8D0m6-Gv_h\ndomains:\n  - name: foo.example.com\n    type: A\n    proxied: true\n    create: true\n    zoneId: JBFRZWzhTKtRFWgu3X7f3YLX\n```\n\nSee [configuration](./guide/configuration.md) for details.\n\n## Migration\n\nSee [migration](./guide/migration.md) for details.\n\n[actions-badge]: https://github.com/joshuaavalon/docker-cloudflare/workflows/Main/badge.svg\n[actions]: https://github.com/joshuaavalon/docker-cloudflare/actions\n[license]: https://github.com/joshuaavalon/docker-cloudflare/blob/master/LICENSE\n[license-badge]: https://img.shields.io/github/license/joshuaavalon/docker-cloudflare.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshuaavalon%2Fdocker-cloudflare","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshuaavalon%2Fdocker-cloudflare","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshuaavalon%2Fdocker-cloudflare/lists"}