ddns 4.0.2__tar.gz → 4.1.0b2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of ddns might be problematic. Click here for more details.

Files changed (77) hide show
  1. {ddns-4.0.2 → ddns-4.1.0b2}/PKG-INFO +109 -75
  2. ddns-4.1.0b2/README.md +315 -0
  3. ddns-4.1.0b2/ddns/__builtins__.pyi +5 -0
  4. ddns-4.1.0b2/ddns/__init__.py +12 -0
  5. ddns-4.1.0b2/ddns/__main__.py +118 -0
  6. ddns-4.1.0b2/ddns/cache.py +183 -0
  7. {ddns-4.0.2/ddns/util → ddns-4.1.0b2/ddns}/ip.py +26 -21
  8. ddns-4.1.0b2/ddns/provider/__init__.py +79 -0
  9. ddns-4.1.0b2/ddns/provider/_base.py +539 -0
  10. ddns-4.1.0b2/ddns/provider/_signature.py +113 -0
  11. ddns-4.1.0b2/ddns/provider/alidns.py +151 -0
  12. ddns-4.1.0b2/ddns/provider/aliesa.py +129 -0
  13. ddns-4.1.0b2/ddns/provider/callback.py +78 -0
  14. ddns-4.1.0b2/ddns/provider/cloudflare.py +99 -0
  15. ddns-4.1.0b2/ddns/provider/debug.py +20 -0
  16. ddns-4.1.0b2/ddns/provider/dnscom.py +102 -0
  17. ddns-4.1.0b2/ddns/provider/dnspod.py +116 -0
  18. ddns-4.1.0b2/ddns/provider/dnspod_com.py +18 -0
  19. ddns-4.1.0b2/ddns/provider/edgeone.py +82 -0
  20. ddns-4.1.0b2/ddns/provider/he.py +46 -0
  21. ddns-4.1.0b2/ddns/provider/huaweidns.py +142 -0
  22. ddns-4.1.0b2/ddns/provider/namesilo.py +159 -0
  23. ddns-4.1.0b2/ddns/provider/noip.py +103 -0
  24. ddns-4.1.0b2/ddns/provider/tencentcloud.py +195 -0
  25. ddns-4.1.0b2/ddns/util/comment.py +88 -0
  26. ddns-4.1.0b2/ddns/util/http.py +228 -0
  27. {ddns-4.0.2 → ddns-4.1.0b2}/ddns.egg-info/PKG-INFO +109 -75
  28. ddns-4.1.0b2/ddns.egg-info/SOURCES.txt +60 -0
  29. ddns-4.1.0b2/ddns.egg-info/requires.txt +14 -0
  30. {ddns-4.0.2 → ddns-4.1.0b2}/pyproject.toml +86 -23
  31. ddns-4.1.0b2/tests/test_cache.py +671 -0
  32. ddns-4.1.0b2/tests/test_config_cli.py +547 -0
  33. ddns-4.1.0b2/tests/test_config_config.py +393 -0
  34. ddns-4.1.0b2/tests/test_config_env.py +552 -0
  35. ddns-4.1.0b2/tests/test_config_file.py +572 -0
  36. ddns-4.1.0b2/tests/test_config_init.py +427 -0
  37. ddns-4.1.0b2/tests/test_provider__signature.py +359 -0
  38. ddns-4.1.0b2/tests/test_provider_alidns.py +536 -0
  39. ddns-4.1.0b2/tests/test_provider_aliesa.py +533 -0
  40. ddns-4.1.0b2/tests/test_provider_base.py +235 -0
  41. ddns-4.1.0b2/tests/test_provider_base_simple.py +248 -0
  42. ddns-4.1.0b2/tests/test_provider_callback.py +433 -0
  43. ddns-4.1.0b2/tests/test_provider_cloudflare.py +556 -0
  44. ddns-4.1.0b2/tests/test_provider_debug.py +221 -0
  45. ddns-4.1.0b2/tests/test_provider_dnscom.py +417 -0
  46. ddns-4.1.0b2/tests/test_provider_dnspod.py +541 -0
  47. ddns-4.1.0b2/tests/test_provider_dnspod_com.py +74 -0
  48. ddns-4.1.0b2/tests/test_provider_edgeone.py +507 -0
  49. ddns-4.1.0b2/tests/test_provider_he.py +370 -0
  50. ddns-4.1.0b2/tests/test_provider_huaweidns.py +485 -0
  51. ddns-4.1.0b2/tests/test_provider_namesilo.py +317 -0
  52. ddns-4.1.0b2/tests/test_provider_noip.py +386 -0
  53. ddns-4.1.0b2/tests/test_provider_tencentcloud.py +556 -0
  54. ddns-4.1.0b2/tests/test_util_comment.py +248 -0
  55. ddns-4.1.0b2/tests/test_util_http.py +270 -0
  56. ddns-4.0.2/README.md +0 -286
  57. ddns-4.0.2/ddns/__init__.py +0 -19
  58. ddns-4.0.2/ddns/__main__.py +0 -187
  59. ddns-4.0.2/ddns/provider/alidns.py +0 -183
  60. ddns-4.0.2/ddns/provider/callback.py +0 -117
  61. ddns-4.0.2/ddns/provider/cloudflare.py +0 -163
  62. ddns-4.0.2/ddns/provider/dnscom.py +0 -180
  63. ddns-4.0.2/ddns/provider/dnspod.py +0 -186
  64. ddns-4.0.2/ddns/provider/dnspod_com.py +0 -15
  65. ddns-4.0.2/ddns/provider/he.py +0 -83
  66. ddns-4.0.2/ddns/provider/huaweidns.py +0 -265
  67. ddns-4.0.2/ddns/util/__init__.py +0 -0
  68. ddns-4.0.2/ddns/util/cache.py +0 -139
  69. ddns-4.0.2/ddns/util/config.py +0 -317
  70. ddns-4.0.2/ddns.egg-info/SOURCES.txt +0 -25
  71. ddns-4.0.2/ddns.egg-info/requires.txt +0 -4
  72. {ddns-4.0.2 → ddns-4.1.0b2}/LICENSE +0 -0
  73. {ddns-4.0.2/ddns/provider → ddns-4.1.0b2/ddns/util}/__init__.py +0 -0
  74. {ddns-4.0.2 → ddns-4.1.0b2}/ddns.egg-info/dependency_links.txt +0 -0
  75. {ddns-4.0.2 → ddns-4.1.0b2}/ddns.egg-info/entry_points.txt +0 -0
  76. {ddns-4.0.2 → ddns-4.1.0b2}/ddns.egg-info/top_level.txt +0 -0
  77. {ddns-4.0.2 → ddns-4.1.0b2}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ddns
