cloudflare-ddns

cloudflare-ddns

基于Cloudflare的开源动态DNS更新工具

Cloudflare DDNS是一款开源的动态DNS更新工具,利用Cloudflare API实现IP地址自动更新。支持多域名、子域名、IPv4和IPv6,无需静态IP即可远程访问家庭网络。具有配置简单、运行高效、跨平台兼容等特点,支持Docker部署。该项目致力于推动互联网去中心化,为用户提供灵活可靠的域名解析服务。

CloudflareDDNS域名DockerIPv6Github开源项目
<p align="center"><a href="https://timknowsbest.com/free-dynamic-dns" target="_blank" rel="noopener noreferrer"><img width="1024" src="feature-graphic.jpg" alt="Cloudflare DDNS"/></a></p>

🚀 Cloudflare DDNS

Access your home network remotely via a custom domain name without a static IP!

⚡ Efficiency

  • ❤️ Easy config. List your domains and you're done.
  • 🔁 The Python runtime will re-use existing HTTP connections.
  • 🗃️ Cloudflare API responses are cached to reduce API usage.
  • 🤏 The Docker image is small and efficient.
  • 0️⃣ Zero dependencies.
  • 💪 Supports all platforms.
  • 🏠 Enables low cost self hosting to promote a more decentralized internet.
  • 🔒 Zero-log IP provider (cdn-cgi/trace)
  • 👐 GPL-3.0 License. Open source for open audits.

💯 Complete Support of Domain Names, Subdomains, IPv4 & IPv6, and Load Balancing

  • 🌐 Supports multiple domains (zones) on the same IP.
  • 📠 Supports multiple subdomains on the same IP.
  • 📡 IPv4 and IPv6 support.
  • 🌍 Supports all Cloudflare regions.
  • ⚖️ Supports Cloudflare Load Balancing.
  • 🇺🇸 Made in the U.S.A.

📊 Stats

SizeDownloadsDiscord
cloudflare-ddns docker image sizeTotal DockerHub pullsOfficial Discord Server

🚦 Getting Started

First copy the example configuration file into the real one.

cp config-example.json config.json

Edit config.json and replace the values with your own.

🔑 Authentication methods

You can choose to use either the newer API tokens, or the traditional API keys

To generate a new API tokens, go to your Cloudflare Profile and create a token capable of Edit DNS. Then replace the value in

"authentication": "api_token": "Your cloudflare API token, including the capability of **Edit DNS**"

Alternatively, you can use the traditional API keys by setting appropriate values for:

"authentication": "api_key": "api_key": "Your cloudflare API Key", "account_email": "The email address you use to sign in to cloudflare",

📍 Enable or disable IPv4 or IPv6

Some ISP provided modems only allow port forwarding over IPv4 or IPv6. In this case, you would want to disable any interface not accessible via port forward.

"a": true, "aaaa": true

🎛️ Other values explained

"zone_id": "The ID of the zone that will get the records. From your dashboard click into the zone. Under the overview tab, scroll down and the zone ID is listed in the right rail", "subdomains": "Array of subdomains you want to update the A & where applicable, AAAA records. IMPORTANT! Only write subdomain name. Do not include the base domain name. (e.g. foo or an empty string to update the base domain)", "proxied": "Defaults to false. Make it true if you want CDN/SSL benefits from cloudflare. This usually disables SSH)", "ttl": "Defaults to 300 seconds. Longer TTLs speed up DNS lookups by increasing the chance of cached results, but a longer TTL also means that updates to your records take longer to go into effect. You can choose a TTL between 30 seconds and 1 day. For more information, see [Cloudflare's TTL documentation](https://developers.cloudflare.com/dns/manage-dns-records/reference/ttl/)",

📠 Hosting multiple subdomains on the same IP?

This script can be used to update multiple subdomains on the same IP address.

For example, if you have a domain example.com and you want to host additional subdomains at foo.example.com and bar.example.com on the same IP address, you can use this script to update the DNS records for all subdomains.

⚠️ Note

Please remove the comments after // in the below example. They are only there to explain the config.

Do not include the base domain name in your subdomains config. Do not use the FQDN.

👉 Example 🚀

