Home Explore Help
Register Sign In
Apq
/
DDNS
mirror of https://github.com/NewFuture/DDNS.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 0eea4c6850
Branches Tags
DDNS
/
doc
/
cli.md

cli.md 16 KB
History Raw

DDNS 命令行参数参考

本文档详细说明DDNS工具的命令行参数用法。命令行参数可用于覆盖配置文件和环境变量中的设置，具有最高优先级。

基本用法

可通过-h 查看参数列表

# ddns [选项]
ddns -h

或者使用Python：

# python3 -m ddns [选项]
python3 -m ddns -h

参数列表

参数 类型 描述 示例
-h, --help 标志 显示帮助信息并退出 --help
-v, --version 标志 显示版本信息并退出 --version
-c, --config 字符串 指定配置文件路径 --config config.json
--new-config 标志/字符串 生成新的配置文件（可指定路径） --new-config
--new-config=config.json
--debug 标志 开启调试模式 --debug
--dns 选择项 DNS服务提供商包括：
51dns, alidns, aliesa, callback, cloudflare,
debug, dnscom, dnspod_com, dnspod, he,
huaweidns, noip, tencentcloud		 --dns cloudflare
--endpoint 字符串 自定义API 端点 URL(更换服务节点) --endpoint https://api.private.com
--id 字符串 API 访问 ID、邮箱或 Access ID --id [email protected]
--token 字符串 API 授权令牌或密钥（Secret Key） --token abcdef123456
--ipv4 字符串列表 IPv4 域名列表，多个域名重复使用参数 --ipv4 test.com --ipv4 4.test.com
--ipv6 字符串列表 IPv6 域名列表，多个域名重复使用参数 --ipv6 test.com
--index4 列表 IPv4 地址获取方式，支持：数字, default, public,
url:, regex:, cmd:, shell:		 --index4 public
--index4 "regex:192\\.168\\..*"
--index6 列表 IPv6 地址获取方式，支持：数字, default, public,
url:, regex:, cmd:, shell:		 --index6 0
--index6 public
--ttl 整数 DNS 解析记录的 TTL 时间（秒） --ttl 600
--line 字符串 解析线路(部分provider支持)，如 ISP线路 --line 电信
--line telecom
--proxy 字符串列表 HTTP 代理设置，可用格式：IP:端口 或 DIRECT --proxy 127.0.0.1:1080 --proxy DIRECT
--cache 标志/字符串 是否启用缓存或自定义缓存路径 --cache
--cache=/path/to/cache
--no-cache 标志 禁用缓存（等效于 --cache=false） --no-cache
--ssl 字符串 SSL 证书验证方式，支持：true, false, auto, 文件路径 --ssl false
--ssl=/path/to/ca-certs.crt
--no-ssl 标志 禁用 SSL 验证（等效于 --ssl=false） --no-ssl
--log_file 字符串 日志文件路径，不指定则输出到控制台 --log_file=/var/log/ddns.log
--log_level 字符串 日志级别：DEBUG, INFO, WARNING, ERROR, CRITICAL --log_level=ERROR
--log_format 字符串 日志格式字符串（logging模块格式） --log_format="%(asctime)s:%(message)s"
--log_datefmt 字符串 日志日期时间格式 --log_datefmt="%Y-%m-%d %H:%M:%S"

注意: 其中--debug, --new-config, --no-cache, --no-ssl, --help, --version为命令行独有参数。

DNS服务配置参数

--dns DNS_PROVIDER

DNS服务提供商详细列表。

--id ID

API访问ID或用户标识。

  • 必需: 是（部分DNS服务商可选）
  • 说明:
    • Cloudflare: 填写邮箱地址（使用Token时可留空）
    • HE.net: 可留空
    • 华为云: 填写Access Key ID (AK)
    • Callback: 填写回调URL地址（支持变量替换）
    • 其他服务商: 根据各自要求填写ID

--token TOKEN

API授权令牌或密钥。

  • 必需: 是
  • 说明:
    • 大部分平台: API密钥或Secret Key
    • Callback: POST请求参数（JSON字符串），为空时使用GET请求
    • 请妥善保管敏感信息

Callback配置示例:

# GET方式回调
ddns --dns callback --id "https://api.example.com/ddns?domain=__DOMAIN__&ip=__IP__" --token ""

# POST方式回调
ddns --dns callback --id "https://api.example.com/ddns" --token '{"api_key": "your_key", "domain": "__DOMAIN__"}'

详细配置请参考：Callback Provider 配置文档

域名配置参数

--ipv4 [DOMAIN...]

