aiweisir / ddns

:triangular_flag_on_post: 自动更新域名解析到本机IP(支持dnspod,阿里DNS,CloudFlare,DNSCOM...)

DDNS

自动更新DNS解析 到本机IP地址,支持 ipv4和ipv6 以 本地(内网)IP 和 公网IP。 代理模式,支持自动创建域名记录。

Build Details

• Linux Python (2和3):
• Windows Python3.7:
• Windows Python2.7:
• Mac OSX Python3.7:
• Mac OSX Python2.7:

---

Features

• 兼容和跨平台:
  • 可执行文件(无需python环境)
  • 多系统兼容
  • python2和python3支持
  • PIP安装
• 域名支持:
  • 多个域名支持
  • 多级域名解析
  • 自动创建新记录
• IP类型:
  • 内网IP
  • 公网IP
  • ipv6支持
  • 正则选取支持(@rufengsuixing)
• 网络代理:
  • http代理支持
  • 多代理自动切换
• 服务商支持:
  • DNSPOD
  • 阿里DNS
  • DNS.COM(@loftor-git)
  • DNSPOD国际版
  • CloudFlare(@tongyifan)
• 其他:
  • 可设置定时任务
  • 本地文件缓存(减少API请求)

使用

① 安装

根据需要选择一种方式: 二进制版,pip版,或者源码运行

• pip安装(需要pip或easy_install) beta

  1. 安装ddns: pip install ddns 或 easy_install ddns
  2. 运行: ddns

• 二进制版(单文件,无需python)

  • Windows ddns.exe
  • Linux (仅Ubuntu测试) ddns
  • Mac OSX ddns-oxs

• 源码运行(无任何依赖, 需python环境)

  1. clone 或者下载此仓库并解压
  2. 运行./run.py (widnows 双击run.bat或者运行python run.py)

② 快速配置

1. 申请 api token,填写到对应的id和token字段:

   • DNSPOD(国内版)创建token
   • 阿里云accesskey
   • DNS.COM API Key/Secret
   • DNSPOD(国际版)
   • CloudFlare API Key

2. 修改配置文件,ipv4和ipv6字段，为待更新的域名,详细参照配置说明

详细配置

config.json 配置文件

• 首次运行会自动生成一个模板配置文件
• 可以使用 -c使用指定的配置文件 (默认读取当前目录的 config.json)
• 推荐使用vscode等支持JsonSchema的编辑器编辑配置文件

ddns -c path/to/config.json
# 或者源码运行
python run.py -c /path/to/config.json 

配置参数表

key	type	required	default	description	tips
id	string	√	无	api访问ID	cloudflare为邮箱
token	string	√	无	api授权token	也叫secret key, 反馈粘贴时删除
dns	string	No	"dnspod"	dns 服务商	阿里alidns, dns.com为dnscom, DNSPOD国际版dnspod_com
ipv4	array	No	[]	ipv4 域名列表	为[]时,不会获取和更新IPv4地址
ipv6	array	No	[]	ipv6 域名列表	为[]时,不会获取和更新IPv6地址
index4	string|int	No	"default"	ipv4 获取方式	可设置网卡,内网,公网,正则等方式
index6	string|int	No	"default"	ipv6 获取方式	可设置网卡,内网,公网,正则等方式
proxy	string	No	无	http代理;分割	多代理逐个尝试直到成功,DIRECT为直连
debug	bool	No	false	是否开启调试	运行异常时,打开调试输出,方便诊断错误
cache	bool	No	true	是否缓存记录	正常情况打开避免频繁更新

index4和index6参数说明

• 数字(0,1,2,3等): 第i个网卡ip
• 正则表达(如"192.*"): 提取ifconfig/ipconfig中与之匹配的首个IP地址,注意json转义(\要写成\\)
  • "192.*"表示192开头的所有ip
  • 如果想匹配10.00.xxxx应该写成"10\\.00\\..*"("\\"json转义成\)
• 字符串"default"(或者无此项): 系统访问外网默认IP
• 字符串"public": 使用公网ip(使用公网API查询)
• false: 强制禁止更新ipv4或ipv6的DNS解析

配置示例

{
	"$schema": "https://ddns.newfuture.cc/schema/v2.json",
	"id": "12345",
	"token": "mytokenkey",
	"dns": "dnspod 或 dnspod_com 或 alidns 或 dnscom 或 cloudflare",
	"ipv4": [
		"ddns.newfuture.cc",
		"ipv4.ddns.newfuture.cc"
	],
	"ipv6": [
		"ddns.newfuture.cc",
		"ipv6.ddns.newfuture.cc"
	],
	"index4": 0,
	"index6": "public",
	"proxy": "127.0.0.1:1080;DIRECT",
	"debug": false
}

定时任务

可以通过脚本设置定时任务(默认每5分钟检查一次ip,自动更新)

windows

• [推荐]以系统身份运行,右键"以管理员身份运行"task.bat(或者在管理员命令行中运行)
• 以当前用户身份运行定时任务,双击或者运行task.bat (执行时会闪黑框)

linux

运行 sudo ./task.sh

FAQ

Windows Server [SSL: CERTIFICATE_VERIFY_FAILED]

Windows Server 默认安全策略会禁止任何未添加的信任ssl证书,可手动添加一下对应的证书 #56

使用系统自带的IE浏览器访问一次对应的API即可

• alidns打开: https://alidns.aliyuncs.com
• cloudflare打开: https://api.cloudflare.com
• dns.com打开: https://www.dns.com
• dnspod.cn打开: https://dnsapi.cn
• dnspod国际版: https://api.dnspod.com

问题排查反馈

1. 先确认排查是否是系统/网络环境问题
2. 在issues中搜索是否有类似问题
3. 前两者均无法解决或者确定是bug,在此新建issue
   • 开启debug配置
   • 附上这些内容 运行版本和方式,系统环境, 出错日志,去掉id/token的配置文件
   • 源码运行注明使用的python环境