DDNS

DDNS 环境变量配置文档

概述

DDNS 支持通过环境变量进行配置，环境变量的优先级为：命令行参数 > 配置文件 > 环境变量

所有环境变量都以 DDNS_ 为前缀，后跟参数名（推荐全大写），点号(.)替换为下划线(_)。

export DDNS_xxx=”xxx” 命令作用于当前主机 docker run -e DDNS_xxx=”xxx” 命令作用于容器内

环境变量命名规则

配置参数 环境变量名称 示例
id DDNS_ID 或 ddns_id DDNS_ID=12345
token DDNS_TOKEN 或 ddns_token DDNS_TOKEN=mytokenkey
log.level DDNS_LOG_LEVEL 或 ddns_log_level DDNS_LOG_LEVEL=DEBUG
log.file DDNS_LOG_FILE 或 ddns_log_file DDNS_LOG_FILE=/var/log/ddns.log

环境变量完整参数列表

以下是DDNS支持的所有环境变量参数列表：

环境变量 类型 默认值 描述
DDNS_ID 字符串 无 API访问ID或用户标识
DDNS_TOKEN 字符串 无 API授权令牌或密钥
DDNS_DNS 字符串 dnspod DNS服务提供商
DDNS_IPV4 数组/字符串 无 IPv4域名列表
DDNS_IPV6 数组/字符串 无 IPv6域名列表
DDNS_INDEX4 数组/字符串/数字 default IPv4地址获取方式
DDNS_INDEX6 数组/字符串/数字 default IPv6地址获取方式
DDNS_TTL 整数 无 DNS解析TTL时间（秒）
DDNS_PROXY 数组/字符串 无 HTTP代理设置
DDNS_CACHE 布尔值/字符串 true 缓存设置
DDNS_LOG_LEVEL 字符串 INFO 日志级别
DDNS_LOG_FILE 字符串 无 日志文件路径
DDNS_LOG_FORMAT 字符串 %(asctime)s %(levelname)s [%(module)s]: %(message)s 日志格式字符串
DDNS_LOG_DATEFMT 字符串 %Y-%m-%dT%H:%M:%S 日期时间格式字符串

参数值示例

环境变量 可能的值 示例
DDNS_DNS dnspod, alidns, cloudflare, dnscom, dnspod_com, he, huaweidns, callback export DDNS_DNS="cloudflare"
DDNS_IPV4 JSON数组, 逗号分隔的字符串 export DDNS_IPV4='["example.com", "www.example.com"]'
DDNS_IPV6 JSON数组, 逗号分隔的字符串 export DDNS_IPV6="example.com,ipv6.example.com"
DDNS_INDEX4 数字、default、public、url:、regex:、cmd:、shell: export DDNS_INDEX4='["public", "regex:192\\.168\\..*"]'
DDNS_INDEX6 数字、default、public、url:、regex:、cmd:、shell: export DDNS_INDEX6="public"
DDNS_PROXY IP:端口, DIRECT, 分号分隔的列表 export DDNS_PROXY="127.0.0.1:1080;DIRECT"
DDNS_CACHE true/false, 文件路径 export DDNS_CACHE="/path/to/cache.json"
DDNS_LOG_LEVEL DEBUG, INFO, WARNING, ERROR, CRITICAL export DDNS_LOG_LEVEL="DEBUG"
DDNS_LOG_FORMAT 格式字符串 export DDNS_LOG_FORMAT="%(asctime)s: %(message)s"
DDNS_LOG_DATEFMT 日期格式字符串 export DDNS_LOG_DATEFMT="%Y-%m-%d %H:%M:%S"

基础配置参数

认证信息

DDNS_ID

DDNS_TOKEN

DNS 服务商

DDNS_DNS

域名配置

IPv4 域名列表

DDNS_IPV4

IPv6 域名列表

DDNS_IPV6

IP 获取方式

IPv4 获取方式

DDNS_INDEX4

IPv6 获取方式

DDNS_INDEX6

网络配置

TTL 设置

DDNS_TTL

代理设置

DDNS_PROXY

系统配置

缓存设置

DDNS_CACHE

日志配置

DDNS_LOG_LEVEL

DDNS_LOG_FILE

