如何使用 `cloudflare-ddns`: 动态DNS服务基于Cloudflare的详细指南

如何使用 cloudflare-ddns: 动态DNS服务基于Cloudflare的详细指南

cloudflare-ddns🎉🌩️ Dynamic DNS (DDNS) service based on Cloudflare! Access your home network remotely via a custom domain name without a static IP!项目地址:https://gitcode.com/gh_mirrors/cl/cloudflare-ddns

一、项目目录结构及介绍

本项目基于GitHub仓库 timothymiller/cloudflare-ddns，它的核心目的是让你能够通过自定义域名远程访问家庭网络，即便你的IP地址不固定。以下是其大致的目录结构及其简介：

• 根目录:
  • README.md: 包含项目说明、安装步骤、配置指导和快速操作指南。
  • docker-compose.yml.example: 一个示例的Docker Compose配置文件，用于在Docker环境下运行项目。
  • config.json.example: 配置文件模板，展示如何设置Cloudflare的API令牌和区域信息。
  • cloudflare-ddns.py: 主要的Python脚本，执行动态DNS更新逻辑。

二、项目的启动文件介绍

Docker环境启动

• 主要文件: docker-compose.yml
  • 这个文件定义了如何在Docker环境中部署和服务。它包含了服务名称(cloudflare-ddns)、镜像(timothyjmiller/cloudflare-ddns:latest)以及必要的环境变量设置、卷映射等。
  • 示例配置中，security_opt确保容器不获取额外权限，保护系统安全；network_mode设为host以支持IPv6；环境变量如PUID和PGID用于调整文件所有权；并通过卷映射将本地配置文件挂载到容器内。

直接运行（非Docker）

对于不在Docker环境下的部署，重点在于cloudflare-ddns.py脚本，可通过Python 3.5+执行。这要求手动管理依赖并配置定时任务（如cron job）来定期同步DNS记录。

三、项目的配置文件介绍

• 配置文件: config.json
  • 此文件是项目的核心配置所在，需修改成你的实际Cloudflare API信息。
  • 关键字段包括但不限于:
    • email: 你的Cloudflare账户邮箱。
    • api_token: 从Cloudflare账户获取的API Token，用于自动化操作。
    • zones: 列表形式，每一项指定一个zone（域名）及其对应的DNS记录ID，用于更新解析。
  • 使用config.json.example作为起点，替换示例值为真实数据，并保持文件结构不变。

配置示例

假设您已下载或克隆了项目，在修改配置之前，应该备份.example文件并重命名或复制一份为config.json，然后在其中填入您的具体信息。

为了确保项目正确运行，请严格遵循文档中提供的指导，特别是在处理敏感信息（如API令牌）时，保证它们的安全存储。

---

此指南覆盖了基础的设置流程，但实际应用可能需要根据个人环境进行适当调整。务必参考项目最新的官方文档，特别是有关安全性、版本更新和故障排查的部分。

cloudflare-ddns🎉🌩️ Dynamic DNS (DDNS) service based on Cloudflare! Access your home network remotely via a custom domain name without a static IP!项目地址:https://gitcode.com/gh_mirrors/cl/cloudflare-ddns