jkbys/cloudflare-ddns-multi

cloudflare-ddns-multi

!https://github.com/jkbys/cloudflare-ddns-multi/workflows/Build%20and%20push%20Docker%20image/badge.svg

Cloudflare DDNS多区域/记录更新器 - Docker微型镜像 / Shell脚本

这是一个用于将CloudFlare DNS用作动态DNS的小型Docker镜像。它会定期获取全局IP地址（IPv4和IPv6），并将其设置到CloudFlare DNS上多个区域的A记录和AAAA记录中。您也可以不使用Docker，而是通过cron等程序运行此脚本。

核心功能与特性

• 微型Docker镜像
  该镜像的下载大小（压缩后）小于4MB。

• 多架构支持
  支持amd64、386、arm64、arm/v7、arm/v6架构的Docker镜像。此外，即使在其他架构上，也可以不使用Docker直接运行此Shell脚本。

• 可通过BusyBox执行的Shell脚本
  设计用于BusyBox中的shell，当然也兼容Bash，同时支持Debian和Ubuntu采用的/bin/sh（dash）。

• 多区域和多记录支持
  可更新多个区域中包含的多个记录。

• IPv4和IPv6双支持
  不仅支持IPv4地址，还支持IPv6地址。

• 可靠的全局IP地址获取
  为避免设置错误的全局IP地址，会从多个来源获取地址并在处理前确认一致性。

• 可自定义IP地址获取方式
  默认从外部HTTPS服务器获取IP地址，也可配置为从外部DNS服务器获取，或设置自定义命令获取。还可针对每条记录指定固定IP地址或独特的IP获取命令。

• 通过缓存减少Cloudflare API调用次数
  缓存每条记录的配置状态，减少API调用次数。除非全局IP地址更改，否则在缓存过期前不会进行API访问。缓存有效期可在配置文件中修改（默认1小时）。

• 可配置事件触发外部命令
  可设置在记录创建、更新或删除时执行任意命令。例如，通过执行curl命令向Webhook URL发送POST数据以通知智能手机。

环境要求

• 若使用Docker镜像，需安装Docker。
• 若不使用Docker直接运行脚本，需安装curl和jq命令。

使用方法

基本步骤

1. 准备Docker运行环境。

2. 在CloudFlare中为每个区域创建API_TOKEN，权限设置为编辑区域DNS。详细说明参见：
   [***]

3. 创建任意目录，并在其中创建config.json文件。由于文件包含Cloudflare访问令牌或密钥，需设置权限确保其他用户无法读取：

   bash
   $ mkdir /some/where
   $ cd /some/where
   $ touch config.json
   $ chmod 600 config.json
   

4. 编辑config.json。以下是示例，需描述区域名称（域名）、API令牌和记录名称。若要指定根域名，记录名称填写@：

   json
   {
     "zones": [
       {
         "name": "example.com",
         "api_token": "此处填写您的API令牌",
         "records": [
           {
             "name": "@",
             "types": ["A"],
             "proxied": true,
             "create": true
           },
           {
             "name": "home",
             "types": ["A"],
             "proxied": false,
             "create": true
           }
         ]
       }
     ]
   }
   

   完整配置文件示例见本文档末尾。

5. 执行以下命令启动容器：

   bash
   $ docker run -t -d --name cloudflare-ddns-multi -v $PWD/config.json:/etc/cloudflare-ddns-multi/config.json jkbys/cloudflare-ddns-multi
   

6. 使用以下命令查看日志，若有错误请检查配置：

   bash
   $ docker logs cloudflare-ddns-multi
   

以上快速方法仅更新A记录（IPv4地址），更新AAAA记录（IPv6地址）的方法见下文。

Docker Compose配置

也可使用Docker Compose创建和运行容器。在与config.json相同目录下创建docker-compose.yml，示例如下：

yaml
version: '3'

services:
  cloudflare-ddns-multi:
    image: jkbys/cloudflare-ddns-multi
    restart: always
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - ./config.json:/etc/cloudflare-ddns-multi/config.json:ro

IPv6（AAAA记录）配置

若Docker主机可通过IPv6地址访问互联网，可将全局IPv6地址设置到AAAA记录。以下是config.json配置示例：

json
{
  "interval_sec": 300,
  "cache_timeout_sec": 3600,
  "enable_ipv6": true,
  "zones": [
    {
      "name": "example.com",
      "api_token": "此处填写您的API令牌",
      "records": [
        {
          "name": "@",
          "types": ["A", "AAAA"],
          "proxied": true,
          "create": true
        },
        {
          "name": "home",
          "types": ["A", "AAAA"],
          "proxied": false,
          "create": true
        },
        {
          "name": "home-v4",
          "types": ["A"],
          "proxied": false,
          "create": true
        },
        {
          "name": "home-v6",
          "types": ["AAAA"],
          "proxied": false,
          "create": true
        }
      ]
    }
  ]
}