3
- Version: 4.0.2
3
+ Version: 4.1.0b2
4
4
  Summary: Dynamic DNS client for multiple providers, supporting IPv4 and IPv6.
5
5
  Author-email: NewFuture <python@newfuture.cc>
6
6
  License-Expression: MIT
@@ -36,6 +36,11 @@ License-File: LICENSE
36
36
  Provides-Extra: dev
37
37
  Requires-Dist: black; extra == "dev"
38
38
  Requires-Dist: flake8; extra == "dev"
39
+ Requires-Dist: mock; python_version < "3.3" and extra == "dev"
40
+ Provides-Extra: pytest
41
+ Requires-Dist: pytest>=6.0; extra == "pytest"
42
+ Requires-Dist: pytest-cov; extra == "pytest"
43
+ Requires-Dist: mock; python_version < "3.3" and extra == "pytest"
39
44
  Dynamic: license-file
40
45
 
41
46
  # [<img src="https://ddns.newfuture.cc/doc/img/ddns.svg" width="32px" height="32px"/>](https://ddns.newfuture.cc) [DDNS](https://github.com/NewFuture/DDNS)
@@ -62,6 +67,7 @@ Dynamic: license-file
62
67
  - [命令行参数](https://ddns.newfuture.cc/doc/cli.html)
63
68
  - [JSON 配置文件](https://ddns.newfuture.cc/doc/json.html)
64
69
  - [环境变量配置](https://ddns.newfuture.cc/doc/env.html)
70
+ - [服务商配置指南](https://ddns.newfuture.cc/doc/providers/)
65
71
 
66
72
  - 域名支持:
67
73
  - 多个域名支持
@@ -76,16 +82,25 @@ Dynamic: license-file
76
82
  - http 代理支持
77
83
  - 多代理自动切换
78
84
  - 服务商支持:
79
- - [DNSPOD](https://www.dnspod.cn/)
80
- - [阿里 DNS](http://www.alidns.com/)
81
- - [DNS.COM](https://www.dns.com/) (@loftor-git)
82
- - [DNSPOD 国际版](https://www.dnspod.com/)
83
- - [CloudFlare](https://www.cloudflare.com/) (@tongyifan)
84
- - [HE.net](https://dns.he.net/) (@NN708) (不支持自动创建记录)
85
- - [华为云](https://huaweicloud.com/) (@cybmp3)
85
+ - [DNSPOD](https://www.dnspod.cn/) ([配置指南](doc/providers/dnspod.md))
86
+ - [阿里 DNS](http://www.alidns.com/) ([配置指南](doc/providers/alidns.md)) ⚡
87
+ - [阿里云边缘安全加速(ESA)](https://esa.console.aliyun.com/) ([配置指南](doc/providers/aliesa.md)) ⚡
88
+ - [DNS.COM](https://www.dns.com/) ([配置指南](doc/providers/51dns.md)) (@loftor-git)
89
+ - [DNSPOD 国际版](https://www.dnspod.com/) ([配置指南](doc/providers/dnspod_com.md))
90
+ - [CloudFlare](https://www.cloudflare.com/) ([配置指南](doc/providers/cloudflare.md)) (@tongyifan)
91
+ - [HE.net](https://dns.he.net/) ([配置指南](doc/providers/he.md)) (@NN708) (不支持自动创建记录)
92
+ - [华为云](https://huaweicloud.com/) ([配置指南](doc/providers/huaweidns.md)) (@cybmp3) ⚡
93
+ - [NameSilo](https://www.namesilo.com/) ([配置指南](doc/providers/namesilo.md))
94
+ - [腾讯云](https://cloud.tencent.com/) ([配置指南](doc/providers/tencentcloud.md)) ⚡
95
+ - [腾讯云 EdgeOne](https://cloud.tencent.com/product/teo) ([配置指南](doc/providers/edgeone.md)) ⚡
96
+ - [No-IP](https://www.noip.com/) ([配置指南](doc/providers/noip.md))
97
+ - 自定义回调 API ([配置指南](doc/providers/callback.md))
98
+
99
+ > ⚡ 标记的服务商使用高级 HMAC-SHA256 签名认证,提供企业级安全保障
86
100
  - 其他:
87
101
  - 可设置定时任务
88
102
  - TTL 配置支持
103
+ - DNS 线路(运营商)配置支持(国内服务商)
89
104
  - 本地文件缓存(减少 API 请求)
90
105
  - 地址变更时触发自定义回调 API(与 DDNS 功能互斥)
91
106
 
@@ -97,60 +112,70 @@ Dynamic: license-file
97
112
 
98
113
  推荐 Docker 版,兼容性最佳,体积小,性能优化。
99
114
 
100
- - #### pip 安装(需要 pip 或 easy_install
115
+ - #### Docker(需要安装 Docker
101
116
 
102
- 1. 安装 ddns: `pip install ddns` 或 `easy_install ddns`
103
- 2. 运行: `ddns`
117
+ 详细说明和高级用法请查看 [Docker 使用文档](https://ddns.newfuture.cc/doc/docker.html)
104
118
 
105
- - #### 二进制版(单文件,无需 python)
119
+ <details>
120
+ <summary markdown="span">支持命令行,配置文件,和环境变量传参</summary>
106
121
 
107
- - Windows [ddns.exe](https://github.com/NewFuture/DDNS/releases/latest)
108
- - Linux(仅 Ubuntu 测试) [ddns](https://github.com/NewFuture/DDNS/releases/latest)
109
- - Mac OSX [ddns-mac](https://github.com/NewFuture/DDNS/releases/latest)
122
+ - 命令行cli
110
123
 
111
- - #### 源码运行(无任何依赖,需 python 环境)
124
+ ```sh
125
+ docker run newfuture/ddns -h
126
+ ```
112
127
 
113
- 1. clone 或者 [下载此仓库](https://github.com/NewFuture/DDNS/archive/master.zip) 并解压
114
- 2. 运行 ./run.py(windows 双击 `run.bat` 或者运行 `python run.py`)
128
+ - 使用配置文件(docker 工作目录 `/ddns/`,默认配置位置 `/ddns/config.json`):
115
129
 
116
- - #### Docker(需要安装 Docker)
130
+ ```sh
131
+ docker run -d -v /host/config/:/ddns/ --network host newfuture/ddns
132
+ ```
117
133
 
118
134
  - 使用环境变量:
119
135
 
120
- ```sh
121
- docker run -d \
122
- -e DDNS_DNS=dnspod \
123
- -e DDNS_ID=12345 \
124
- -e DDNS_TOKEN=mytokenkey \
125
- -e DDNS_IPV4=ddns.newfuture.cc \
126
- -e DDNS_IPV6=ddns.newfuture.cc \
127
- --network host \
128
- newfuture/ddns
129
- ```
136
+ ```sh
137
+ docker run -d \
138
+ -e DDNS_DNS=dnspod \
139
+ -e DDNS_ID=12345 \
140
+ -e DDNS_TOKEN=mytokenkey \
141
+ -e DDNS_IPV4=ddns.newfuture.cc \
142
+ --network host \
143
+ newfuture/ddns
144
+ ```
130
145
 
131
- - 使用配置文件(docker 工作目录 `/ddns/`,默认配置位置 `/ddns/config.json`):
146
+ </details>
147
+
148
+ - #### pip 安装(需要 pip 或 easy_install)
149
+
150
+ 1. 安装 ddns: `pip install ddns` 或 `easy_install ddns`
151
+ 2. 运行: `ddns -h` 或者 `python -m ddns`
152
+
153
+ - #### 二进制版(单文件,无需 python)
132
154
 
133
- ```sh
134
- docker run -d \
135
- -v /local/config/path/:/ddns/ \
136
- --network host \
137
- newfuture/ddns
138
- ```
155
+ 前往[release下载对应版本](https://github.com/NewFuture/DDNS/releases/latest)
139
156
 
140
- 更多详细说明和高级用法请查看 [Docker 使用文档](doc/docker.md)。
157
+ - #### 源码运行(无任何依赖,需 python 环境)
158
+
159
+ 1. clone 或者 [下载此仓库](https://github.com/NewFuture/DDNS/archive/master.zip) 并解压
160
+ 2. 运行 `python run.py` 或者 `python -m ddns`
141
161
 
142
162
  ### ② 快速配置
143
163
 
144
164
  1. 申请 api `token`,填写到对应的 `id` 和 `token` 字段:
145
165
 
146
- - [DNSPOD(国内版)创建 token](https://support.dnspod.cn/Kb/showarticle/tsid/227/)
147
- - [阿里云 accesskey](https://help.aliyun.com/document_detail/87745.htm)
148
- - [DNS.COM API Key/Secret](https://www.dns.com/member/apiSet)
149
- - [DNSPOD(国际版)](https://www.dnspod.com/docs/info.html#get-the-user-token)
150
- - [CloudFlare API Key](https://support.cloudflare.com/hc/en-us/articles/200167836-Where-do-I-find-my-Cloudflare-API-key-)(除了 `email + API KEY`,也可使用 `Token`,需要列出 Zone 权限)
151
- - [HE.net DDNS 文档](https://dns.he.net/docs.html)(仅需将设置的密码填入 `token` 字段,`id` 字段可留空)
152
- - [华为 APIKEY 申请](https://console.huaweicloud.com/iam/)(点左边访问密钥,然后点新增访问密钥)
153
- - 自定义回调的参数填写方式请查看下方的自定义回调配置说明
166
+ - **DNSPOD(中国版)**: [创建 token](https://support.dnspod.cn/Kb/showarticle/tsid/227/) | [详细配置文档](doc/providers/dnspod.md)
167
+ - **阿里云 DNS**: [申请 accesskey](https://help.aliyun.com/document_detail/87745.htm) | [详细配置文档](doc/providers/alidns.md)
168
+ - **阿里云边缘安全加速(ESA)**: [申请 accesskey](https://help.aliyun.com/document_detail/87745.htm) | [详细配置文档](doc/providers/aliesa.md)
169
+ - **51DNS(dns.com)**: [API Key/Secret](https://www.dns.com/member/apiSet) | [详细配置文档](doc/providers/51dns.md)
170
+ - **DNSPOD(国际版)**: [获取 token](https://www.dnspod.com/docs/info.html#get-the-user-token) | [详细配置文档](doc/providers/dnspod_com.md)
171
+ - **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)
172
+ - **HE.net**: [DDNS 文档](https://dns.he.net/docs.html)(仅需将设置的密码填入 `token` 字段,`id` 字段可留空) | [详细配置文档](doc/providers/he.md)
173
+ - **华为云 DNS**: [APIKEY 申请](https://console.huaweicloud.com/iam/)(点左边访问密钥,然后点新增访问密钥) | [详细配置文档](doc/providers/huaweidns.md)
174
+ - **NameSilo**: [API Key](https://www.namesilo.com/account/api-manager)(API Manager 中获取 API Key) | [详细配置文档](doc/providers/namesilo.md)
175
+ - **腾讯云 DNS**: [详细配置文档](doc/providers/tencentcloud.md)
176
+ - **腾讯云 EdgeOne**: [详细配置文档](doc/providers/edgeone.md)
177
+ - **No-IP**: [用户名和密码](https://www.noip.com/)(使用 No-IP 账户的用户名和密码) | [详细配置文档](doc/providers/noip.md)
178
+ - **自定义回调**: 参数填写方式请查看下方的自定义回调配置说明
154
179
 
155
180
  2. 修改配置文件,`ipv4` 和 `ipv6` 字段,为待更新的域名,详细参照配置说明
156
181
 
@@ -170,12 +195,13 @@ Dynamic: license-file
170
195
  - **JSON配置文件**:介于命令行和环境变量之间,会覆盖环境变量中的设置
171
196
  - **环境变量**:优先级最低,当其他方式未设置时使用
172
197
 
173
- **特殊情况**:
198
+ **高级用法**:
199
+
174
200
  - JSON配置中明确设为`null`的值会覆盖环境变量设置
175
201
  - `debug`参数只在命令行中有效,JSON配置文件中的同名设置无效
176
202
  - 多值参数(如`ipv4`、`ipv6`等)在命令行中使用方式为重复使用参数,如`--ipv4 domain1 --ipv4 domain2`
177
203
 
178
- 各配置方式的详细说明请查看对应文档:[命令行](doc/cli.md)、[JSON配置](doc/json.md)、[环境变量](doc/env.md)
204
+ 各配置方式的详细说明请查看对应文档:[命令行](doc/cli.md)、[JSON配置](doc/json.md)、[环境变量](doc/env.md)、[服务商配置](doc/providers/)
179
205
 
180
206
  > 📖 **环境变量详细配置**: 查看 [环境变量配置文档](doc/env.md) 了解所有环境变量的详细用法和示例
181
207
 
@@ -189,26 +215,27 @@ Dynamic: license-file
189
215
 
190
216
  ```bash
191
217
  ddns -c path/to/config.json
192
- # 或者源码运行
193
- python run.py -c /path/to/config.json
218
+ # 或者python运行
219
+ python -m ddns -c /path/to/config.json
194
220
  ```
195
221
 
196
222
  #### 配置参数表
197
223
 
198
- | key | type | required | default | description | tips |
199
- | :------: | :----------------: | :------: | :---------: | :---------------: | ----------------------------------------------------------------------------------------------------------- |
200
- | id | string | √ | 无 | api 访问 ID | Cloudflare 为邮箱(使用 Token 时留空)<br>HE.net 可留空<br>华为云为 Access Key ID (AK) |
201
- | token | string | √ | 无 | api 授权 token | 部分平台叫 secret key,**反馈粘贴时删除** |
202
- | dns | string | No | `"dnspod"` | dns 服务商 | 阿里 DNS 为 `alidns`,Cloudflare 为 `cloudflare`,dns.com 为 `dnscom`,DNSPOD 国内为 `dnspod`,DNSPOD 国际为 `dnspod_com`,HE.net 为 `he`,华为云为 `huaweidns`,自定义回调为 `callback` |
203
- | ipv4 | array | No | `[]` | ipv4 域名列表 | 为 `[]` 时,不会获取和更新 IPv4 地址 |
204
- | ipv6 | array | No | `[]` | ipv6 域名列表 | 为 `[]` 时,不会获取和更新 IPv6 地址 |
205
- | index4 | string\|int\|array | No | `"default"` | ipv4 获取方式 | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式 |
206
- | index6 | string\|int\|array | No | `"default"` | ipv6 获取方式 | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式 |
207
- | ttl | number | No | `null` | DNS 解析 TTL 时间 | 不设置采用 DNS 默认策略 |
208
- | proxy | string\|array | No | 无 | http 代理 `;` 分割 | 多代理逐个尝试直到成功,`DIRECT` 为直连 |
209
- | debug | bool | No | `false` | 是否开启调试 | 等同于设置 log.level=DEBUG,仅命令行参数`--debug`有效 |
210
- | cache | string\|bool | No | `true` | 是否缓存记录 | 正常情况打开避免频繁更新,默认位置为临时目录下 `ddns.cache`,也可以指定一个具体路径 |
211
- | log | object | No | `null` | 日志配置(可选) | 日志配置对象,支持`level`、`file`、`format`、`datefmt`参数 |
224
+ | key | type | required | default | description | tips |
225
+ | :----: | :----------------: | :------: | :---------: | :----------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
226
+ | id | string | √ | 无 | api 访问 ID | Cloudflare 为邮箱(使用 Token 时留空)<br>HE.net 可留空<br>华为云为 Access Key ID (AK) |
227
+ | token | string | √ | 无 | api 授权 token | 部分平台叫 secret key,**反馈粘贴时删除** |
228
+ | 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/) |
229
+ | ipv4 | array | No | `[]` | ipv4 域名列表 | 为 `[]` 时,不会获取和更新 IPv4 地址 |
230
+ | ipv6 | array | No | `[]` | ipv6 域名列表 | 为 `[]` 时,不会获取和更新 IPv6 地址 |
231
+ | index4 | string\|int\|array | No | `"default"` | ipv4 获取方式 | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式 |
232
+ | index6 | string\|int\|array | No | `"default"` | ipv6 获取方式 | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式 |
233
+ | ttl | number | No | `null` | DNS 解析 TTL 时间 | 不设置采用 DNS 默认策略 |
234
+ | proxy | string\|array | No | 无 | http 代理 `;` 分割 | 多代理逐个尝试直到成功,`DIRECT` 为直连 |
235
+ | ssl | string\|boolean | No | `"auto"` | SSL证书验证方式 | `true`(强制验证)、`false`(禁用验证)、`"auto"`(自动降级)或自定义CA证书文件路径 |
236
+ | debug | bool | No | `false` | 是否开启调试 | 调试模式,仅命令行参数`--debug`有效 |
237
+ | cache | string\|bool | No | `true` | 是否缓存记录 | 正常情况打开避免频繁更新,默认位置为临时目录下 `ddns.cache`,也可以指定一个具体路径 |
238
+ | log | object | No | `null` | 日志配置(可选) | 日志配置对象,支持`level`、`file`、`format`、`datefmt`参数 |
212
239
 
213
240
  #### index4 和 index6 参数说明
214
241
 
@@ -227,16 +254,18 @@ python run.py -c /path/to/config.json
227
254
 
228
255
  #### 自定义回调配置说明
229
256
 
230
- - `id` 字段填写回调地址,以 HTTP 或 HTTPS 开头,推荐采用 HTTPS 方式的回调 API ,当 `token` 字段非空且 URL 参数包含下表所示的常量字符串时,会自动替换为实际内容。
231
- - `token` 字段为 POST 参数,本字段为空或不存在则使用 GET 方式发起回调,回调参数采用 JSON 格式编码,当 JSON 的首层参数值包含下表所示的常量字符串时,会自动替换为实际内容。
257
+ - `id` 字段填写回调地址,以 HTTP 或 HTTPS 开头,推荐采用 HTTPS 方式的回调 API,支持变量替换功能。
258
+ - `token` 字段为 POST 请求参数(JSON对象或JSON字符串),本字段为空或不存在则使用 GET 方式发起回调。当 JSON 的参数值包含下表所示的常量字符串时,会自动替换为实际内容。
232
259
 
233
- | 常量名称 | 常量内容 | 说明 |
234
- | ---------------- | ---------------------- | -------- |
235
- | `__DOMAIN__` | DDNS 域名 | |
236
- | `__RECORDTYPE__` | DDNS 记录类型 | |
237
- | `__TTL__` | DDNS TTL | |
238
- | `__TIMESTAMP__` | 请求发起时间戳 | 包含小数 |
260
+ 详细配置指南请查看:[Callback Provider 配置文档](doc/providers/callback.md)
261
+
262
+ | 常量名称 | 常量内容 | 说明 |
263
+ | ---------------- | ------------------------ | -------- |
264
+ | `__DOMAIN__` | DDNS 域名 | |
239
265
  | `__IP__` | 获取的对应类型的 IP 地址 | |
266
+ | `__RECORDTYPE__` | DDNS 记录类型 | |
267
+ | `__TTL__` | DDNS TTL | |
268
+ | `__TIMESTAMP__` | 请求发起时间戳 | 包含小数 |
240
269
 
241
270
  #### 配置示例
242
271
 
@@ -245,21 +274,21 @@ python run.py -c /path/to/config.json
245
274
  "$schema": "https://ddns.newfuture.cc/schema/v4.0.json",
246
275
  "id": "12345",
247
276
  "token": "mytokenkey",
248
- "dns": "dnspod 或 dnspod_com 或 alidns 或 dnscom 或 cloudflare 或 he 或 huaweidns 或 callback",
277
+ "dns": "dnspod 或 dnspod_com 或 alidns 或 aliesa 或 dnscom 或 cloudflare 或 he 或 huaweidns 或 namesilo 或 tencentcloud 或 noip 或 callback",
249
278
  "ipv4": ["ddns.newfuture.cc", "ipv4.ddns.newfuture.cc"],
250
279
  "ipv6": ["ddns.newfuture.cc", "ipv6.ddns.newfuture.cc"],
251
280
  "index4": 0,
252
281
  "index6": "public",
253
282
  "ttl": 600,
254
- "proxy": "127.0.0.1:1080;DIRECT",
283
+ "proxy": ["127.0.0.1:1080", "DIRECT"],
255
284
  "log": {
256
285
  "level": "DEBUG",
257
286
  "file": "dns.log",
258
- "format": "%(asctime)s %(levelname)s [%(module)s]: %(message)s",
259
287
  "datefmt": "%Y-%m-%dT%H:%M:%S"
260
288
  }
261
289
  }
262
290
  ```
291
+
263
292
  </details>
264
293
 
265
294
  ## 定时任务
@@ -275,10 +304,13 @@ python run.py -c /path/to/config.json
275
304
  #### Linux
276
305
 
277
306
  - 使用 init.d 和 crontab:
307
+
278
308
  ```bash
279
309
  sudo ./task.sh
280
310
  ```
311
+
281
312
  - 使用 systemd:
313
+
282
314
  ```bash
283
315
  安装:
284
316
  sudo ./systemd.sh install
@@ -306,11 +338,13 @@ Docker 镜像在无额外参数的情况下,已默认启用每 5 分钟执行
306
338
  使用系统自带的 IE 浏览器访问一次对应的 API 即可
307
339
 
308
340
  - alidns 打开: <https://alidns.aliyuncs.com>
341
+ - aliesa 打开: <https://esa.cn-hangzhou.aliyuncs.com>
309
342
  - cloudflare 打开: <https://api.cloudflare.com>
310
343
  - dns.com 打开: <https://www.dns.com>
311
344
  - dnspod.cn 打开: <https://dnsapi.cn>
312
345
  - dnspod 国际版: <https://api.dnspod.com>
313
346
  - 华为 DNS <https://dns.myhuaweicloud.com>
347
+
314
348
  </details>
315
349
 
316
350
  <details>
@@ -319,7 +353,7 @@ Docker 镜像在无额外参数的情况下,已默认启用每 5 分钟执行
319
353
  1. 先确认排查是否是系统/网络环境问题
320
354
  2. 在 [issues](https://github.com/NewFuture/DDNS/issues) 中搜索是否有类似问题
321
355
  3. 前两者均无法解决或者确定是 bug,[在此新建 issue](https://github.com/NewFuture/DDNS/issues/new)
322
- - [ ] 开启 debug 配置
356
+ - [ ] 开启 `--debug`
323
357
  - [ ] 附上这些内容 **运行版本和方式**、**系统环境**、**出错日志**、**去掉 id/token** 的配置文件
324
358
  - [ ] 源码运行注明使用的 python 环境
325
359
 
ddns-4.1.0b2/README.md ADDED
@@ -0,0 +1,315 @@
1
+ # [<img src="https://ddns.newfuture.cc/doc/img/ddns.svg" width="32px" height="32px"/>](https://ddns.newfuture.cc) [DDNS](https://github.com/NewFuture/DDNS)
2
+
3
+ > 自动更新 DNS 解析 到本机 IP 地址,支持 IPv4 和 IPv6,本地(内网)IP 和公网 IP。
4
+ > 代理模式,支持自动创建 DNS 记录。
5
+
6
+ [![Github Release](https://img.shields.io/github/v/release/NewFuture/DDNS?&logo=github&style=flatten
7
+ )](https://github.com/NewFuture/DDNS/releases/latest)
8
+ [![PyPI](https://img.shields.io/pypi/v/ddns.svg?label=ddns&logo=pypi&style=flatten)](https://pypi.org/project/ddns/)
9
+ [![Docker Image Version](https://img.shields.io/docker/v/newfuture/ddns?label=newfuture/ddns&logo=docker&&sort=semver&style=flatten)](https://hub.docker.com/r/newfuture/ddns)
10
+ [![Build Status](https://github.com/NewFuture/DDNS/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/NewFuture/DDNS/actions/workflows/build.yml)
11
+ [![Publish](https://github.com/NewFuture/DDNS/actions/workflows/publish.yml/badge.svg)](https://github.com/NewFuture/DDNS/actions/workflows/publish.yml)
12
+
13
+ ---
14
+
15
+ ## Features
16
+
17
+ - 兼容和跨平台:
18
+ - [Docker (@NN708)](https://hub.docker.com/r/newfuture/ddns) [![Docker Image Size](https://img.shields.io/docker/image-size/newfuture/ddns/latest?logo=docker&style=social)](https://hub.docker.com/r/newfuture/ddns)[![Docker Platforms](https://img.shields.io/badge/arch-amd64%20%7C%20arm64%20%7C%20arm%2Fv7%20%7C%20arm%2Fv6%20%7C%20ppc64le%20%7C%20s390x%20%7C%20386%20%7C%20riscv64-blue?style=social)](https://hub.docker.com/r/newfuture/ddns)
19
+ - [二进制文件](https://github.com/NewFuture/DDNS/releases/latest) ![cross platform](https://img.shields.io/badge/system-windows_%7C%20linux_%7C%20mac-success.svg?style=social)
20
+
21
+ - 配置方式:
22
+ - [命令行参数](https://ddns.newfuture.cc/doc/cli.html)
23
+ - [JSON 配置文件](https://ddns.newfuture.cc/doc/json.html)
24
+ - [环境变量配置](https://ddns.newfuture.cc/doc/env.html)
25
+ - [服务商配置指南](https://ddns.newfuture.cc/doc/providers/)
26
+
27
+ - 域名支持:
28
+ - 多个域名支持
29
+ - 多级域名解析
30
+ - 自动创建新 DNS 记录
31
+ - IP 类型:
32
+ - 内网 IPv4 / IPv6
33
+ - 公网 IPv4 / IPv6 (支持自定义 API)
34
+ - 自定义命令(shell)
35
+ - 正则选取支持 (@rufengsuixing)
36
+ - 网络代理:
37
+ - http 代理支持
38
+ - 多代理自动切换
39
+ - 服务商支持:
40
+ - [DNSPOD](https://www.dnspod.cn/) ([配置指南](doc/providers/dnspod.md))
41
+ - [阿里 DNS](http://www.alidns.com/) ([配置指南](doc/providers/alidns.md)) ⚡
42
+ - [阿里云边缘安全加速(ESA)](https://esa.console.aliyun.com/) ([配置指南](doc/providers/aliesa.md)) ⚡
43
+ - [DNS.COM](https://www.dns.com/) ([配置指南](doc/providers/51dns.md)) (@loftor-git)
44
+ - [DNSPOD 国际版](https://www.dnspod.com/) ([配置指南](doc/providers/dnspod_com.md))
45
+ - [CloudFlare](https://www.cloudflare.com/) ([配置指南](doc/providers/cloudflare.md)) (@tongyifan)
46
+ - [HE.net](https://dns.he.net/) ([配置指南](doc/providers/he.md)) (@NN708) (不支持自动创建记录)
47
+ - [华为云](https://huaweicloud.com/) ([配置指南](doc/providers/huaweidns.md)) (@cybmp3) ⚡
48
+ - [NameSilo](https://www.namesilo.com/) ([配置指南](doc/providers/namesilo.md))
49
+ - [腾讯云](https://cloud.tencent.com/) ([配置指南](doc/providers/tencentcloud.md)) ⚡
50
+ - [腾讯云 EdgeOne](https://cloud.tencent.com/product/teo) ([配置指南](doc/providers/edgeone.md)) ⚡
51
+ - [No-IP](https://www.noip.com/) ([配置指南](doc/providers/noip.md))
52
+ - 自定义回调 API ([配置指南](doc/providers/callback.md))
53
+
54
+ > ⚡ 标记的服务商使用高级 HMAC-SHA256 签名认证,提供企业级安全保障
55
+ - 其他:
56
+ - 可设置定时任务
57
+ - TTL 配置支持
58
+ - DNS 线路(运营商)配置支持(国内服务商)
59
+ - 本地文件缓存(减少 API 请求)
60
+ - 地址变更时触发自定义回调 API(与 DDNS 功能互斥)
61
+
62
+ ## 使用
63
+
64
+ ### ① 安装
65
+
66
+ 根据需要选择一种方式:`二进制`版、`pip`版、`源码`运行,或者 `Docker`。
67
+
68
+ 推荐 Docker 版,兼容性最佳,体积小,性能优化。
69
+
70
+ - #### Docker(需要安装 Docker)
71
+
72
+ 详细说明和高级用法请查看 [Docker 使用文档](https://ddns.newfuture.cc/doc/docker.html)
73
+
74
+ <details>
75
+ <summary markdown="span">支持命令行,配置文件,和环境变量传参</summary>
76
+
77
+ - 命令行cli
78
+
79
+ ```sh
80
+ docker run newfuture/ddns -h
81
+ ```
82
+
83
+ - 使用配置文件(docker 工作目录 `/ddns/`,默认配置位置 `/ddns/config.json`):
84
+
85
+ ```sh
86
+ docker run -d -v /host/config/:/ddns/ --network host newfuture/ddns
87
+ ```
88
+
89
+ - 使用环境变量:
90
+
91
+ ```sh
92
+ docker run -d \
93
+ -e DDNS_DNS=dnspod \
94
+ -e DDNS_ID=12345 \
95
+ -e DDNS_TOKEN=mytokenkey \
96
+ -e DDNS_IPV4=ddns.newfuture.cc \
97
+ --network host \
98
+ newfuture/ddns
99
+ ```
100
+
101
+ </details>
102
+
103
+ - #### pip 安装(需要 pip 或 easy_install)
104
+
105
+ 1. 安装 ddns: `pip install ddns` 或 `easy_install ddns`
106
+ 2. 运行: `ddns -h` 或者 `python -m ddns`
107
+
108
+ - #### 二进制版(单文件,无需 python)
109
+
110
+ 前往[release下载对应版本](https://github.com/NewFuture/DDNS/releases/latest)
111
+
112
+ - #### 源码运行(无任何依赖,需 python 环境)
113
+
114
+ 1. clone 或者 [下载此仓库](https://github.com/NewFuture/DDNS/archive/master.zip) 并解压
115
+ 2. 运行 `python run.py` 或者 `python -m ddns`
116
+
117
+ ### ② 快速配置
118
+
119
+ 1. 申请 api `token`,填写到对应的 `id` 和 `token` 字段:
120
+
121
+ - **DNSPOD(中国版)**: [创建 token](https://support.dnspod.cn/Kb/showarticle/tsid/227/) | [详细配置文档](doc/providers/dnspod.md)
122
+ - **阿里云 DNS**: [申请 accesskey](https://help.aliyun.com/document_detail/87745.htm) | [详细配置文档](doc/providers/alidns.md)
123
+ - **阿里云边缘安全加速(ESA)**: [申请 accesskey](https://help.aliyun.com/document_detail/87745.htm) | [详细配置文档](doc/providers/aliesa.md)
124
+ - **51DNS(dns.com)**: [API Key/Secret](https://www.dns.com/member/apiSet) | [详细配置文档](doc/providers/51dns.md)
125
+ - **DNSPOD(国际版)**: [获取 token](https://www.dnspod.com/docs/info.html#get-the-user-token) | [详细配置文档](doc/providers/dnspod_com.md)
126
+ - **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)
127
+ - **HE.net**: [DDNS 文档](https://dns.he.net/docs.html)(仅需将设置的密码填入 `token` 字段,`id` 字段可留空) | [详细配置文档](doc/providers/he.md)
128
+ - **华为云 DNS**: [APIKEY 申请](https://console.huaweicloud.com/iam/)(点左边访问密钥,然后点新增访问密钥) | [详细配置文档](doc/providers/huaweidns.md)
129
+ - **NameSilo**: [API Key](https://www.namesilo.com/account/api-manager)(API Manager 中获取 API Key) | [详细配置文档](doc/providers/namesilo.md)
130
+ - **腾讯云 DNS**: [详细配置文档](doc/providers/tencentcloud.md)
131
+ - **腾讯云 EdgeOne**: [详细配置文档](doc/providers/edgeone.md)
132
+ - **No-IP**: [用户名和密码](https://www.noip.com/)(使用 No-IP 账户的用户名和密码) | [详细配置文档](doc/providers/noip.md)
133
+ - **自定义回调**: 参数填写方式请查看下方的自定义回调配置说明
134
+
135
+ 2. 修改配置文件,`ipv4` 和 `ipv6` 字段,为待更新的域名,详细参照配置说明
136
+
137
+ ## 详细配置
138
+
139
+ 所有字段可通过三种方式进行配置,优先级为:**命令行参数 > JSON配置文件 > 环境变量**
140
+
141
+ 1. [命令行参数](doc/cli.md) `ddns --key=value`(`ddns -h` 查看详情),优先级最高
142
+ 2. [JSON 配置文件](doc/json.md)(值为 null 认为是有效值,会覆盖环境变量的设置,如果没有对应的 key 则会尝试使用环境变量)
143
+ 3. 环境变量 DDNS_ 前缀加上 key 全大写或者全小写,点转下划线(`${ddns_id}` 或 `${DDNS_ID}`,`${DDNS_LOG_LEVEL}`)
144
+
145
+ ### 配置优先级和字段覆盖关系
146
+
147
+ 如果同一个配置项在多个地方设置,将按照以下优先级规则生效:
148
+
149
+ - **命令行参数**:优先级最高,会覆盖其他所有设置
150
+ - **JSON配置文件**:介于命令行和环境变量之间,会覆盖环境变量中的设置
151
+ - **环境变量**:优先级最低,当其他方式未设置时使用
152
+
153
+ **高级用法**:
154
+
155
+ - JSON配置中明确设为`null`的值会覆盖环境变量设置
156
+ - `debug`参数只在命令行中有效,JSON配置文件中的同名设置无效
157
+ - 多值参数(如`ipv4`、`ipv6`等)在命令行中使用方式为重复使用参数,如`--ipv4 domain1 --ipv4 domain2`
158
+
159
+ 各配置方式的详细说明请查看对应文档:[命令行](doc/cli.md)、[JSON配置](doc/json.md)、[环境变量](doc/env.md)、[服务商配置](doc/providers/)
160
+
161
+ > 📖 **环境变量详细配置**: 查看 [环境变量配置文档](doc/env.md) 了解所有环境变量的详细用法和示例
162
+
163
+ <details open>
164
+ <summary markdown="span">config.json 配置文件</summary>
165
+
166
+ - 首次运行会自动生成一个模板配置文件
167
+ - 可以使用 `-c` 使用指定的配置文件(默认读取当前目录的 config.json)
168
+ - 推荐使用 vscode 等支持 JsonSchema 的编辑器编辑配置文件
169
+ - 查看 [JSON配置文件详细文档](doc/json.md) 了解完整的配置选项和示例
170
+
171
+ ```bash
172
+ ddns -c path/to/config.json
173
+ # 或者python运行
174
+ python -m ddns -c /path/to/config.json
175
+ ```
176
+
177
+ #### 配置参数表
178
+
179
+ | key | type | required | default | description | tips |
180
+ | :----: | :----------------: | :------: | :---------: | :----------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
181
+ | id | string | √ | 无 | api 访问 ID | Cloudflare 为邮箱(使用 Token 时留空)<br>HE.net 可留空<br>华为云为 Access Key ID (AK) |
182
+ | token | string | √ | 无 | api 授权 token | 部分平台叫 secret key,**反馈粘贴时删除** |
183
+ | 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/) |
184
+ | ipv4 | array | No | `[]` | ipv4 域名列表 | 为 `[]` 时,不会获取和更新 IPv4 地址 |
185
+ | ipv6 | array | No | `[]` | ipv6 域名列表 | 为 `[]` 时,不会获取和更新 IPv6 地址 |
186
+ | index4 | string\|int\|array | No | `"default"` | ipv4 获取方式 | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式 |
187
+ | index6 | string\|int\|array | No | `"default"` | ipv6 获取方式 | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式 |
188
+ | ttl | number | No | `null` | DNS 解析 TTL 时间 | 不设置采用 DNS 默认策略 |
189
+ | proxy | string\|array | No | 无 | http 代理 `;` 分割 | 多代理逐个尝试直到成功,`DIRECT` 为直连 |
190
+ | ssl | string\|boolean | No | `"auto"` | SSL证书验证方式 | `true`(强制验证)、`false`(禁用验证)、`"auto"`(自动降级)或自定义CA证书文件路径 |
191
+ | debug | bool | No | `false` | 是否开启调试 | 调试模式,仅命令行参数`--debug`有效 |
192
+ | cache | string\|bool | No | `true` | 是否缓存记录 | 正常情况打开避免频繁更新,默认位置为临时目录下 `ddns.cache`,也可以指定一个具体路径 |
193
+ | log | object | No | `null` | 日志配置(可选) | 日志配置对象,支持`level`、`file`、`format`、`datefmt`参数 |
194
+
195
+ #### index4 和 index6 参数说明
196
+
197
+ - 数字(`0`,`1`,`2`,`3`等):第 i 个网卡 ip
198
+ - 字符串 `"default"`(或者无此项):系统访问外网默认 IP
199
+ - 字符串 `"public"`:使用公网 ip(使用公网 API 查询,url 的简化模式)
200
+ - 字符串 `"url:xxx"`:打开 URL `xxx`(如:`"url:http://ip.sb"`),从返回的数据提取 IP 地址
201
+ - 字符串 `"regex:xxx"` 正则表达(如 `"regex:192.*"`):提取 `ifconfig`/`ipconfig` 中与之匹配的首个 IP 地址,**注意 json 转义**(`\`要写成`\\`)
202
+ - `"192.*"` 表示 192 开头的所有 ip(注意 `regex:` 不可省略)
203
+ - 如果想匹配 `10.00.xxxx` 应该写成 `"regex:10\\.00\\..*"`(`"\\"` json 转义成 `\`)
204
+ - 字符串 `"cmd:xxxx"`:执行命令 `xxxx` 的 stdout 输出结果作为目标 IP
205
+ - 字符串 `"shell:xxx"`:使用系统 shell 运行 `xxx`,并把结果 stdout 作为目标 IP
206
+ - `false`:强制禁止更新 ipv4 或 ipv6 的 DNS 解析
207
+ - 列表:依次执行列表中的 index 规则,并将最先获得的结果作为目标 IP
208
+ - 例如 `["public", "regex:172\\..*"]` 将先查询公网 API,未获取到 IP 后再从本地寻找 172 开头的 IP
209
+
210
+ #### 自定义回调配置说明
211
+
212
+ - `id` 字段填写回调地址,以 HTTP 或 HTTPS 开头,推荐采用 HTTPS 方式的回调 API,支持变量替换功能。
213
+ - `token` 字段为 POST 请求参数(JSON对象或JSON字符串),本字段为空或不存在则使用 GET 方式发起回调。当 JSON 的参数值包含下表所示的常量字符串时,会自动替换为实际内容。
214
+
215
+ 详细配置指南请查看:[Callback Provider 配置文档](doc/providers/callback.md)
216
+
217
+ | 常量名称 | 常量内容 | 说明 |
218
+ | ---------------- | ------------------------ | -------- |
219
+ | `__DOMAIN__` | DDNS 域名 | |
220
+ | `__IP__` | 获取的对应类型的 IP 地址 | |
221
+ | `__RECORDTYPE__` | DDNS 记录类型 | |
222
+ | `__TTL__` | DDNS TTL | |
223
+ | `__TIMESTAMP__` | 请求发起时间戳 | 包含小数 |
224
+
225
+ #### 配置示例
226
+
227
+ ```json
228
+ {
229
+ "$schema": "https://ddns.newfuture.cc/schema/v4.0.json",
230
+ "id": "12345",
231
+ "token": "mytokenkey",
232
+ "dns": "dnspod 或 dnspod_com 或 alidns 或 aliesa 或 dnscom 或 cloudflare 或 he 或 huaweidns 或 namesilo 或 tencentcloud 或 noip 或 callback",
233
+ "ipv4": ["ddns.newfuture.cc", "ipv4.ddns.newfuture.cc"],
234
+ "ipv6": ["ddns.newfuture.cc", "ipv6.ddns.newfuture.cc"],
235
+ "index4": 0,
236
+ "index6": "public",
237
+ "ttl": 600,
238
+ "proxy": ["127.0.0.1:1080", "DIRECT"],
239
+ "log": {
240
+ "level": "DEBUG",
241
+ "file": "dns.log",
242
+ "datefmt": "%Y-%m-%dT%H:%M:%S"
243
+ }
244
+ }
245
+ ```
246
+
247
+ </details>
248
+
249
+ ## 定时任务
250
+
251
+ <details>
252
+ <summary markdown="span">可以通过脚本设置定时任务(默认每 5 分钟检查一次 IP,自动更新)</summary>
253
+
254
+ #### Windows
255
+
256
+ - [推荐] 以系统身份运行,右键“以管理员身份运行”`task.bat`(或者在管理员命令行中运行)
257
+ - 以当前用户身份运行定时任务,双击或运行 `task.bat`(执行时会闪黑框)
258
+
259
+ #### Linux
260
+
261
+ - 使用 init.d 和 crontab:
262
+
263
+ ```bash
264
+ sudo ./task.sh
265
+ ```
266
+
267
+ - 使用 systemd:
268
+
269
+ ```bash
270
+ 安装:
271
+ sudo ./systemd.sh install
272
+ 卸载:
273
+ sudo ./systemd.sh uninstall
274
+ ```
275
+
276
+ 该脚本安装的文件符合 [Filesystem Hierarchy Standard (FHS)](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard):
277
+ 可执行文件所在目录为 `/usr/share/DDNS`
278
+ 配置文件所在目录为 `/etc/DDNS`
279
+
280
+ #### Docker
281
+
282
+ Docker 镜像在无额外参数的情况下,已默认启用每 5 分钟执行一次的定时任务
283
+
284
+ </details>
285
+
286
+ ## FAQ
287
+
288
+ <details>
289
+ <summary markdown="span">Windows Server [SSL: CERTIFICATE_VERIFY_FAILED]</summary>
290
+
291
+ > Windows Server 默认安全策略会禁止任何未添加的信任 SSL 证书,可手动添加一下对应的证书 [#56](https://github.com/NewFuture/DDNS/issues/56#issuecomment-487371078)
292
+
293
+ 使用系统自带的 IE 浏览器访问一次对应的 API 即可
294
+
295
+ - alidns 打开: <https://alidns.aliyuncs.com>
296
+ - aliesa 打开: <https://esa.cn-hangzhou.aliyuncs.com>
297
+ - cloudflare 打开: <https://api.cloudflare.com>
298
+ - dns.com 打开: <https://www.dns.com>
299
+ - dnspod.cn 打开: <https://dnsapi.cn>
300
+ - dnspod 国际版: <https://api.dnspod.com>
301
+ - 华为 DNS <https://dns.myhuaweicloud.com>
302
+
303
+ </details>
304
+
305
+ <details>
306
+ <summary markdown="span">问题排查反馈</summary>
307
+
308
+ 1. 先确认排查是否是系统/网络环境问题
309
+ 2. 在 [issues](https://github.com/NewFuture/DDNS/issues) 中搜索是否有类似问题
310
+ 3. 前两者均无法解决或者确定是 bug,[在此新建 issue](https://github.com/NewFuture/DDNS/issues/new)
311
+ - [ ] 开启 `--debug`
312
+ - [ ] 附上这些内容 **运行版本和方式**、**系统环境**、**出错日志**、**去掉 id/token** 的配置文件
313
+ - [ ] 源码运行注明使用的 python 环境
314
+
315
+ </details>