{ "cloudflare": [ { "authentication": { "api_token": "api_token_here", // Either api_token or api_key "api_key": { "api_key": "api_key_here", "account_email": "your_email_here" } }, "zone_id": "your_zone_id_here", "subdomains": [ { "name": "", // Root domain (example.com) "proxied": true }, { "name": "foo", // (foo.example.com) "proxied": true }, { "name": "bar", // (bar.example.com) "proxied": true } ] } ], "a": true, "aaaa": true, "purgeUnknownRecords": false, "ttl": 300 }

🌐 Hosting multiple domains (zones) on the same IP?

You can handle ddns for multiple domains (cloudflare zones) using the same docker container by duplicating your configs inside the cloudflare: [] key within config.json like below:

⚠️ Note:

If you are using API Tokens, make sure the token used supports editing your zone ID.

{ "cloudflare": [ { "authentication": { "api_token": "api_token_here", "api_key": { "api_key": "api_key_here", "account_email": "your_email_here" } }, "zone_id": "your_first_zone_id_here", "subdomains": [ { "name": "", "proxied": false }, { "name": "remove_or_replace_with_your_subdomain", "proxied": false } ] }, { "authentication": { "api_token": "api_token_here", "api_key": { "api_key": "api_key_here", "account_email": "your_email_here" } }, "zone_id": "your_second_zone_id_here", "subdomains": [ { "name": "", "proxied": false }, { "name": "remove_or_replace_with_your_subdomain", "proxied": false } ] } ], "a": true, "aaaa": true, "purgeUnknownRecords": false }

⚖️ Load Balancing

If you have multiple IP addresses and want to load balance between them, you can use the loadBalancing option. This will create a CNAME record for each subdomain that points to the subdomain with the lowest IP address.

📜 Example config to support load balancing

{ "cloudflare": [ { "authentication": { "api_token": "api_token_here", "api_key": { "api_key": "api_key_here", "account_email": "your_email_here" } }, "zone_id": "your_zone_id_here", "subdomains": [ { "name": "", "proxied": false }, { "name": "remove_or_replace_with_your_subdomain", "proxied": false } ] } ],{ "cloudflare": [ { "authentication": { "api_token": "api_token_here", "api_key": { "api_key": "api_key_here", "account_email": "your_email_here" } }, "zone_id": "your_zone_id_here", "subdomains": [ { "name": "", "proxied": false }, { "name": "remove_or_replace_with_your_subdomain", "proxied": false } ] } ], "load_balancer": [ { "authentication": { "api_token": "api_token_here", "api_key": { "api_key": "api_key_here", "account_email": "your_email_here" } }, "pool_id": "your_pool_id_here", "origin": "your_origin_name_here" } ], "a": true, "aaaa": true, "purgeUnknownRecords": false, "ttl": 300 }

🧹 Optional features

purgeUnknownRecords removes stale DNS records from Cloudflare. This is useful if you have a dynamic DNS record that you no longer want to use. If you have a dynamic DNS record that you no longer want to use, you can set purgeUnknownRecords to true and the script will remove the stale DNS record from Cloudflare.

🐳 Deploy with Docker Compose

Pre-compiled images are available via the official docker container on DockerHub.

Modify the host file path of config.json inside the volumes section of docker-compose.yml.

version: '3.9' services: cloudflare-ddns: image: timothyjmiller/cloudflare-ddns:latest container_name: cloudflare-ddns security_opt: - no-new-privileges:true network_mode: 'host' environment: - PUID=1000 - PGID=1000 volumes: - /YOUR/PATH/HERE/config.json:/config.json restart: unless-stopped

⚠️ IPv6

Docker requires network_mode be set to host in order to access the IPv6 public address.

🏃‍♂️ Running

From the project root directory

docker-compose up -d

🐋 Kubernetes

Create config File

cp ../../config-example.json config.json

Edit config.jsonon (vim, nvim, nano... )

${EDITOR} config.json

Create config file as Secret.

kubectl create secret generic config-cloudflare-ddns --from-file=config.json --dry-run=client -oyaml -n ddns > config-cloudflare-ddns-Secret.yaml

apply this secret

kubectl apply -f config-cloudflare-ddns-Secret.yaml rm config.json # recomended Just keep de secret on Kubernetes Cluster

apply this Deployment

kubectl apply -f cloudflare-ddns-Deployment.yaml

🐧 Deploy with Linux + Cron

🏃 Running (all distros)

This script requires Python 3.5+, which comes preinstalled on the latest version of Raspbian. Download/clone this repo and give permission to the project's bash script by running chmod +x ./start-sync.sh. Now you can execute ./start-sync.sh, which will set up a virtualenv, pull in any dependencies, and fire the script.

  1. Upload the cloudflare-ddns folder to your home directory /home/your_username_here/

  2. Run the following code in terminal

crontab -e
  1. Add the following lines to sync your DNS records every 15 minutes
*/15 * * * * /home/your_username_here/cloudflare-ddns/start-sync.sh

Building from source

Create a config.json file with your production credentials.

💖 Please Note

The optional docker-build-all.sh script requires Docker experimental support to be enabled.

Docker Hub has experimental support for multi-architecture builds. Their official blog post specifies easy instructions for building with Mac and Windows versions of Docker Desktop.

  1. Choose build platform
  • Multi-architecture (experimental) docker-build-all.sh

  • Linux/amd64 by default docker-build.sh

  1. Give your bash script permission to execute.
sudo chmod +x ./docker-build.sh
sudo chmod +x ./docker-build-all.sh
  1. At project root, run the docker-build.sh script.

Recommended for local development

./docker-build.sh

Recommended for production

./docker-build-all.sh

Run the locally compiled version

docker run -d timothyjmiller/cloudflare_ddns:latest

Supported Platforms

📜 Helpful links

License

This Template is licensed under the GNU General Public License, version 3 (GPLv3).

Author

Timothy Miller

View my GitHub profile 💡

[View my personal website

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多