ulikoehler/flaredns

FlareDNS

镜像概述和主要用途

FlareDNS是一个Cloudflare动态DNS更新客户端，用于克服现有客户端的灵活性限制。目前处于测试阶段，已在部分系统上进行验证。它从IPify获取外部IP地址信息，可同时更新A（IPv4）和AAAA（IPv6）记录。

该工具专为多服务器共享同一IPv4地址但拥有独立IPv6地址的配置场景设计，支持运行多个实例以适应多DNS更新需求。FlareDNS具有简单、可靠、透明的特点，代码库轻量（单文件），便于根据特殊需求进行调整（如基于主机公网IP计算多个AAAA记录、查询DHCP租约表获取IP等）。

注意：FlareDNS仅在域名使用Cloudflare Nameservers时有效。Cloudflare提供免费服务且性能优异，其DNS最小TTL为2分钟（在多数实际场景中影响不大）。

核心功能和特性

• 双协议支持：可同时更新A（IPv4）和AAAA（IPv6）记录
• 灵活性：适用于多服务器共享IPv4但独立IPv6的复杂网络环境
• 轻量透明：单文件代码库，易于理解和自定义修改
• 可靠性：定期检查并更新DNS记录，确保解析准确性
• 简单配置：通过命令行参数快速配置，支持定时更新

使用场景和适用范围

• 多服务器共享同一IPv4地址但需要独立IPv6地址的网络环境
• 需要同时维护IPv4和IPv6动态DNS记录的场景
• 需自定义IP获取逻辑（如虚拟服务器IP计算、DHCP租约查询等）的特殊配置
• 希望使用轻量级工具替代复杂DynDNS客户端的用户

前提条件

• 域名需配置Cloudflare Nameservers，并为（子）域名创建相应记录（如dyndns.mydomain.com）
• 需创建Cloudflare全局API密钥（暂不支持域名专用API令牌，欢迎提交PR）
• 运行FlareDNS的系统需具备互联网访问能力（用于获取当前IP地址）
• 环境需安装Python3或Docker

详细使用方法和配置说明

无Docker方式使用

1. 安装依赖：

   sh
   pip3 install -r requirements.txt
   

2. 运行命令（每60秒检查并更新DNS）：

   sh
   python3 update-dyndns.py --email cloudflare-email@mydomain.com --api-key c6c94fd52184dcc783c5ec1d5089ec354b9d9 --hostname dyndns.mydomain.com --ipv4 --ipv6 --interval 60
   

3. 命令行参数说明：

   sh
   $ python update-dyndns.py --help
   usage: update-dyndns.py [-h] -e EMAIL -k API_KEY -n HOSTNAME [-4] [-6] [-d] [-i INTERVAL]
   
   optional arguments:
     -h, --help            显示帮助信息并退出
     -e EMAIL, --email EMAIL  Cloudflare登录邮箱
     -k API_KEY, --api-key API_KEY  Cloudflare全局API密钥（注意：域名专用API令牌无效！）
     -n HOSTNAME, --hostname HOSTNAME  需更新的主机名，如mydyndns.mydomain.com
     -4, --ipv4            使用当前IPv4更新A记录
     -6, --ipv6            使用当前IPv6更新AAAA记录
     -d, --debug           启用额外调试日志
     -i INTERVAL, --interval INTERVAL  更新间隔（秒），设为0则仅更新一次（实际为更新尝试后的睡眠时间）
   

Docker方式使用

FlareDNS提供预构建Docker镜像，可在https://hub.docker.com/repository/docker/ulikoehler/flaredns%E8%8E%B7%E5%8F%96%EF%BC%8C%E6%97%A0%E9%9C%80%E5%AE%89%E8%A3%85Python%E5%8F%8A%E4%BE%9D%E8%B5%96%E5%8D%B3%E5%8F%AF%E5%9C%A8%E4%B8%80%E8%87%B4%E7%8E%AF%E5%A2%83%E4%B8%AD%E8%BF%90%E8%A1%8C%E3%80%82

Docker运行示例：

sh
docker run -ti --network host --rm --name FlareDNS-dyndns.mydomain.com docker.xuanyuan.run/ulikoehler/flaredns:latest python update-dyndns.py --email cloudflare-email@mydomain.com --api-key c6c94fd52184dcc783c5ec1d5089ec354b9d9 --hostname dyndns.mydomain.com --ipv4 --ipv6 --interval 60

注意：--network host参数可确保容器在主机启用IPv6时支持IPv6。

安装为systemd服务（实现开机自启）

1. 克隆仓库（默认路径/opt/FlareDNS，可在.service文件中修改）：

   sh
   git clone https://github.com/ulikoehler/FlareDNS.git /opt/FlareDNS
   

2. 安装服务文件：

   • Docker版本（无依赖）：

     sh
     sudo cp /opt/FlareDNS/examples/UpdateFlareDNSDocker.service /etc/systemd/system/UpdateFlareDNS.service
     

   • 非Docker版本（需全局安装依赖pip install -r requirements.txt）：

     sh
     sudo cp /opt/FlareDNS/examples/UpdateFlareDNSNoDocker.service /etc/systemd/system/UpdateFlareDNS.service
     

3. 编辑服务文件：
   务必修改/etc/systemd/system/UpdateFlareDNS.service中的参数（如***、API密钥、主机名等）。

4. 启用并启动服务：

   sh
   sudo systemctl enable --now UpdateFlareDNS
   

5. 查看日志：

   sh
   sudo journalctl -xfu UpdateFlareDNS