需要更新IPv4记录的域名列表。

  • 默认值: []（不更新IPv4地址）
  • 示例:
    • --ipv4 example.com (单个域名)
    • --ipv4 example.com --ipv4 subdomain.example.com (多个域名)

--ipv6 [DOMAIN...]

需要更新IPv6记录的域名列表。

  • 默认值: []（不更新IPv6地址）
  • 示例:
    • --ipv6 example.com (单个域名)
    • --ipv6 example.com --ipv6 ipv6.example.com (多个域名)

IP获取方式参数

--index4 [Rule...]

IPv4地址获取方式。

  • 默认值: default
  • 可选值:
    • 数字（0，1，2...）: 第N个网卡IP
    • default: 系统访问外网默认IP
    • public: 使用公网IP（通过API查询）
    • url:{URL}: 从指定URL获取IP
    • regex:{PATTERN}: 使用正则表达式匹配本地网络配置中的IP
    • cmd:{COMMAND}: 执行指定命令并使用其输出作为IP
    • shell:{COMMAND}: 使用系统shell运行命令并使用其输出作为IP
  • 示例:
    • --index4 0 (第一个网卡)
    • --index4 public (公网IP)
    • --index4 "url:http://ip.sb" (从URL获取)
    • --index4 "regex:192\\.168\\.*" (匹配192.168开头的IP)
    • --index4 public --index4 0 (先尝试获取公网IP，失败则使用第一个网卡)

--index6 [Rule...]

IPv6地址获取方式，用法同--index4。

网络配置参数

--ttl TTL

DNS解析TTL时间（秒）。

  • 默认值: null（使用DNS服务商默认设置）
  • 示例:
    • --ttl 600 (10分钟)
    • --ttl 3600 (1小时)

--proxy [PROXY...]

HTTP代理设置，支持多代理轮换。

  • 默认值: 无（DIRECT 直连）
  • 示例:
    • --proxy 127.0.0.1:1080 (单个代理)
    • --proxy 127.0.0.1:1080 --proxy DIRECT (多个代理，逐个尝试)

系统配置参数

--cache {true|false|PATH}

启用缓存以减少API请求。

  • 默认值: true
  • 可选值:
    • true: 启用缓存，使用默认路径
    • false: 禁用缓存
    • 文件路径: 自定义缓存文件位置
  • 示例:
    • --cache (启用默认缓存)
    • --cache=false (禁用缓存)
    • --cache=/path/to/ddns.cache (自定义缓存路径)

--ssl {true|false|auto|PATH}

SSL证书验证方式，控制HTTPS连接的证书验证行为。

  • 默认值: auto
  • 可选值:
    • true: 强制验证SSL证书（最安全）
    • false: 禁用SSL证书验证（最不安全）
    • auto: 优先验证，SSL证书错误时自动降级（不安全）
    • 文件路径: 使用指定路径的自定义CA证书（最安全）
  • 示例:
    • --ssl true (强制验证)
    • --ssl false (禁用验证)
    • --ssl auto (自动降级)
    • --ssl /etc/ssl/certs/ca-certificates.crt (自定义CA证书)

--debug

启用调试模式（等同于设置--log_level=DEBUG）。

  • 说明: 此参数仅作为命令行参数有效，配置文件中的同名设置无效
  • 示例: --debug

日志配置参数

--log_level {CRITICAL|FATAL|ERROR|WARN|WARNING|INFO|DEBUG|NOTSET}

设置日志级别。

  • 默认值: INFO
  • 示例:
    • --log_level=DEBUG (调试模式)
    • --log_level=ERROR (仅显示错误)

--log_file LOGFILE

设置日志文件路径。

  • 默认值: 无（输出到控制台）
  • 示例:
    • --log_file=/var/log/ddns.log
    • --log_file=./ddns.log

--log_datefmt FORMAT

设置日期时间格式字符串（参考Python time.strftime()格式）。

  • 默认值: %Y-%m-%dT%H:%M:%S
  • 示例:
    • --log_datefmt="%Y-%m-%d %H:%M:%S"
    • --log_datefmt="%m-%d %H:%M:%S"

常用命令示例

使用配置文件

# 使用默认配置文件
ddns

# 使用指定配置文件
ddns -c /path/to/config.json

命令行临时修改配置

# 启用调试模式
ddns --debug

# 使用指定配置文件并启用调试模式
ddns -c /path/to/config.json --debug

# 更新特定域名的IPv4地址（多个域名）
ddns --ipv4 example.com --ipv4 www.example.com

# 设置为阿里云DNS并提供认证信息
ddns --dns alidns --id YOUR_ACCESS_KEY_ID --token YOUR_ACCESS_KEY_SECRET

