timothyjmiller/cloudflare-ddns

🚀 Cloudflare DDNS

通过自定义域名远程访问家庭网络，无需静态IP！

一个轻量、🕵️ 隐私优先且 ⚡ 极速的多架构Docker镜像，适用于自托管项目。

🇺🇸 起源

此脚本为树莓派平台编写，旨在实现低成本、简单的自托管，以促进更去中心化的互联网。执行时，脚本会获取公网IPv4和IPv6地址，并为Cloudflare中的子域创建/更新DNS记录。同时会清理陈旧、重复的DNS记录以保持整洁。

📊 统计信息

⁉️ 隐私与安全性如何？

1. 使用零日志的外部IPv4和IPv6提供商
2. 基于Alpine Linux基础镜像
3. 仅通过Python软件基金会的requests模块使用HTTPS
4. Docker运行时环境
5. 开源可公开审计
6. 定期更新

🚦 快速开始

首先将示例配置文件复制为实际配置文件：

bash
cp config-example.json config.json

编辑config.json并替换为您自己的值。

🔑 认证方式

您可以选择使用较新的API令牌或传统的API密钥。

要生成新的API令牌，请前往您的Cloudflare个人资料并创建一个具有编辑DNS权限的令牌。然后在配置中替换以下值：

json
"authentication": {
  "api_token": "您的Cloudflare API令牌，需包含**编辑DNS**权限"
}

或者，您可以使用传统API密钥，设置以下相应值：

json
"authentication": {
  "api_key": {
    "api_key": "您的Cloudflare API密钥",
    "account_email": "您用于登录Cloudflare的电子邮件地址"
  }
}

其他参数说明

json
"zone_id": "将获取记录的区域ID。从您的仪表板进入区域，在概览选项卡下滚动，区域ID列在右侧栏中",
"subdomains": "要更新A记录（如适用，还有AAAA记录）的子域数组。重要！只需填写子域名，不要包含基础域名（例如foo或空字符串以更新基础域名）",
"proxied": false（默认为false。如果您希望获得Cloudflare的CDN/SSL benefits，请设为true，这通常会禁用SSH）

📠 在同一IP上托管多个域名？

当托管多个指向同一IP的域名时（如使用Traefik的情况），您可以通过定义一个A和AAAA记录'ddns.example.com'指向将由本DDNS脚本更新的服务器IP来简化操作。为每个子域创建一个指向'ddns.example.com'的CNAME记录。这样，每次向站点添加新子域时，您无需手动修改脚本配置！

🐳 使用Docker Compose部署

预编译镜像可通过DockerHub上的官方容器获取：https://hub.docker.com/r/timothyjmiller/cloudflare-ddns%E3%80%82

修改docker-compose.yml的volumes部分中config.json的主机文件路径：

yaml
version: "3.7"
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:
      - /您的/路径/此处/config.json:/config.json
    restart: unless-stopped

⚠️ IPv6注意事项

Docker需要将network_mode设置为host才能访问IPv6公网地址。

🏃‍♂️ 运行

从项目根目录执行：

bash
docker-compose up -d

从源码构建

创建包含您生产凭据的config.json文件。

💖 请注意

可选的docker-build-all.sh脚本需要启用Docker实验性功能。

Docker Hub支持多架构构建的实验性功能。其官方博客文章详细说明了如何使用Mac和Windows版本的Docker Desktop进行构建。

1. 选择构建平台

• 多架构（实验性）：docker-build-all.sh

• 默认Linux/amd64：docker-build.sh

2. 赋予bash脚本执行权限：

bash
sudo chmod +x ./docker-build.sh

bash
sudo chmod +x ./docker-build-all.sh

3. 在项目根目录运行docker-build.sh脚本：

本地开发推荐：

bash
./docker-build.sh

生产环境推荐：

bash
./docker-build-all.sh

运行本地编译版本

bash
docker run -d timothyjmiller/cloudflare_ddns:latest

🐧 （传统）Linux + cron 说明（所有发行版）

🏃 运行

此脚本需要Python 3.5+，最新版本的Raspbian已预装。下载/克隆此仓库并通过运行chmod +x ./start-sync.sh为项目的bash脚本赋予权限。现在您可以执行./start-sync.sh，它将设置虚拟环境、拉取依赖项并运行脚本。

1. 将cloudflare-ddns文件夹上传到您的主目录/home/您的用户名/

2. 在终端中运行以下命令：

bash
crontab -e

3. 添加以下行以每15分钟同步一次DNS记录：

bash
*/15 * * * * /home/您的用户名/cloudflare-ddns/start-sync.sh

许可证

本模板采用GNU通用公共许可证第3版（GPLv3）授权。

作者

Timothy Miller

https://github.com/timothymiller

查看我的个人网站 💻