如示例所示，在需要设置IPv6地址的记录的"types"中添加"AAAA"即可。示例中，example.com和home.example.com同时设置IPv4和IPv6地址，home-v4.example.com仅设置IPv4，home-v6.example.com仅设置IPv6。

要配置IPv6，Docker容器必须能通过IPv6与互联网通信。最简单的方法是使用主机网络模式，在执行docker run命令时指定"--net=host"选项：

bash
$ docker run -t -d --name cloudflare-ddns-multi -v $PWD/config.json:/etc/cloudflare-ddns-multi/config.json --net=host jkbys/cloudflare-ddns-multi

Docker Compose中指定主机网络模式的示例：

yaml
version: '3'

services:
  cloudflare-ddns-multi:
    image: jkbys/cloudflare-ddns-multi
    restart: always
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - ./config.json:/etc/cloudflare-ddns-multi/config.json:ro
    network_mode: "host"

若要在默认桥接网络模式下使用IPv6，需启用Docker守护进程的IPv6支持，并正确配置路由等设置。

事件触发命令执行

可配置在各事件发生时执行命令。例如，当DNS记录更新时向Webhook URL发送POST请求。配置方法详见本文档末尾的完整配置文件示例。

不使用Docker运行

若不想使用Docker，可从https://github.com/jkbys/cloudflare-ddns-multi%E8%8E%B7%E5%8F%96cloudflare-ddns-multi.sh%E6%96%87%E4%BB%B6%EF%BC%8C%E6%89%A7%E8%A1%8C%E5%A6%82%E4%B8%8B%E5%91%BD%E4%BB%A4%EF%BC%9A

bash
$ sh cloudflare-ddns-multi.sh config.json

配置文件按以下顺序查找，加载第一个找到的文件：

• 第一个参数
• .config/cloudflare-ddns-multi/config.json
• /etc/cloudflare-ddns-multi/config.json

完整配置文件示例

以下是包含注释的完整配置文件示例（以"_"开头的项为说明文字）：

json
{
  "interval_sec": 300,
  "interval_after_fail_sec": 1800,
  "cache_timeout_sec": 3600,
  "enable_ipv4": true,
  "enable_ipv6": true,
  "_ipv4_ipv6_command_type": "'curl'、'drill'或'dig'，根据需要在容器或系统中安装drill或dig包",
  "ipv4_command_type": "curl",
  "ipv6_command_type": "curl",
  "_oneshot": "若为true，运行一次后退出",
  "oneshot": false,
  "zones": [
    {
      "name": "example.com",
      "api_token": "此处填写您的令牌",
      "records": [
        {
          "name": "@",
          "_types": "记录类型，A或AAAA",
          "types": ["A", "AAAA"],
          "proxied": false,
          "_ttl": "1（默认）表示自动",
          "ttl": 1,
          "_create": "若在Cloudflare上不存在，是否自动创建",
          "create": true
        },
        {
          "name": "fixed",
          "types": ["A", "AAAA"],
          "proxied": false,
          "fixed_ipv4": "203.0.113.119",
          "fixed_ipv6": "2001:db8::c7",
          "create": true
        },
        {
          "name": "command",
          "types": ["A", "AAAA"],
          "proxied": false,
          "_command_ipv4": "返回IPv4地址的命令",
          "command_ipv4": "/usr/local/bin/get-ipv4-address.sh",
          "_command_ipv6": "返回IPv6地址的命令",
          "command_ipv6": "/usr/local/bin/get-ipv6-address.sh",
          "create": true
        }
      ]
    },
    {
      "name": "example.net",
      "_email_and_api_key": "用于身份验证的email和api_key（替代api_token）",
      "email": "此处填写您的***",
      "api_key": "此处填写您的密钥",
      "records": [
        {
          "name": "tmp",
          "types": ["A", "AAAA"],
          "proxied": true,
          "create": true,
          "_remove_on_exit": "若为true，退出时删除此记录",
          "remove_on_exit": true
        }
      ]
    }
  ],
  "_command_timeout": "每个命令的超时时间（秒）",
  "command_timeout": 30,
  "_commands": "命令字符串中的"%MESSAGE%"会被替换为处理内容或错误信息",
  "commands": {
    "_on_error": "发生错误时执行的命令",
    "on_error": [
      "command1",
      "command2"
    ],
    "_on_update": "记录更新时执行的命令",
    "on_update": [
      "command1"
    ],
    "_on_create": "记录创建时执行的命令",
    "on_create": [
      "command1"
    ],
    "_on_remove": "记录删除时执行的命令",
    "on_remove": [
      "command1"
    ],
    "_on_address_check": "检查全局地址时执行的命令",
    "on_address_check": [
      "command1"
    ],
    "_on_address_change": "全局地址变更时执行的命令",
    "on_address_change": [
      "command1"
    ],
    "_on_launch": "脚本启动时执行的命令",
    "on_launch": [
      "command1"
    ],
    "_on_exit": "脚本退出时执行的命令",
    "on_exit": [
      "command1"
    ]
  }
}