ddns


Nameddns JSON
Version 4.1.1 PyPI version JSON
download
home_pageNone
SummaryDynamic DNS client for multiple providers, supporting IPv4 and IPv6.
upload_time2025-10-31 07:37:18
maintainerNone
docs_urlNone
authorNone
requires_python>=2.7
licenseNone
keywords ddns ipv6 ipv4 dns dnspod alidns cloudflare
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # [<img src="https://ddns.newfuture.cc/doc/img/ddns.svg" width="32px" height="32px"/>](https://ddns.newfuture.cc) DDNS

> 自动更新 DNS 解析到本机 IP 地址,支持 IPv4/IPv6,内网/公网 IP,自动创建 DNS 记录

[![GitHub](https://img.shields.io/github/license/NewFuture/DDNS?logo=github&style=flat)](https://github.com/NewFuture/DDNS)
[![Build](https://github.com/NewFuture/DDNS/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/NewFuture/DDNS/actions/workflows/build.yml)
[![Publish](https://github.com/NewFuture/DDNS/actions/workflows/publish.yml/badge.svg)](https://github.com/NewFuture/DDNS/actions/workflows/publish.yml)
[![Release](https://img.shields.io/github/v/release/NewFuture/DDNS?logo=github&style=flat)](https://github.com/NewFuture/DDNS/releases/latest)
[![PyPI](https://img.shields.io/pypi/v/ddns.svg?logo=pypi&style=flat)](https://pypi.org/project/ddns/)
[![Python Version](https://img.shields.io/pypi/pyversions/ddns.svg?logo=python&style=flat)](https://pypi.org/project/ddns/)
[![Docker](https://img.shields.io/docker/v/newfuture/ddns?logo=docker&sort=semver&style=flat)](https://hub.docker.com/r/newfuture/ddns)
[![Docker image size](https://img.shields.io/docker/image-size/newfuture/ddns/latest?logo=docker&style=flat)](https://hub.docker.com/r/newfuture/ddns)

## 主要特性

### 🚀 多平台支持

- **Docker**: 推荐方式,支持 `amd64`、`arm64`、`arm/v7` 等多架构 ([使用文档](doc/docker.md))
- **二进制文件**: 单文件运行,支持 Windows/Linux/macOS ([下载地址](https://github.com/NewFuture/DDNS/releases/latest))
- **pip 安装**: `pip install ddns`
- **源码运行**: 无依赖,仅需 Python 环境

### ⚙️ 灵活配置

- **命令行参数**: `ddns --dns=dnspod --id=xxx --token=xxx` ([配置文档](doc/config/cli.md))
- **JSON 配置文件**: 支持多域名、多服务商配置,支持远程URL配置 ([配置文档](doc/config/json.md))
- **环境变量**: Docker 友好的配置方式 ([配置文档](doc/config/env.md))

### 🌍 DNS 服务商支持

支持 15+ 主流 DNS 服务商,包括:

- **国内**: [阿里DNS](doc/providers/alidns.md) ⚡、[阿里云ESA](doc/providers/aliesa.md) ⚡、[DNSPOD](doc/providers/dnspod.md)、[腾讯云DNS](doc/providers/tencentcloud.md) ⚡、[腾讯云EdgeOne](doc/providers/edgeone.md) ⚡、[华为云DNS](doc/providers/huaweidns.md) ⚡、[DNS.COM](doc/providers/51dns.md)
- **国际**: [Cloudflare](doc/providers/cloudflare.md)、[DNSPOD国际版](doc/providers/dnspod_com.md)、[HE.net](doc/providers/he.md)、[NameSilo](doc/providers/namesilo.md)、[No-IP](doc/providers/noip.md)
- **自定义**: [回调 API](doc/providers/callback.md)、[调试模式](doc/providers/debug.md)

> ⚡ 表示支持 HMAC-SHA256 企业级安全认证 | [查看所有服务商](doc/providers/)

### 🔧 高级功能

- 多域名和多级域名解析
- IPv4/IPv6 双栈支持
- 自动创建 DNS 记录
- 内网/公网 IP 自动检测
- HTTP 代理和多代理切换
- 本地缓存减少 API 调用
- [定时任务](doc/config/cli.md#task-management-定时任务管理)和日志管理

## 使用

### ① 安装

根据需要选择一种方式:`一键脚本`、`二进制`版、`pip`版、`源码`运行,或者 `Docker`。

推荐 Docker 版,兼容性最佳,体积小,性能优化。

- #### Docker(推荐)

  详细说明和高级用法请查看 [Docker 使用文档](https://ddns.newfuture.cc/doc/docker.html)

  <details>
  <summary markdown="span">支持命令行,配置文件,和环境变量传参</summary>

  - 命令行cli

      ```sh
      docker run newfuture/ddns -h
      ```

  - 使用配置文件(docker 工作目录 `/ddns/`,默认配置位置 `/ddns/config.json`):

      ```sh
      docker run -d -v /host/config/:/ddns/ --network host newfuture/ddns
      ```

  - 使用环境变量:

      ```sh
      docker run -d \
        -e DDNS_DNS=dnspod \
        -e DDNS_ID=12345 \
        -e DDNS_TOKEN=mytokenkey \
        -e DDNS_IPV4=ddns.newfuture.cc \
        --network host \
        newfuture/ddns
      ```

  </details>

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

  前往[release下载对应版本](https://github.com/NewFuture/DDNS/releases/latest)

  也可使用一键安装脚本自动下载并安装对应平台的二进制:

  ```bash
  curl -#fSL https://ddns.newfuture.cc/install.sh | sh
  ```
  提示:安装到系统目录(如 /usr/local/bin)可能需要 root 或 sudo 权限;若权限不足,可改为 `sudo sh` 运行。

  详细说明请查看 [一键安装文档](doc/install.md)

- #### pip 安装(需要 pip 或 easy_install)

  1. 安装 ddns: `pip install ddns` 或 `easy_install ddns`
  2. 运行: `ddns -h` 或者 `python -m ddns`

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

  1. clone 或者 [下载此仓库](https://github.com/NewFuture/DDNS/archive/master.zip) 并解压
  2. 运行 `python -m ddns`

### ② 快速配置

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

   - **DNSPOD(中国版)**: [创建 token](https://support.dnspod.cn/Kb/showarticle/tsid/227/) | [详细配置文档](doc/providers/dnspod.md)
   - **阿里云 DNS**: [申请 accesskey](https://help.aliyun.com/document_detail/87745.htm) | [详细配置文档](doc/providers/alidns.md)
   - **阿里云边缘安全加速(ESA)**: [申请 accesskey](https://help.aliyun.com/document_detail/87745.htm) | [详细配置文档](doc/providers/aliesa.md)
   - **51DNS(dns.com)**: [API Key/Secret](https://www.dns.com/member/apiSet) | [详细配置文档](doc/providers/51dns.md)
   - **DNSPOD(国际版)**: [获取 token](https://www.dnspod.com/docs/info.html#get-the-user-token) | [详细配置文档](doc/providers/dnspod_com.md)
   - **CloudFlare**: [API Key](https://support.cloudflare.com/hc/en-us/articles/200167836-Where-do-I-find-my-Cloudflare-API-key-)(除了 `email + API KEY`,也可使用 `Token`,**需要list Zone 权限**) | [详细配置文档](doc/providers/cloudflare.md)
   - **HE.net**: [DDNS 文档](https://dns.he.net/docs.html)(仅需将设置的密码填入 `token` 字段,`id` 字段可留空) | [详细配置文档](doc/providers/he.md)
   - **华为云 DNS**: [APIKEY 申请](https://console.huaweicloud.com/iam/)(点左边访问密钥,然后点新增访问密钥) | [详细配置文档](doc/providers/huaweidns.md)
   - **NameSilo**: [API Key](https://www.namesilo.com/account/api-manager)(API Manager 中获取 API Key) | [详细配置文档](doc/providers/namesilo.md)
   - **腾讯云 DNS**: [API Secret](https://console.cloud.tencent.com/cam/capi) | [详细配置文档](doc/providers/tencentcloud.md)
   - **腾讯云 EdgeOne**: [API Secret](https://console.cloud.tencent.com/cam/capi) | [详细配置文档](doc/providers/edgeone.md)
   - **No-IP**: [用户名和密码](https://www.noip.com/)(使用 No-IP 账户的用户名和密码) | [详细配置文档](doc/providers/noip.md)
   - **自定义回调**: 参数填写方式请查看下方的自定义回调配置说明

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

## 详细配置

所有字段可通过三种方式进行配置,优先级为:**命令行参数 > JSON配置文件 > 环境变量**

1. [命令行参数](doc/config/cli.md) `ddns --key=value`(`ddns -h` 查看详情),优先级最高
2. [JSON 配置文件](doc/config/json.md)(值为 null 认为是有效值,会覆盖环境变量的设置,如果没有对应的 key 则会尝试使用环境变量)
3. [环境变量](doc/config/env.md) DDNS_ 前缀加上 key (`${ddns_id}` 或 `${DDNS_ID}`,`${DDNS_LOG_LEVEL}`)

### 配置优先级和字段覆盖关系

如果同一个配置项在多个地方设置,将按照以下优先级规则生效:

- **命令行参数**:优先级最高,会覆盖其他所有设置
- **JSON配置文件**:介于命令行和环境变量之间,会覆盖环境变量中的设置
- **环境变量**:优先级最低,当其他方式未设置时使用

**高级用法**:

- JSON配置中明确设为`null`的值会覆盖环境变量设置
- `debug`参数只在命令行中有效,JSON配置文件中的同名设置无效
- 多值参数(如`ipv4`、`ipv6`等)在命令行中使用方式为重复使用参数,如`--ipv4 domain1 --ipv4 domain2`

各配置方式的详细说明请查看对应文档:[命令行](doc/config/cli.md)、[JSON配置](doc/config/json.md)、[环境变量](doc/config/env.md)、[服务商配置](doc/providers/)

> 📖 **环境变量详细配置**: 查看 [环境变量配置文档](doc/config/env.md) 了解所有环境变量的详细用法和示例

<details open>
<summary markdown="span">config.json 配置文件</summary>

- 首次运行会自动生成一个模板配置文件
- 可以使用 `-c` 使用指定的配置文件(默认读取当前目录的 config.json)
- 推荐使用 vscode 等支持 JsonSchema 的编辑器编辑配置文件
- 查看 [JSON配置文件详细文档](doc/config/json.md) 了解完整的配置选项和示例

```bash
ddns -c path/to/config.json
# 或者python运行
python -m ddns -c /path/to/config.json
# 远程配置文件
ddns -c https://ddns.newfuture.cc/tests/config/debug.json
```

#### 配置参数表

|  key   |        type        | required |   default   |    description     | tips                                                                                                                                                                                     |
| :----: | :----------------: | :------: | :---------: | :----------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   id   |       string       |    √     |     无      |    api 访问 ID     | Cloudflare 为邮箱(使用 Token 时留空)<br>HE.net 可留空<br>华为云为 Access Key ID (AK)                                                                                                   |
| token  |       string       |    √     |     无      |   api 授权 token   | 部分平台叫 secret key,**反馈粘贴时删除**                                                                                                                                                |
|  dns   |       string       |    No    | `"dnspod"`  |     dns 服务商     | 阿里 DNS 为 `alidns`,阿里ESA为 `aliesa`,Cloudflare 为 `cloudflare`,dns.com 为 `dnscom`,DNSPOD 国内为 `dnspod`,DNSPOD 国际为 `dnspod_com`,HE.net 为 `he`,华为云为 `huaweidns`,NameSilo 为 `namesilo`,腾讯云为 `tencentcloud`,腾讯云EdgeOne为 `edgeone`,No-IP 为 `noip`,自定义回调为 `callback`。部分服务商有[详细配置文档](doc/providers/) |
|  ipv4  |       array        |    No    |    `[]`     |   ipv4 域名列表    | 为 `[]` 时,不会获取和更新 IPv4 地址                                                                                                                                                     |
|  ipv6  |       array        |    No    |    `[]`     |   ipv6 域名列表    | 为 `[]` 时,不会获取和更新 IPv6 地址                                                                                                                                                     |
| index4 | string\|int\|array |    No    | `"default"` |   ipv4 获取方式    | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式                                                                                                                                             |
| index6 | string\|int\|array |    No    | `"default"` |   ipv6 获取方式    | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式                                                                                                                                             |
|  ttl   |       number       |    No    |   `null`    | DNS 解析 TTL 时间  | 不设置采用 DNS 默认策略                                                                                                                                                                  |
| proxy  |   string\|array    |    No    |     无      | HTTP 代理格式:`http://host:port` | 多代理逐个尝试直到成功,`DIRECT` 为直连                                                                                                                                                  |
|  ssl   |  string\|boolean   |    No    |  `"auto"`   | SSL证书验证方式    | `true`(强制验证)、`false`(禁用验证)、`"auto"`(自动降级)或自定义CA证书文件路径                                                                                    |
| debug  |        bool        |    No    |   `false`   |    是否开启调试    | 调试模式,仅命令行参数`--debug`有效                                                                                                                                    |
| cache  |    string\|bool    |    No    |   `true`    |    是否缓存记录    | 正常情况打开避免频繁更新,默认位置为临时目录下 `ddns.cache`,也可以指定一个具体路径                                                                                                      |
|  log   |       object       |    No    |   `null`    |  日志配置(可选)  | 日志配置对象,支持`level`、`file`、`format`、`datefmt`参数                                                                                                                               |

#### index4 和 index6 参数说明

- 数字(`0`,`1`,`2`,`3`等):第 i 个网卡 ip
- 字符串 `"default"`(或者无此项):系统访问外网默认 IP
- 字符串 `"public"`:使用公网 ip(使用公网 API 查询,url 的简化模式)
- 字符串 `"url:xxx"`:打开 URL `xxx`(如:`"url:http://ip.sb"`),从返回的数据提取 IP 地址
- 字符串 `"regex:xxx"` 正则表达(如 `"regex:192.*"`):提取 `ifconfig`/`ipconfig` 中与之匹配的首个 IP 地址,**注意 json 转义**(`\`要写成`\\`)
  - `"192.*"` 表示 192 开头的所有 ip(注意 `regex:` 不可省略)
  - 如果想匹配 `10.00.xxxx` 应该写成 `"regex:10\\.00\\..*"`(`"\\"` json 转义成 `\`)
- 字符串 `"cmd:xxxx"`:执行命令 `xxxx` 的 stdout 输出结果作为目标 IP
- 字符串 `"shell:xxx"`:使用系统 shell 运行 `xxx`,并把结果 stdout 作为目标 IP
- `false`:强制禁止更新 ipv4 或 ipv6 的 DNS 解析
- 列表:依次执行列表中的 index 规则,并将最先获得的结果作为目标 IP
  - 例如 `["public", "regex:172\\..*"]` 将先查询公网 API,未获取到 IP 后再从本地寻找 172 开头的 IP

#### 自定义回调配置说明

- `id` 字段填写回调地址,以 HTTP 或 HTTPS 开头,推荐采用 HTTPS 方式的回调 API,支持变量替换功能。
- `token` 字段为 POST 请求参数(JSON对象或JSON字符串),本字段为空或不存在则使用 GET 方式发起回调。当 JSON 的参数值包含下表所示的常量字符串时,会自动替换为实际内容。

详细配置指南请查看:[Callback Provider 配置文档](doc/providers/callback.md)

| 常量名称         | 常量内容                 | 说明     |
| ---------------- | ------------------------ | -------- |
| `__DOMAIN__`     | DDNS 域名                |          |
| `__IP__`         | 获取的对应类型的 IP 地址 |          |
| `__RECORDTYPE__` | DDNS 记录类型            |          |
| `__TTL__`        | DDNS TTL                 |          |
| `__TIMESTAMP__`  | 请求发起时间戳           | 包含小数 |

#### 配置示例

```json
{
  "$schema": "https://ddns.newfuture.cc/schema/v4.0.json",
  "id": "12345",
  "token": "mytokenkey",
  "dns": "dnspod 或 dnspod_com 或 alidns 或 aliesa 或 dnscom 或 cloudflare 或 he 或 huaweidns 或 namesilo 或 tencentcloud 或 noip 或 callback",
  "ipv4": ["ddns.newfuture.cc", "ipv4.ddns.newfuture.cc"],
  "ipv6": ["ddns.newfuture.cc", "ipv6.ddns.newfuture.cc"],
  "index4": 0,
  "index6": "public",
  "ttl": 600,
  "proxy": ["http://127.0.0.1:1080", "DIRECT"],
  "log": {
    "level": "DEBUG",
    "file": "dns.log",
    "datefmt": "%Y-%m-%dT%H:%M:%S"
  }
}
```

</details>

## 定时任务

<details>
<summary markdown="span">使用内置的 task 命令设置定时任务(默认每 5 分钟检查一次 IP,自动更新)</summary>

DDNS 提供内置的 `task` 子命令来管理定时任务,支持跨平台自动化部署:

### 高级管理

```bash
# 安装并指定更新间隔(分钟)
ddns task --install 10 -c /etc/config/ddns.json

# 启用/禁用任务
ddns task --enable
ddns task --disable
```

详细配置指南请参考:[命令行参数文档](https://ddns.newfuture.cc/doc/config/cli.md#task-management-定时任务管理)

### Docker

Docker 镜像在无额外参数的情况下,已默认启用每 5 分钟执行一次的定时任务

</details>

<details>
<summary markdown="span">问题排查反馈</summary>

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

</details>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ddns",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=2.7",
    "maintainer_email": null,
    "keywords": "ddns, ipv6, ipv4, dns, dnspod, alidns, cloudflare",
    "author": null,
    "author_email": "NewFuture <python@newfuture.cc>",
    "download_url": "https://files.pythonhosted.org/packages/a4/49/7b82d7c6a0b4c3fda1c75dc433833ee28b26d3c90c7f91d0073a2fc6478d/ddns-4.1.1.tar.gz",
    "platform": "any",
    "description": "# [<img src=\"https://ddns.newfuture.cc/doc/img/ddns.svg\" width=\"32px\" height=\"32px\"/>](https://ddns.newfuture.cc) DDNS\n\n> \u81ea\u52a8\u66f4\u65b0 DNS \u89e3\u6790\u5230\u672c\u673a IP \u5730\u5740\uff0c\u652f\u6301 IPv4/IPv6\uff0c\u5185\u7f51/\u516c\u7f51 IP\uff0c\u81ea\u52a8\u521b\u5efa DNS \u8bb0\u5f55\n\n[![GitHub](https://img.shields.io/github/license/NewFuture/DDNS?logo=github&style=flat)](https://github.com/NewFuture/DDNS)\n[![Build](https://github.com/NewFuture/DDNS/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/NewFuture/DDNS/actions/workflows/build.yml)\n[![Publish](https://github.com/NewFuture/DDNS/actions/workflows/publish.yml/badge.svg)](https://github.com/NewFuture/DDNS/actions/workflows/publish.yml)\n[![Release](https://img.shields.io/github/v/release/NewFuture/DDNS?logo=github&style=flat)](https://github.com/NewFuture/DDNS/releases/latest)\n[![PyPI](https://img.shields.io/pypi/v/ddns.svg?logo=pypi&style=flat)](https://pypi.org/project/ddns/)\n[![Python Version](https://img.shields.io/pypi/pyversions/ddns.svg?logo=python&style=flat)](https://pypi.org/project/ddns/)\n[![Docker](https://img.shields.io/docker/v/newfuture/ddns?logo=docker&sort=semver&style=flat)](https://hub.docker.com/r/newfuture/ddns)\n[![Docker image size](https://img.shields.io/docker/image-size/newfuture/ddns/latest?logo=docker&style=flat)](https://hub.docker.com/r/newfuture/ddns)\n\n## \u4e3b\u8981\u7279\u6027\n\n### \ud83d\ude80 \u591a\u5e73\u53f0\u652f\u6301\n\n- **Docker**: \u63a8\u8350\u65b9\u5f0f\uff0c\u652f\u6301 `amd64`\u3001`arm64`\u3001`arm/v7` \u7b49\u591a\u67b6\u6784 ([\u4f7f\u7528\u6587\u6863](doc/docker.md))\n- **\u4e8c\u8fdb\u5236\u6587\u4ef6**: \u5355\u6587\u4ef6\u8fd0\u884c\uff0c\u652f\u6301 Windows/Linux/macOS ([\u4e0b\u8f7d\u5730\u5740](https://github.com/NewFuture/DDNS/releases/latest))\n- **pip \u5b89\u88c5**: `pip install ddns`\n- **\u6e90\u7801\u8fd0\u884c**: \u65e0\u4f9d\u8d56\uff0c\u4ec5\u9700 Python \u73af\u5883\n\n### \u2699\ufe0f \u7075\u6d3b\u914d\u7f6e\n\n- **\u547d\u4ee4\u884c\u53c2\u6570**: `ddns --dns=dnspod --id=xxx --token=xxx` ([\u914d\u7f6e\u6587\u6863](doc/config/cli.md))\n- **JSON \u914d\u7f6e\u6587\u4ef6**: \u652f\u6301\u591a\u57df\u540d\u3001\u591a\u670d\u52a1\u5546\u914d\u7f6e\uff0c\u652f\u6301\u8fdc\u7a0bURL\u914d\u7f6e ([\u914d\u7f6e\u6587\u6863](doc/config/json.md))\n- **\u73af\u5883\u53d8\u91cf**: Docker \u53cb\u597d\u7684\u914d\u7f6e\u65b9\u5f0f ([\u914d\u7f6e\u6587\u6863](doc/config/env.md))\n\n### \ud83c\udf0d DNS \u670d\u52a1\u5546\u652f\u6301\n\n\u652f\u6301 15+ \u4e3b\u6d41 DNS \u670d\u52a1\u5546\uff0c\u5305\u62ec\uff1a\n\n- **\u56fd\u5185**: [\u963f\u91ccDNS](doc/providers/alidns.md) \u26a1\u3001[\u963f\u91cc\u4e91ESA](doc/providers/aliesa.md) \u26a1\u3001[DNSPOD](doc/providers/dnspod.md)\u3001[\u817e\u8baf\u4e91DNS](doc/providers/tencentcloud.md) \u26a1\u3001[\u817e\u8baf\u4e91EdgeOne](doc/providers/edgeone.md) \u26a1\u3001[\u534e\u4e3a\u4e91DNS](doc/providers/huaweidns.md) \u26a1\u3001[DNS.COM](doc/providers/51dns.md)\n- **\u56fd\u9645**: [Cloudflare](doc/providers/cloudflare.md)\u3001[DNSPOD\u56fd\u9645\u7248](doc/providers/dnspod_com.md)\u3001[HE.net](doc/providers/he.md)\u3001[NameSilo](doc/providers/namesilo.md)\u3001[No-IP](doc/providers/noip.md)\n- **\u81ea\u5b9a\u4e49**: [\u56de\u8c03 API](doc/providers/callback.md)\u3001[\u8c03\u8bd5\u6a21\u5f0f](doc/providers/debug.md)\n\n> \u26a1 \u8868\u793a\u652f\u6301 HMAC-SHA256 \u4f01\u4e1a\u7ea7\u5b89\u5168\u8ba4\u8bc1 | [\u67e5\u770b\u6240\u6709\u670d\u52a1\u5546](doc/providers/)\n\n### \ud83d\udd27 \u9ad8\u7ea7\u529f\u80fd\n\n- \u591a\u57df\u540d\u548c\u591a\u7ea7\u57df\u540d\u89e3\u6790\n- IPv4/IPv6 \u53cc\u6808\u652f\u6301\n- \u81ea\u52a8\u521b\u5efa DNS \u8bb0\u5f55\n- \u5185\u7f51/\u516c\u7f51 IP \u81ea\u52a8\u68c0\u6d4b\n- HTTP \u4ee3\u7406\u548c\u591a\u4ee3\u7406\u5207\u6362\n- \u672c\u5730\u7f13\u5b58\u51cf\u5c11 API \u8c03\u7528\n- [\u5b9a\u65f6\u4efb\u52a1](doc/config/cli.md#task-management-\u5b9a\u65f6\u4efb\u52a1\u7ba1\u7406)\u548c\u65e5\u5fd7\u7ba1\u7406\n\n## \u4f7f\u7528\n\n### \u2460 \u5b89\u88c5\n\n\u6839\u636e\u9700\u8981\u9009\u62e9\u4e00\u79cd\u65b9\u5f0f\uff1a`\u4e00\u952e\u811a\u672c`\u3001`\u4e8c\u8fdb\u5236`\u7248\u3001`pip`\u7248\u3001`\u6e90\u7801`\u8fd0\u884c\uff0c\u6216\u8005 `Docker`\u3002\n\n\u63a8\u8350 Docker \u7248\uff0c\u517c\u5bb9\u6027\u6700\u4f73\uff0c\u4f53\u79ef\u5c0f\uff0c\u6027\u80fd\u4f18\u5316\u3002\n\n- #### Docker\uff08\u63a8\u8350\uff09\n\n  \u8be6\u7ec6\u8bf4\u660e\u548c\u9ad8\u7ea7\u7528\u6cd5\u8bf7\u67e5\u770b [Docker \u4f7f\u7528\u6587\u6863](https://ddns.newfuture.cc/doc/docker.html)\n\n  <details>\n  <summary markdown=\"span\">\u652f\u6301\u547d\u4ee4\u884c\uff0c\u914d\u7f6e\u6587\u4ef6\uff0c\u548c\u73af\u5883\u53d8\u91cf\u4f20\u53c2</summary>\n\n  - \u547d\u4ee4\u884ccli\n\n      ```sh\n      docker run newfuture/ddns -h\n      ```\n\n  - \u4f7f\u7528\u914d\u7f6e\u6587\u4ef6\uff08docker \u5de5\u4f5c\u76ee\u5f55 `/ddns/`\uff0c\u9ed8\u8ba4\u914d\u7f6e\u4f4d\u7f6e `/ddns/config.json`\uff09\uff1a\n\n      ```sh\n      docker run -d -v /host/config/:/ddns/ --network host newfuture/ddns\n      ```\n\n  - \u4f7f\u7528\u73af\u5883\u53d8\u91cf\uff1a\n\n      ```sh\n      docker run -d \\\n        -e DDNS_DNS=dnspod \\\n        -e DDNS_ID=12345 \\\n        -e DDNS_TOKEN=mytokenkey \\\n        -e DDNS_IPV4=ddns.newfuture.cc \\\n        --network host \\\n        newfuture/ddns\n      ```\n\n  </details>\n\n- #### \u4e8c\u8fdb\u5236\u7248\uff08\u5355\u6587\u4ef6\uff0c\u65e0\u9700 python\uff09\n\n  \u524d\u5f80[release\u4e0b\u8f7d\u5bf9\u5e94\u7248\u672c](https://github.com/NewFuture/DDNS/releases/latest)\n\n  \u4e5f\u53ef\u4f7f\u7528\u4e00\u952e\u5b89\u88c5\u811a\u672c\u81ea\u52a8\u4e0b\u8f7d\u5e76\u5b89\u88c5\u5bf9\u5e94\u5e73\u53f0\u7684\u4e8c\u8fdb\u5236\uff1a\n\n  ```bash\n  curl -#fSL https://ddns.newfuture.cc/install.sh | sh\n  ```\n  \u63d0\u793a\uff1a\u5b89\u88c5\u5230\u7cfb\u7edf\u76ee\u5f55\uff08\u5982 /usr/local/bin\uff09\u53ef\u80fd\u9700\u8981 root \u6216 sudo \u6743\u9650\uff1b\u82e5\u6743\u9650\u4e0d\u8db3\uff0c\u53ef\u6539\u4e3a `sudo sh` \u8fd0\u884c\u3002\n\n  \u8be6\u7ec6\u8bf4\u660e\u8bf7\u67e5\u770b [\u4e00\u952e\u5b89\u88c5\u6587\u6863](doc/install.md)\n\n- #### pip \u5b89\u88c5\uff08\u9700\u8981 pip \u6216 easy_install\uff09\n\n  1. \u5b89\u88c5 ddns: `pip install ddns` \u6216 `easy_install ddns`\n  2. \u8fd0\u884c: `ddns -h` \u6216\u8005 `python -m ddns`\n\n- #### \u6e90\u7801\u8fd0\u884c\uff08\u65e0\u4efb\u4f55\u4f9d\u8d56\uff0c\u9700 python \u73af\u5883\uff09\n\n  1. clone \u6216\u8005 [\u4e0b\u8f7d\u6b64\u4ed3\u5e93](https://github.com/NewFuture/DDNS/archive/master.zip) \u5e76\u89e3\u538b\n  2. \u8fd0\u884c `python -m ddns`\n\n### \u2461 \u5feb\u901f\u914d\u7f6e\n\n1. \u7533\u8bf7 api `token`\uff0c\u586b\u5199\u5230\u5bf9\u5e94\u7684 `id` \u548c `token` \u5b57\u6bb5:\n\n   - **DNSPOD(\u4e2d\u56fd\u7248)**: [\u521b\u5efa token](https://support.dnspod.cn/Kb/showarticle/tsid/227/) | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/dnspod.md)\n   - **\u963f\u91cc\u4e91 DNS**: [\u7533\u8bf7 accesskey](https://help.aliyun.com/document_detail/87745.htm) | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/alidns.md)\n   - **\u963f\u91cc\u4e91\u8fb9\u7f18\u5b89\u5168\u52a0\u901f(ESA)**: [\u7533\u8bf7 accesskey](https://help.aliyun.com/document_detail/87745.htm) | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/aliesa.md)\n   - **51DNS(dns.com)**: [API Key/Secret](https://www.dns.com/member/apiSet) | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/51dns.md)\n   - **DNSPOD(\u56fd\u9645\u7248)**: [\u83b7\u53d6 token](https://www.dnspod.com/docs/info.html#get-the-user-token) | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/dnspod_com.md)\n   - **CloudFlare**: [API Key](https://support.cloudflare.com/hc/en-us/articles/200167836-Where-do-I-find-my-Cloudflare-API-key-)\uff08\u9664\u4e86 `email + API KEY`\uff0c\u4e5f\u53ef\u4f7f\u7528 `Token`\uff0c**\u9700\u8981list Zone \u6743\u9650**\uff09 | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/cloudflare.md)\n   - **HE.net**: [DDNS \u6587\u6863](https://dns.he.net/docs.html)\uff08\u4ec5\u9700\u5c06\u8bbe\u7f6e\u7684\u5bc6\u7801\u586b\u5165 `token` \u5b57\u6bb5\uff0c`id` \u5b57\u6bb5\u53ef\u7559\u7a7a\uff09 | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/he.md)\n   - **\u534e\u4e3a\u4e91 DNS**: [APIKEY \u7533\u8bf7](https://console.huaweicloud.com/iam/)\uff08\u70b9\u5de6\u8fb9\u8bbf\u95ee\u5bc6\u94a5\uff0c\u7136\u540e\u70b9\u65b0\u589e\u8bbf\u95ee\u5bc6\u94a5\uff09 | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/huaweidns.md)\n   - **NameSilo**: [API Key](https://www.namesilo.com/account/api-manager)\uff08API Manager \u4e2d\u83b7\u53d6 API Key\uff09 | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/namesilo.md)\n   - **\u817e\u8baf\u4e91 DNS**: [API Secret](https://console.cloud.tencent.com/cam/capi) | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/tencentcloud.md)\n   - **\u817e\u8baf\u4e91 EdgeOne**: [API Secret](https://console.cloud.tencent.com/cam/capi) | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/edgeone.md)\n   - **No-IP**: [\u7528\u6237\u540d\u548c\u5bc6\u7801](https://www.noip.com/)\uff08\u4f7f\u7528 No-IP \u8d26\u6237\u7684\u7528\u6237\u540d\u548c\u5bc6\u7801\uff09 | [\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/noip.md)\n   - **\u81ea\u5b9a\u4e49\u56de\u8c03**: \u53c2\u6570\u586b\u5199\u65b9\u5f0f\u8bf7\u67e5\u770b\u4e0b\u65b9\u7684\u81ea\u5b9a\u4e49\u56de\u8c03\u914d\u7f6e\u8bf4\u660e\n\n2. \u4fee\u6539\u914d\u7f6e\u6587\u4ef6\uff0c`ipv4` \u548c `ipv6` \u5b57\u6bb5\uff0c\u4e3a\u5f85\u66f4\u65b0\u7684\u57df\u540d\uff0c\u8be6\u7ec6\u53c2\u7167\u914d\u7f6e\u8bf4\u660e\n\n## \u8be6\u7ec6\u914d\u7f6e\n\n\u6240\u6709\u5b57\u6bb5\u53ef\u901a\u8fc7\u4e09\u79cd\u65b9\u5f0f\u8fdb\u884c\u914d\u7f6e\uff0c\u4f18\u5148\u7ea7\u4e3a\uff1a**\u547d\u4ee4\u884c\u53c2\u6570 > JSON\u914d\u7f6e\u6587\u4ef6 > \u73af\u5883\u53d8\u91cf**\n\n1. [\u547d\u4ee4\u884c\u53c2\u6570](doc/config/cli.md) `ddns --key=value`\uff08`ddns -h` \u67e5\u770b\u8be6\u60c5\uff09\uff0c\u4f18\u5148\u7ea7\u6700\u9ad8\n2. [JSON \u914d\u7f6e\u6587\u4ef6](doc/config/json.md)\uff08\u503c\u4e3a null \u8ba4\u4e3a\u662f\u6709\u6548\u503c\uff0c\u4f1a\u8986\u76d6\u73af\u5883\u53d8\u91cf\u7684\u8bbe\u7f6e\uff0c\u5982\u679c\u6ca1\u6709\u5bf9\u5e94\u7684 key \u5219\u4f1a\u5c1d\u8bd5\u4f7f\u7528\u73af\u5883\u53d8\u91cf\uff09\n3. [\u73af\u5883\u53d8\u91cf](doc/config/env.md) DDNS_ \u524d\u7f00\u52a0\u4e0a key \uff08`${ddns_id}` \u6216 `${DDNS_ID}`\uff0c`${DDNS_LOG_LEVEL}`\uff09\n\n### \u914d\u7f6e\u4f18\u5148\u7ea7\u548c\u5b57\u6bb5\u8986\u76d6\u5173\u7cfb\n\n\u5982\u679c\u540c\u4e00\u4e2a\u914d\u7f6e\u9879\u5728\u591a\u4e2a\u5730\u65b9\u8bbe\u7f6e\uff0c\u5c06\u6309\u7167\u4ee5\u4e0b\u4f18\u5148\u7ea7\u89c4\u5219\u751f\u6548\uff1a\n\n- **\u547d\u4ee4\u884c\u53c2\u6570**\uff1a\u4f18\u5148\u7ea7\u6700\u9ad8\uff0c\u4f1a\u8986\u76d6\u5176\u4ed6\u6240\u6709\u8bbe\u7f6e\n- **JSON\u914d\u7f6e\u6587\u4ef6**\uff1a\u4ecb\u4e8e\u547d\u4ee4\u884c\u548c\u73af\u5883\u53d8\u91cf\u4e4b\u95f4\uff0c\u4f1a\u8986\u76d6\u73af\u5883\u53d8\u91cf\u4e2d\u7684\u8bbe\u7f6e\n- **\u73af\u5883\u53d8\u91cf**\uff1a\u4f18\u5148\u7ea7\u6700\u4f4e\uff0c\u5f53\u5176\u4ed6\u65b9\u5f0f\u672a\u8bbe\u7f6e\u65f6\u4f7f\u7528\n\n**\u9ad8\u7ea7\u7528\u6cd5**\uff1a\n\n- JSON\u914d\u7f6e\u4e2d\u660e\u786e\u8bbe\u4e3a`null`\u7684\u503c\u4f1a\u8986\u76d6\u73af\u5883\u53d8\u91cf\u8bbe\u7f6e\n- `debug`\u53c2\u6570\u53ea\u5728\u547d\u4ee4\u884c\u4e2d\u6709\u6548\uff0cJSON\u914d\u7f6e\u6587\u4ef6\u4e2d\u7684\u540c\u540d\u8bbe\u7f6e\u65e0\u6548\n- \u591a\u503c\u53c2\u6570\uff08\u5982`ipv4`\u3001`ipv6`\u7b49\uff09\u5728\u547d\u4ee4\u884c\u4e2d\u4f7f\u7528\u65b9\u5f0f\u4e3a\u91cd\u590d\u4f7f\u7528\u53c2\u6570\uff0c\u5982`--ipv4 domain1 --ipv4 domain2`\n\n\u5404\u914d\u7f6e\u65b9\u5f0f\u7684\u8be6\u7ec6\u8bf4\u660e\u8bf7\u67e5\u770b\u5bf9\u5e94\u6587\u6863\uff1a[\u547d\u4ee4\u884c](doc/config/cli.md)\u3001[JSON\u914d\u7f6e](doc/config/json.md)\u3001[\u73af\u5883\u53d8\u91cf](doc/config/env.md)\u3001[\u670d\u52a1\u5546\u914d\u7f6e](doc/providers/)\n\n> \ud83d\udcd6 **\u73af\u5883\u53d8\u91cf\u8be6\u7ec6\u914d\u7f6e**: \u67e5\u770b [\u73af\u5883\u53d8\u91cf\u914d\u7f6e\u6587\u6863](doc/config/env.md) \u4e86\u89e3\u6240\u6709\u73af\u5883\u53d8\u91cf\u7684\u8be6\u7ec6\u7528\u6cd5\u548c\u793a\u4f8b\n\n<details open>\n<summary markdown=\"span\">config.json \u914d\u7f6e\u6587\u4ef6</summary>\n\n- \u9996\u6b21\u8fd0\u884c\u4f1a\u81ea\u52a8\u751f\u6210\u4e00\u4e2a\u6a21\u677f\u914d\u7f6e\u6587\u4ef6\n- \u53ef\u4ee5\u4f7f\u7528 `-c` \u4f7f\u7528\u6307\u5b9a\u7684\u914d\u7f6e\u6587\u4ef6\uff08\u9ed8\u8ba4\u8bfb\u53d6\u5f53\u524d\u76ee\u5f55\u7684 config.json\uff09\n- \u63a8\u8350\u4f7f\u7528 vscode \u7b49\u652f\u6301 JsonSchema \u7684\u7f16\u8f91\u5668\u7f16\u8f91\u914d\u7f6e\u6587\u4ef6\n- \u67e5\u770b [JSON\u914d\u7f6e\u6587\u4ef6\u8be6\u7ec6\u6587\u6863](doc/config/json.md) \u4e86\u89e3\u5b8c\u6574\u7684\u914d\u7f6e\u9009\u9879\u548c\u793a\u4f8b\n\n```bash\nddns -c path/to/config.json\n# \u6216\u8005python\u8fd0\u884c\npython -m ddns -c /path/to/config.json\n# \u8fdc\u7a0b\u914d\u7f6e\u6587\u4ef6\nddns -c https://ddns.newfuture.cc/tests/config/debug.json\n```\n\n#### \u914d\u7f6e\u53c2\u6570\u8868\n\n|  key   |        type        | required |   default   |    description     | tips                                                                                                                                                                                     |\n| :----: | :----------------: | :------: | :---------: | :----------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|   id   |       string       |    \u221a     |     \u65e0      |    api \u8bbf\u95ee ID     | Cloudflare \u4e3a\u90ae\u7bb1\uff08\u4f7f\u7528 Token \u65f6\u7559\u7a7a\uff09<br>HE.net \u53ef\u7559\u7a7a<br>\u534e\u4e3a\u4e91\u4e3a Access Key ID (AK)                                                                                                   |\n| token  |       string       |    \u221a     |     \u65e0      |   api \u6388\u6743 token   | \u90e8\u5206\u5e73\u53f0\u53eb secret key\uff0c**\u53cd\u9988\u7c98\u8d34\u65f6\u5220\u9664**                                                                                                                                                |\n|  dns   |       string       |    No    | `\"dnspod\"`  |     dns \u670d\u52a1\u5546     | \u963f\u91cc DNS \u4e3a `alidns`\uff0c\u963f\u91ccESA\u4e3a `aliesa`\uff0cCloudflare \u4e3a `cloudflare`\uff0cdns.com \u4e3a `dnscom`\uff0cDNSPOD \u56fd\u5185\u4e3a `dnspod`\uff0cDNSPOD \u56fd\u9645\u4e3a `dnspod_com`\uff0cHE.net \u4e3a `he`\uff0c\u534e\u4e3a\u4e91\u4e3a `huaweidns`\uff0cNameSilo \u4e3a `namesilo`\uff0c\u817e\u8baf\u4e91\u4e3a `tencentcloud`\uff0c\u817e\u8baf\u4e91EdgeOne\u4e3a `edgeone`\uff0cNo-IP \u4e3a `noip`\uff0c\u81ea\u5b9a\u4e49\u56de\u8c03\u4e3a `callback`\u3002\u90e8\u5206\u670d\u52a1\u5546\u6709[\u8be6\u7ec6\u914d\u7f6e\u6587\u6863](doc/providers/) |\n|  ipv4  |       array        |    No    |    `[]`     |   ipv4 \u57df\u540d\u5217\u8868    | \u4e3a `[]` \u65f6\uff0c\u4e0d\u4f1a\u83b7\u53d6\u548c\u66f4\u65b0 IPv4 \u5730\u5740                                                                                                                                                     |\n|  ipv6  |       array        |    No    |    `[]`     |   ipv6 \u57df\u540d\u5217\u8868    | \u4e3a `[]` \u65f6\uff0c\u4e0d\u4f1a\u83b7\u53d6\u548c\u66f4\u65b0 IPv6 \u5730\u5740                                                                                                                                                     |\n| index4 | string\\|int\\|array |    No    | `\"default\"` |   ipv4 \u83b7\u53d6\u65b9\u5f0f    | \u53ef\u8bbe\u7f6e `\u7f51\u5361`\u3001`\u5185\u7f51`\u3001`\u516c\u7f51`\u3001`\u6b63\u5219` \u7b49\u65b9\u5f0f                                                                                                                                             |\n| index6 | string\\|int\\|array |    No    | `\"default\"` |   ipv6 \u83b7\u53d6\u65b9\u5f0f    | \u53ef\u8bbe\u7f6e `\u7f51\u5361`\u3001`\u5185\u7f51`\u3001`\u516c\u7f51`\u3001`\u6b63\u5219` \u7b49\u65b9\u5f0f                                                                                                                                             |\n|  ttl   |       number       |    No    |   `null`    | DNS \u89e3\u6790 TTL \u65f6\u95f4  | \u4e0d\u8bbe\u7f6e\u91c7\u7528 DNS \u9ed8\u8ba4\u7b56\u7565                                                                                                                                                                  |\n| proxy  |   string\\|array    |    No    |     \u65e0      | HTTP \u4ee3\u7406\u683c\u5f0f\uff1a`http://host:port` | \u591a\u4ee3\u7406\u9010\u4e2a\u5c1d\u8bd5\u76f4\u5230\u6210\u529f\uff0c`DIRECT` \u4e3a\u76f4\u8fde                                                                                                                                                  |\n|  ssl   |  string\\|boolean   |    No    |  `\"auto\"`   | SSL\u8bc1\u4e66\u9a8c\u8bc1\u65b9\u5f0f    | `true`\uff08\u5f3a\u5236\u9a8c\u8bc1\uff09\u3001`false`\uff08\u7981\u7528\u9a8c\u8bc1\uff09\u3001`\"auto\"`\uff08\u81ea\u52a8\u964d\u7ea7\uff09\u6216\u81ea\u5b9a\u4e49CA\u8bc1\u4e66\u6587\u4ef6\u8def\u5f84                                                                                    |\n| debug  |        bool        |    No    |   `false`   |    \u662f\u5426\u5f00\u542f\u8c03\u8bd5    | \u8c03\u8bd5\u6a21\u5f0f\uff0c\u4ec5\u547d\u4ee4\u884c\u53c2\u6570`--debug`\u6709\u6548                                                                                                                                    |\n| cache  |    string\\|bool    |    No    |   `true`    |    \u662f\u5426\u7f13\u5b58\u8bb0\u5f55    | \u6b63\u5e38\u60c5\u51b5\u6253\u5f00\u907f\u514d\u9891\u7e41\u66f4\u65b0\uff0c\u9ed8\u8ba4\u4f4d\u7f6e\u4e3a\u4e34\u65f6\u76ee\u5f55\u4e0b `ddns.cache`\uff0c\u4e5f\u53ef\u4ee5\u6307\u5b9a\u4e00\u4e2a\u5177\u4f53\u8def\u5f84                                                                                                      |\n|  log   |       object       |    No    |   `null`    |  \u65e5\u5fd7\u914d\u7f6e\uff08\u53ef\u9009\uff09  | \u65e5\u5fd7\u914d\u7f6e\u5bf9\u8c61\uff0c\u652f\u6301`level`\u3001`file`\u3001`format`\u3001`datefmt`\u53c2\u6570                                                                                                                               |\n\n#### index4 \u548c index6 \u53c2\u6570\u8bf4\u660e\n\n- \u6570\u5b57\uff08`0`\uff0c`1`\uff0c`2`\uff0c`3`\u7b49\uff09\uff1a\u7b2c i \u4e2a\u7f51\u5361 ip\n- \u5b57\u7b26\u4e32 `\"default\"`\uff08\u6216\u8005\u65e0\u6b64\u9879\uff09\uff1a\u7cfb\u7edf\u8bbf\u95ee\u5916\u7f51\u9ed8\u8ba4 IP\n- \u5b57\u7b26\u4e32 `\"public\"`\uff1a\u4f7f\u7528\u516c\u7f51 ip\uff08\u4f7f\u7528\u516c\u7f51 API \u67e5\u8be2\uff0curl \u7684\u7b80\u5316\u6a21\u5f0f\uff09\n- \u5b57\u7b26\u4e32 `\"url:xxx\"`\uff1a\u6253\u5f00 URL `xxx`\uff08\u5982\uff1a`\"url:http://ip.sb\"`\uff09\uff0c\u4ece\u8fd4\u56de\u7684\u6570\u636e\u63d0\u53d6 IP \u5730\u5740\n- \u5b57\u7b26\u4e32 `\"regex:xxx\"` \u6b63\u5219\u8868\u8fbe\uff08\u5982 `\"regex:192.*\"`\uff09\uff1a\u63d0\u53d6 `ifconfig`/`ipconfig` \u4e2d\u4e0e\u4e4b\u5339\u914d\u7684\u9996\u4e2a IP \u5730\u5740\uff0c**\u6ce8\u610f json \u8f6c\u4e49**\uff08`\\`\u8981\u5199\u6210`\\\\`\uff09\n  - `\"192.*\"` \u8868\u793a 192 \u5f00\u5934\u7684\u6240\u6709 ip\uff08\u6ce8\u610f `regex:` \u4e0d\u53ef\u7701\u7565\uff09\n  - \u5982\u679c\u60f3\u5339\u914d `10.00.xxxx` \u5e94\u8be5\u5199\u6210 `\"regex:10\\\\.00\\\\..*\"`\uff08`\"\\\\\"` json \u8f6c\u4e49\u6210 `\\`\uff09\n- \u5b57\u7b26\u4e32 `\"cmd:xxxx\"`\uff1a\u6267\u884c\u547d\u4ee4 `xxxx` \u7684 stdout \u8f93\u51fa\u7ed3\u679c\u4f5c\u4e3a\u76ee\u6807 IP\n- \u5b57\u7b26\u4e32 `\"shell:xxx\"`\uff1a\u4f7f\u7528\u7cfb\u7edf shell \u8fd0\u884c `xxx`\uff0c\u5e76\u628a\u7ed3\u679c stdout \u4f5c\u4e3a\u76ee\u6807 IP\n- `false`\uff1a\u5f3a\u5236\u7981\u6b62\u66f4\u65b0 ipv4 \u6216 ipv6 \u7684 DNS \u89e3\u6790\n- \u5217\u8868\uff1a\u4f9d\u6b21\u6267\u884c\u5217\u8868\u4e2d\u7684 index \u89c4\u5219\uff0c\u5e76\u5c06\u6700\u5148\u83b7\u5f97\u7684\u7ed3\u679c\u4f5c\u4e3a\u76ee\u6807 IP\n  - \u4f8b\u5982 `[\"public\", \"regex:172\\\\..*\"]` \u5c06\u5148\u67e5\u8be2\u516c\u7f51 API\uff0c\u672a\u83b7\u53d6\u5230 IP \u540e\u518d\u4ece\u672c\u5730\u5bfb\u627e 172 \u5f00\u5934\u7684 IP\n\n#### \u81ea\u5b9a\u4e49\u56de\u8c03\u914d\u7f6e\u8bf4\u660e\n\n- `id` \u5b57\u6bb5\u586b\u5199\u56de\u8c03\u5730\u5740\uff0c\u4ee5 HTTP \u6216 HTTPS \u5f00\u5934\uff0c\u63a8\u8350\u91c7\u7528 HTTPS \u65b9\u5f0f\u7684\u56de\u8c03 API\uff0c\u652f\u6301\u53d8\u91cf\u66ff\u6362\u529f\u80fd\u3002\n- `token` \u5b57\u6bb5\u4e3a POST \u8bf7\u6c42\u53c2\u6570\uff08JSON\u5bf9\u8c61\u6216JSON\u5b57\u7b26\u4e32\uff09\uff0c\u672c\u5b57\u6bb5\u4e3a\u7a7a\u6216\u4e0d\u5b58\u5728\u5219\u4f7f\u7528 GET \u65b9\u5f0f\u53d1\u8d77\u56de\u8c03\u3002\u5f53 JSON \u7684\u53c2\u6570\u503c\u5305\u542b\u4e0b\u8868\u6240\u793a\u7684\u5e38\u91cf\u5b57\u7b26\u4e32\u65f6\uff0c\u4f1a\u81ea\u52a8\u66ff\u6362\u4e3a\u5b9e\u9645\u5185\u5bb9\u3002\n\n\u8be6\u7ec6\u914d\u7f6e\u6307\u5357\u8bf7\u67e5\u770b\uff1a[Callback Provider \u914d\u7f6e\u6587\u6863](doc/providers/callback.md)\n\n| \u5e38\u91cf\u540d\u79f0         | \u5e38\u91cf\u5185\u5bb9                 | \u8bf4\u660e     |\n| ---------------- | ------------------------ | -------- |\n| `__DOMAIN__`     | DDNS \u57df\u540d                |          |\n| `__IP__`         | \u83b7\u53d6\u7684\u5bf9\u5e94\u7c7b\u578b\u7684 IP \u5730\u5740 |          |\n| `__RECORDTYPE__` | DDNS \u8bb0\u5f55\u7c7b\u578b            |          |\n| `__TTL__`        | DDNS TTL                 |          |\n| `__TIMESTAMP__`  | \u8bf7\u6c42\u53d1\u8d77\u65f6\u95f4\u6233           | \u5305\u542b\u5c0f\u6570 |\n\n#### \u914d\u7f6e\u793a\u4f8b\n\n```json\n{\n  \"$schema\": \"https://ddns.newfuture.cc/schema/v4.0.json\",\n  \"id\": \"12345\",\n  \"token\": \"mytokenkey\",\n  \"dns\": \"dnspod \u6216 dnspod_com \u6216 alidns \u6216 aliesa \u6216 dnscom \u6216 cloudflare \u6216 he \u6216 huaweidns \u6216 namesilo \u6216 tencentcloud \u6216 noip \u6216 callback\",\n  \"ipv4\": [\"ddns.newfuture.cc\", \"ipv4.ddns.newfuture.cc\"],\n  \"ipv6\": [\"ddns.newfuture.cc\", \"ipv6.ddns.newfuture.cc\"],\n  \"index4\": 0,\n  \"index6\": \"public\",\n  \"ttl\": 600,\n  \"proxy\": [\"http://127.0.0.1:1080\", \"DIRECT\"],\n  \"log\": {\n    \"level\": \"DEBUG\",\n    \"file\": \"dns.log\",\n    \"datefmt\": \"%Y-%m-%dT%H:%M:%S\"\n  }\n}\n```\n\n</details>\n\n## \u5b9a\u65f6\u4efb\u52a1\n\n<details>\n<summary markdown=\"span\">\u4f7f\u7528\u5185\u7f6e\u7684 task \u547d\u4ee4\u8bbe\u7f6e\u5b9a\u65f6\u4efb\u52a1\uff08\u9ed8\u8ba4\u6bcf 5 \u5206\u949f\u68c0\u67e5\u4e00\u6b21 IP\uff0c\u81ea\u52a8\u66f4\u65b0\uff09</summary>\n\nDDNS \u63d0\u4f9b\u5185\u7f6e\u7684 `task` \u5b50\u547d\u4ee4\u6765\u7ba1\u7406\u5b9a\u65f6\u4efb\u52a1\uff0c\u652f\u6301\u8de8\u5e73\u53f0\u81ea\u52a8\u5316\u90e8\u7f72\uff1a\n\n### \u9ad8\u7ea7\u7ba1\u7406\n\n```bash\n# \u5b89\u88c5\u5e76\u6307\u5b9a\u66f4\u65b0\u95f4\u9694\uff08\u5206\u949f\uff09\nddns task --install 10 -c /etc/config/ddns.json\n\n# \u542f\u7528/\u7981\u7528\u4efb\u52a1\nddns task --enable\nddns task --disable\n```\n\n\u8be6\u7ec6\u914d\u7f6e\u6307\u5357\u8bf7\u53c2\u8003\uff1a[\u547d\u4ee4\u884c\u53c2\u6570\u6587\u6863](https://ddns.newfuture.cc/doc/config/cli.md#task-management-\u5b9a\u65f6\u4efb\u52a1\u7ba1\u7406)\n\n### Docker\n\nDocker \u955c\u50cf\u5728\u65e0\u989d\u5916\u53c2\u6570\u7684\u60c5\u51b5\u4e0b\uff0c\u5df2\u9ed8\u8ba4\u542f\u7528\u6bcf 5 \u5206\u949f\u6267\u884c\u4e00\u6b21\u7684\u5b9a\u65f6\u4efb\u52a1\n\n</details>\n\n<details>\n<summary markdown=\"span\">\u95ee\u9898\u6392\u67e5\u53cd\u9988</summary>\n\n1. \u5148\u786e\u8ba4\u6392\u67e5\u662f\u5426\u662f\u7cfb\u7edf/\u7f51\u7edc\u73af\u5883\u95ee\u9898\n2. \u5728 [issues](https://github.com/NewFuture/DDNS/issues) \u4e2d\u641c\u7d22\u662f\u5426\u6709\u7c7b\u4f3c\u95ee\u9898\n3. \u524d\u4e24\u8005\u5747\u65e0\u6cd5\u89e3\u51b3\u6216\u8005\u786e\u5b9a\u662f bug\uff0c[\u5728\u6b64\u65b0\u5efa issue](https://github.com/NewFuture/DDNS/issues/new)\n   - [ ] \u5f00\u542f `--debug`\n   - [ ] \u9644\u4e0a\u8fd9\u4e9b\u5185\u5bb9 **\u8fd0\u884c\u7248\u672c\u548c\u65b9\u5f0f**\u3001**\u7cfb\u7edf\u73af\u5883**\u3001**\u51fa\u9519\u65e5\u5fd7**\u3001**\u53bb\u6389 id/token** \u7684\u914d\u7f6e\u6587\u4ef6\n   - [ ] \u6e90\u7801\u8fd0\u884c\u6ce8\u660e\u4f7f\u7528\u7684 python \u73af\u5883\n\n</details>\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Dynamic DNS client for multiple providers, supporting IPv4 and IPv6.",
    "version": "4.1.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/NewFuture/DDNS/issues",
        "Documentation": "https://ddns.newfuture.cc",
        "Homepage": "https://ddns.newfuture.cc",
        "Repository": "https://github.com/NewFuture/DDNS",
        "Source": "https://github.com/NewFuture/DDNS"
    },
    "split_keywords": [
        "ddns",
        " ipv6",
        " ipv4",
        " dns",
        " dnspod",
        " alidns",
        " cloudflare"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ff5d66587a6ff3860f39adc0953602ddfd138a3adc52e46c0919061e46908f1f",
                "md5": "22b18fbd303da5aa7c84f113f7bd0473",
                "sha256": "d11a272be94bd0c295d63ecb01948ed21bde38c385a1f234de9bad2d90577fa7"
            },
            "downloads": -1,
            "filename": "ddns-4.1.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "22b18fbd303da5aa7c84f113f7bd0473",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.7",
            "size": 76591,
            "upload_time": "2025-10-31T07:37:16",
            "upload_time_iso_8601": "2025-10-31T07:37:16.568105Z",
            "url": "https://files.pythonhosted.org/packages/ff/5d/66587a6ff3860f39adc0953602ddfd138a3adc52e46c0919061e46908f1f/ddns-4.1.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a4497b82d7c6a0b4c3fda1c75dc433833ee28b26d3c90c7f91d0073a2fc6478d",
                "md5": "840dad7dda599340f608f3b26132b32f",
                "sha256": "4d2f6faec28330d7e8f6628c43fbf9f8703e5f4bf6140ca5e019cf5c909a2a6a"
            },
            "downloads": -1,
            "filename": "ddns-4.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "840dad7dda599340f608f3b26132b32f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7",
            "size": 170266,
            "upload_time": "2025-10-31T07:37:18",
            "upload_time_iso_8601": "2025-10-31T07:37:18.378314Z",
            "url": "https://files.pythonhosted.org/packages/a4/49/7b82d7c6a0b4c3fda1c75dc433833ee28b26d3c90c7f91d0073a2fc6478d/ddns-4.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-31 07:37:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NewFuture",
    "github_project": "DDNS",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ddns"
}
        
Elapsed time: 2.78114s