DDNS_LOG_FORMAT

DDNS_LOG_DATEFMT

使用示例

基础配置示例

#!/bin/bash
# DNSPod 配置示例
export DDNS_DNS="dnspod"
export DDNS_ID="12345"
export DDNS_TOKEN="your_token_here"
export DDNS_IPV4='["example.com", "www.example.com"]'
export DDNS_IPV6='["ipv6.example.com"]'
export DDNS_TTL="600"

# 运行 DDNS
ddns

Docker 环境变量示例

docker run -d \
  -e DDNS_DNS=dnspod \
  -e DDNS_ID=12345 \
  -e DDNS_TOKEN=your_token_here \
  -e DDNS_IPV4=example.com \
  -e DDNS_IPV6='["ipv6.example.com","example.com"]' \
  -e DDNS_INDEX4=["public", 0] \
  -e DDNS_INDEX6=public \
  -e DDNS_TTL=600 \
  -e DDNS_LOG_LEVEL=INFO \
  -e DDNS_LOG_FORMAT="%(asctime)s %(levelname)s [%(module)s]: %(message)s" \
  -e DDNS_LOG_DATEFMT="%Y-%m-%dT%H:%M:%S" \
  --network host \
  newfuture/ddns

复杂配置示例

#!/bin/bash
# 阿里云 DNS 高级配置
export DDNS_DNS="alidns"
export DDNS_ID="your_access_key_id"
export DDNS_TOKEN="your_access_key_secret"

# 多域名配置
export DDNS_IPV4='["ddns.example.com", "home.example.com", "server.example.com"]'
export DDNS_IPV6='["ipv6.example.com"]'

# 多种 IP 获取方式
export DDNS_INDEX4='["public", "regex:192\\.168\\.1\\..*", "cmd:curl -s ipv4.icanhazip.com"]'
export DDNS_INDEX6="public"

# 代理和缓存配置
export DDNS_PROXY='["http://proxy.example.com:8080", "DIRECT"]'
export DDNS_CACHE="/home/user/.ddns_cache"

# 日志配置
export DDNS_LOG_LEVEL="DEBUG"
export DDNS_LOG_FILE="/var/log/ddns.log"
export DDNS_LOG_FORMAT="%(asctime)s %(levelname)s [%(filename)s:%(lineno)d]: %(message)s"
export DDNS_LOG_DATEFMT="%Y-%m-%d %H:%M:%S"

# TTL 设置
export DDNS_TTL="300"

# 运行
ddns

注意事项

  1. 数组参数格式: index4, index6, ipv4, ipv6, proxy 等数组参数支持两种格式：
    • JSON 数组格式：'["item1", "item2"]'（推荐）
    • 逗号分隔格式："item1,item2"

  2. 配置优先级和字段覆盖关系:

    DDNS工具中的配置优先级顺序为：命令行参数 > JSON配置文件 > 环境变量

    • 命令行参数: 优先级最高，会覆盖JSON配置文件和环境变量中的相同设置
    • JSON配置文件: 优先级中等，会覆盖环境变量中的设置，但会被命令行参数覆盖
    • 环境变量: 优先级最低，当命令行参数和JSON配置文件中都没有相应设置时使用

    举例说明：

    # 环境变量设置
export DDNS_TTL="600"
   
# JSON配置文件内容
{
  "ttl": 300
}
   
# 命令行参数
ddns --ttl 900

    在上述例子中：

    • 最终生效的是命令行参数值：ttl=900
    • 如果不提供命令行参数，则使用JSON配置文件值：ttl=300
    • 如果JSON配置和命令行参数都不提供，则使用环境变量值：ttl=600

    另外，JSON配置文件中明确设置为null的值会覆盖环境变量设置，相当于未设置该值。

  3. 大小写兼容: 环境变量名支持大写、小写或混合大小写

  4. 安全提醒:
    • 请妥善保管 DDNS_TOKEN 等敏感信息
    • 在脚本中使用时避免明文存储
    • 考虑使用 .env 文件或密钥管理系统
  5. 调试建议: 出现问题时，可设置 DDNS_LOG_LEVEL=DEBUG 获取详细日志信息
This site is open source. Improve this page.