高级用法示例

# 使用公网IP和特定的网络配置
ddns --ipv4 example.com --index4 public --ttl 600 --proxy 127.0.0.1:1080

# 自定义日志配置
ddns --log_level=DEBUG --log_file=./ddns.log --log_format="%(asctime)s - %(levelname)s: %(message)s"

# 完整配置示例
ddns --dns cloudflare --id [email protected] --token API_TOKEN \
     --ipv4 example.com --ipv4 www.example.com --ipv6 example.com \
     --index4 public --index6 "regex:2001:.*" \
     --ttl 300 --proxy 127.0.0.1:1080 --proxy DIRECT \
     --cache=/var/cache/ddns.cache \
     --log_level=INFO --log_file=/var/log/ddns.log

完整使用示例

基本配置示例

# 最简单的配置 - DNSPod国内版
ddns --dns dnspod --id 12345 --token mytokenkey --ipv4 example.com

# 生成新的配置文件
ddns --new-config config.json

# 使用指定配置文件
ddns -c /path/to/config.json

# 查看版本信息
ddns --version

不同DNS提供商示例

# CloudFlare
ddns --dns cloudflare --id [email protected] --token your_api_token --ipv4 example.com

# 阿里云DNS
ddns --dns alidns --id your_access_key_id --token your_access_key_secret --ipv4 example.com

# 阿里云ESA（自定义端点）
ddns --dns aliesa --id your_access_key_id --token your_access_key_secret --endpoint https://esa.ap-southeast-1.aliyuncs.com --ipv4 example.com

# 华为云DNS
ddns --dns huaweidns --id your_access_key --token your_secret_key --ipv4 example.com

# HE.net（无需id）
ddns --dns he --token your_password --ipv4 example.com

# DNS.COM/51DNS
ddns --dns dnscom --id your_user_id --token your_api_token --ipv4 example.com

# 腾讯云DNS
ddns --dns tencentcloud --id your_secret_id --token your_secret_key --ipv4 example.com

# NoIP
ddns --dns noip --id your_username --token your_password --ipv4 example.com

# NoIP（自定义端点）
ddns --dns noip --id your_username --token your_password --endpoint https://your-ddns-server.com --ipv4 example.com

高级配置示例

# 多域名、多IP获取方式
ddns --dns cloudflare --id [email protected] --token API_TOKEN \
     --ipv4 example.com --ipv4 www.example.com --ipv4 api.example.com \
     --ipv6 example.com --ipv6 ipv6.example.com \
     --index4 public --index4 "regex:192\\.168\\.1\\..*" \
     --index6 public --index6 0

# 使用代理和自定义TTL
ddns --dns dnspod --id 12345 --token mytokenkey \
     --index4 public --ipv4 example.com --ttl 300 \
     --proxy 127.0.0.1:1080 --proxy DIRECT

ddns --dns dnspod --id 12345 --token mytokenkey \
     --ipv4 telecom.example.com --line 电信


# 调试模式
ddns --debug ...

# 禁用缓存和SSL验证
ddns --no-cache --no-ssl ...

自定义回调示例

# GET方式回调
ddns --dns callback \
     --id "https://api.example.com/ddns?domain=__DOMAIN__&ip=__IP__&ttl=__TTL__" \
     --token "" \
     --ipv4 example.com --index4 public

# POST方式回调
ddns --dns callback \
     --id "https://api.example.com/ddns" \
     --token '{"api_key": "your_key", "domain": "__DOMAIN__", "ip": "__IP__", "type": "__RECORDTYPE__"}' \
     --ipv4 example.com --ipv6 example.com

日志配置示例

# 详细日志配置
ddns --dns cloudflare --id [email protected] --token API_TOKEN \
     --ipv4 example.com  --index4 public \
     --log_level=DEBUG \
     --log_file=/var/log/ddns.log \
     --log_format="%(asctime)s [%(levelname)s] %(filename)s:%(lineno)d - %(message)s" \
     --log_datefmt="%Y-%m-%d %H:%M:%S"

# 简单调试
ddns --debug --dns dnspod --id 12345 --token mytokenkey --ipv4 example.com

注意事项

  1. 命令行参数具有最高优先级，会覆盖配置文件和环境变量中的设置。
  2. 对于需要空格的参数值，请使用引号包围，例如：--log_format="%(asctime)s: %(message)s"。
  3. 对于多值参数（如--ipv4、--index4、--proxy等），请重复使用参数标识，例如：--ipv4 example.com --ipv4 sub.example.com。
  4. --debug参数仅在命令行中有效，配置文件中的debug设置将被忽略。