diff --git a/docs/configuration.md b/docs/configuration.md index 1ebd0c1bf8..e749e20d4f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -47,10 +47,10 @@ hide: | audit-console | 是否输出审计日志到控制台 | no | [yes\|no] | audit-console yes | | audit-syslog | 是否输出审计日志到系统日志 | no | [yes\|no] | audit-syslog yes | | conf-file | 附加配置文件 | 无 | 合法路径字符串，通配符号 | conf-file /etc/smartdns/smartdns.more.conf
conf-file *.conf | -| server | 上游 UDP DNS | 无 | 可重复。
[ip][:port]\|URL：服务器 IP:端口（可选）或 URL
[-blacklist-ip]：配置 IP 过滤结果。
[-whitelist-ip]：指定仅接受参数中配置的 IP 范围
[-g\|-group [group] ...]：DNS 服务器所属组，比如 office 和 foreign，和 nameserver 配套使用
[-e\|-exclude-default-group]：将 DNS 服务器从默认组中排除。
[-set-mark mark]：设置数据包标记so-mark。
[-p\|-proxy name]：设置代理服务器。
[-b\|-bootstrap-dns]：标记此服务器为bootstrap服务器。
[-subnet]：指定服务器使用的edns-client-subnet| server 8.8.8.8:53 -blacklist-ip -group g1 -proxy proxy
server tls://8.8.8.8| -| server-tcp | 上游 TCP DNS | 无 | 可重复。
[ip][:port]：服务器 IP:端口（可选）
[-blacklist-ip]：配置 IP 过滤结果
[-whitelist-ip]：指定仅接受参数中配置的 IP 范围。
[-g\|-group [group] ...]：DNS 服务器所属组，比如 office 和 foreign，和 nameserver 配套使用
[-e\|-exclude-default-group]：将 DNS 服务器从默认组中排除。
[-set-mark mark]：设置数据包标记so-mark。
[-p\|-proxy name]：设置代理服务器。
[-b\|-bootstrap-dns]：标记此服务器为bootstrap服务器。
[-subnet]：指定服务器使用的edns-client-subnet| server-tcp 8.8.8.8:53 | -| server-tls | 上游 TLS DNS | 无 | 可重复。
[ip][:port]：服务器 IP:端口（可选)
[-spki-pin [sha256-pin]]：TLS 合法性校验 SPKI 值，base64 编码的 sha256 SPKI pin 值
[-host-name]：TLS SNI 名称, 名称设置为-，表示停用SNI名称。
[-host-ip]: 主机IP地址。
[-tls-host-verify]：TLS 证书主机名校验
[-k\|-no-check-certificate]：跳过证书校验
[-blacklist-ip]：配置 IP 过滤结果
[-whitelist-ip]：仅接受参数中配置的 IP 范围
[-g\|-group [group] ...]：DNS 服务器所属组，比如 office 和 foreign，和 nameserver 配套使用
[-e\|-exclude-default-group]：将 DNS 服务器从默认组中排除。
[-set-mark mark]：设置数据包标记so-mark。
[-p\|-proxy name]：设置代理服务器。
[-b\|-bootstrap-dns]：标记此服务器为bootstrap服务器。
[-subnet]：指定服务器使用的edns-client-subnet| server-tls 8.8.8.8:853 | -| server-https | 上游 HTTPS DNS | 无 | 可重复。
https://[host>][:port]/path：服务器 IP:端口（可选）
[-spki-pin [sha256-pin]]：TLS 合法性校验 SPKI 值，base64 编码的 sha256 SPKI pin 值
[-host-name]：TLS SNI 名称, 名称设置为-，表示停用SNI名称。
[-host-ip]: 主机IP地址。
[-http-host]：http 协议头主机名
[-tls-host-verify]：TLS 证书主机名校验
[-k\|-no-check-certificate]：跳过证书校验
[-blacklist-ip]：配置 IP 过滤结果
[-whitelist-ip]：仅接受参数中配置的 IP 范围。
[-g\|-group [group] ...]：DNS 服务器所属组，比如 office 和 foreign，和 nameserver 配套使用
[-e\|-exclude-default-group]：将 DNS 服务器从默认组中排除。
[-set-mark]：设置数据包标记so-mark。
[-p\|-proxy name]：设置代理服务器。
[-b\|-bootstrap-dns]：标记此服务器为bootstrap服务器。
[-subnet]：指定服务器使用的edns-client-subnet| server-https https://cloudflare-dns.com/dns-query | +| server | 上游 UDP DNS | 无 | 可重复。
[ip][:port]\|URL：服务器 IP:端口（可选）或 URL
[-blacklist-ip]：配置 IP 过滤结果。
[-whitelist-ip]：指定仅接受参数中配置的 IP 范围
[-g\|-group [group] ...]：DNS 服务器所属组，比如 office 和 foreign，和 nameserver 配套使用
[-e\|-exclude-default-group]：将 DNS 服务器从默认组中排除。
[-set-mark mark]：设置数据包标记so-mark。
[-p\|-proxy name]：设置代理服务器。
[-b\|-bootstrap-dns]：标记此服务器为bootstrap服务器。
[-subnet]：指定服务器使用的edns-client-subnet。
[-interface]：绑定到对应的网口。| server 8.8.8.8:53 -blacklist-ip -group g1 -proxy proxy
server tls://8.8.8.8| +| server-tcp | 上游 TCP DNS | 无 | 可重复。
[ip][:port]：服务器 IP:端口（可选）
[-blacklist-ip]：配置 IP 过滤结果
[-whitelist-ip]：指定仅接受参数中配置的 IP 范围。
[-g\|-group [group] ...]：DNS 服务器所属组，比如 office 和 foreign，和 nameserver 配套使用
[-e\|-exclude-default-group]：将 DNS 服务器从默认组中排除。
[-set-mark mark]：设置数据包标记so-mark。
[-p\|-proxy name]：设置代理服务器。
[-b\|-bootstrap-dns]：标记此服务器为bootstrap服务器。
[-subnet]：指定服务器使用的edns-client-subnet。
[-interface]：绑定到对应的网口。| server-tcp 8.8.8.8:53 | +| server-tls | 上游 TLS DNS | 无 | 可重复。
[ip][:port]：服务器 IP:端口（可选)
[-spki-pin [sha256-pin]]：TLS 合法性校验 SPKI 值，base64 编码的 sha256 SPKI pin 值
[-host-name]：TLS SNI 名称, 名称设置为-，表示停用SNI名称。
[-host-ip]: 主机IP地址。
[-tls-host-verify]：TLS 证书主机名校验
[-k\|-no-check-certificate]：跳过证书校验
[-blacklist-ip]：配置 IP 过滤结果
[-whitelist-ip]：仅接受参数中配置的 IP 范围
[-g\|-group [group] ...]：DNS 服务器所属组，比如 office 和 foreign，和 nameserver 配套使用
[-e\|-exclude-default-group]：将 DNS 服务器从默认组中排除。
[-set-mark mark]：设置数据包标记so-mark。
[-p\|-proxy name]：设置代理服务器。
[-b\|-bootstrap-dns]：标记此服务器为bootstrap服务器。
[-subnet]：指定服务器使用的edns-client-subnet。
[-interface]：绑定到对应的网口。| server-tls 8.8.8.8:853 | +| server-https | 上游 HTTPS DNS | 无 | 可重复。
https://[host>][:port]/path：服务器 IP:端口（可选）
[-spki-pin [sha256-pin]]：TLS 合法性校验 SPKI 值，base64 编码的 sha256 SPKI pin 值
[-host-name]：TLS SNI 名称, 名称设置为-，表示停用SNI名称。
[-host-ip]: 主机IP地址。
[-http-host]：http 协议头主机名
[-tls-host-verify]：TLS 证书主机名校验
[-k\|-no-check-certificate]：跳过证书校验
[-blacklist-ip]：配置 IP 过滤结果
[-whitelist-ip]：仅接受参数中配置的 IP 范围。
[-g\|-group [group] ...]：DNS 服务器所属组，比如 office 和 foreign，和 nameserver 配套使用
[-e\|-exclude-default-group]：将 DNS 服务器从默认组中排除。
[-set-mark]：设置数据包标记so-mark。
[-p\|-proxy name]：设置代理服务器。
[-b\|-bootstrap-dns]：标记此服务器为bootstrap服务器。
[-subnet]：指定服务器使用的edns-client-subnet。
[-interface]：绑定到对应的网口。| server-https https://cloudflare-dns.com/dns-query | | proxy-server | 代理服务器 | 无 | 可重复。
proxy-server URL
[URL]: [socks5\|http]://[username:password@]host:port
[-name]: 代理服务器名称。 |proxy-server socks5://user:pass@1.2.3.4:1080 -name proxy| | speed-check-mode | 测速模式选择 | ping,tcp:80,tcp:443 | [ping\|tcp:[80]\|none] | speed-check-mode ping,tcp:80,tcp:443 | | response-mode | 首次查询响应模式 | first-ping |模式：[first-ping\|fastest-ip\|fastest-response]
[first-ping]: 最快ping响应地址模式，DNS上游最快查询时延+ping时延最短，查询等待与链接体验最佳;
[fastest-ip]: 最快IP地址模式，查询到的所有IP地址中ping最短的IP。需等待IP测速;
[fastest-response]: 最快响应的DNS结果，DNS查询等待时间最短，返回的IP地址可能不是最快。| response-mode first-ping | diff --git a/en/docs/configuration.md b/en/docs/configuration.md index 8736573a98..476158b492 100644 --- a/en/docs/configuration.md +++ b/en/docs/configuration.md @@ -43,10 +43,10 @@ hide: |audit-console|enable output audit log to console|no|[yes\|no]|audit-console yes |audit-syslog|enable output audit log to syslog|no|[yes\|no]|audit-syslog yes |conf-file|additional conf file|None|File path, wildcard |conf-file /etc/smartdns/smartdns.more.conf
conf-file *.conf -|server|Upstream UDP DNS server|None|Repeatable
`[ip][:port]|URL`: Server IP, port optional OR URL.
`[-blacklist-ip]`: The "-blacklist-ip" parameter is to filtering IPs which is configured by "blacklist-ip".
`[-whitelist-ip]`: whitelist-ip parameter specifies that only the IP range configured in whitelist-ip is accepted.
`[-g|-group [group] ...]`: The group to which the DNS server belongs, such as office, foreign, use with nameserver.
`[-e|-exclude-default-group]`: Exclude DNS servers from the default group.
`[-set-mark mark]`: set mark on packets
`[-p|-proxy name]`: set proxy server
`[-b|-bootstrap-dns]`: set as bootstrap dns server
[-subnet]：set per server edns-client-subnet | server 8.8.8.8:53 -blacklist-ip
server tls://8.8.8.8 -|server-tcp|Upstream TCP DNS server|None|Repeatable
`[ip][:port]`: Server IP, port optional.
`[-blacklist-ip]`: The "-blacklist-ip" parameter is to filtering IPs which is configured by "blacklist-ip".
`[-whitelist-ip]`: whitelist-ip parameter specifies that only the IP range configured in whitelist-ip is accepted.
`[-g|-group [group] ...]`: The group to which the DNS server belongs, such as office, foreign, use with nameserver.
`[-e|-exclude-default-group]`: Exclude DNS servers from the default group
`[-set-mark mark]`: set mark on packets
`[-p|-proxy name]`: set proxy server
`[-b|-bootstrap-dns]`: set as bootstrap dns server
[-subnet]：set per server edns-client-subnet | server-tcp 8.8.8.8:53 -|server-tls|Upstream TLS DNS server|None|Repeatable
`[ip][:port]`: Server IP, port optional.
`[-spki-pin [sha256-pin]]`: TLS verify SPKI value, a base64 encoded SHA256 hash
`[-host-name]`:TLS Server name. `-` to disable SNI name.
[-host-ip]: host ip address.
`[-tls-host-verify]`: TLS cert hostname to verify.
`[-k|-no-check-certificate]`: No check certificate.
`[-blacklist-ip]`: The "-blacklist-ip" parameter is to filtering IPs which is configured by "blacklist-ip".
`[-whitelist-ip]`: whitelist-ip parameter specifies that only the IP range configured in whitelist-ip is accepted.
`[-g|-group [group] ...]`: The group to which the DNS server belongs, such as office, foreign, use with nameserver.
`[-e|-exclude-default-group]`: Exclude DNS servers from the default group
`[-set-mark mark]`: set mark on packets
`[-p|-proxy name]`: set proxy server
`[-b|-bootstrap-dns]`: set as bootstrap dns server
[-subnet]：set per server edns-client-subnet | server-tls 8.8.8.8:853 -|server-https|Upstream HTTPS DNS server|None|Repeatable
`https://[host][:port]/path`: Server IP, port optional.
`[-spki-pin [sha256-pin]]`: TLS verify SPKI value, a base64 encoded SHA256 hash
`[-host-name]`:TLS Server name
`[-http-host]`: http header host.
[-host-ip]: host ip address.
`[-tls-host-verify]`: TLS cert hostname to verify.
`[-k|-no-check-certificate]`: No check certificate.
`[-blacklist-ip]`: The "-blacklist-ip" parameter is to filtering IPs which is configured by "blacklist-ip".
`[-whitelist-ip]`: whitelist-ip parameter specifies that only the IP range configured in whitelist-ip is accepted.
`[-g|-group [group] ...]`: The group to which the DNS server belongs, such as office, foreign, use with nameserver.
`[-e|-exclude-default-group]`: Exclude DNS servers from the default group
`[-set-mark mark]`: set mark on packets
`[-p|-proxy name]`: set proxy server
`[-b|-bootstrap-dns]`: set as bootstrap dns server
[-subnet]：set per server edns-client-subnet | server-https +|server|Upstream UDP DNS server|None|Repeatable
`[ip][:port]|URL`: Server IP, port optional OR URL.
`[-blacklist-ip]`: The "-blacklist-ip" parameter is to filtering IPs which is configured by "blacklist-ip".
`[-whitelist-ip]`: whitelist-ip parameter specifies that only the IP range configured in whitelist-ip is accepted.
`[-g|-group [group] ...]`: The group to which the DNS server belongs, such as office, foreign, use with nameserver.
`[-e|-exclude-default-group]`: Exclude DNS servers from the default group.
`[-set-mark mark]`: set mark on packets
`[-p|-proxy name]`: set proxy server
`[-b|-bootstrap-dns]`: set as bootstrap dns server
[-subnet]：set per server edns-client-subnet.
[-interface]: bind to interface. | server 8.8.8.8:53 -blacklist-ip
server tls://8.8.8.8 +|server-tcp|Upstream TCP DNS server|None|Repeatable
`[ip][:port]`: Server IP, port optional.
`[-blacklist-ip]`: The "-blacklist-ip" parameter is to filtering IPs which is configured by "blacklist-ip".
`[-whitelist-ip]`: whitelist-ip parameter specifies that only the IP range configured in whitelist-ip is accepted.
`[-g|-group [group] ...]`: The group to which the DNS server belongs, such as office, foreign, use with nameserver.
`[-e|-exclude-default-group]`: Exclude DNS servers from the default group
`[-set-mark mark]`: set mark on packets
`[-p|-proxy name]`: set proxy server
`[-b|-bootstrap-dns]`: set as bootstrap dns server
[-subnet]：set per server edns-client-subnet.
[-interface]: bind to interface. | server-tcp 8.8.8.8:53 +|server-tls|Upstream TLS DNS server|None|Repeatable
`[ip][:port]`: Server IP, port optional.
`[-spki-pin [sha256-pin]]`: TLS verify SPKI value, a base64 encoded SHA256 hash
`[-host-name]`:TLS Server name. `-` to disable SNI name.
[-host-ip]: host ip address.
`[-tls-host-verify]`: TLS cert hostname to verify.
`[-k|-no-check-certificate]`: No check certificate.
`[-blacklist-ip]`: The "-blacklist-ip" parameter is to filtering IPs which is configured by "blacklist-ip".
`[-whitelist-ip]`: whitelist-ip parameter specifies that only the IP range configured in whitelist-ip is accepted.
`[-g|-group [group] ...]`: The group to which the DNS server belongs, such as office, foreign, use with nameserver.
`[-e|-exclude-default-group]`: Exclude DNS servers from the default group
`[-set-mark mark]`: set mark on packets
`[-p|-proxy name]`: set proxy server
`[-b|-bootstrap-dns]`: set as bootstrap dns server
[-subnet]：set per server edns-client-subnet.
[-interface]: bind to interface. | server-tls 8.8.8.8:853 +|server-https|Upstream HTTPS DNS server|None|Repeatable
`https://[host][:port]/path`: Server IP, port optional.
`[-spki-pin [sha256-pin]]`: TLS verify SPKI value, a base64 encoded SHA256 hash
`[-host-name]`:TLS Server name
`[-http-host]`: http header host.
[-host-ip]: host ip address.
`[-tls-host-verify]`: TLS cert hostname to verify.
`[-k|-no-check-certificate]`: No check certificate.
`[-blacklist-ip]`: The "-blacklist-ip" parameter is to filtering IPs which is configured by "blacklist-ip".
`[-whitelist-ip]`: whitelist-ip parameter specifies that only the IP range configured in whitelist-ip is accepted.
`[-g|-group [group] ...]`: The group to which the DNS server belongs, such as office, foreign, use with nameserver.
`[-e|-exclude-default-group]`: Exclude DNS servers from the default group
`[-set-mark mark]`: set mark on packets
`[-p|-proxy name]`: set proxy server
`[-b|-bootstrap-dns]`: set as bootstrap dns server
[-subnet]：set per server edns-client-subnet.
[-interface]: bind to interface. | server-https |proxy-server| proxy server | None | Repeatable.
`proxy-server URL`
[URL]: `[socks5\|http]://[username:password@]host:port`
[-name]: proxy server name. |proxy-server socks5://user:pass@1.2.3.4:1080 -name proxy| |speed-check-mode|Speed ​​mode|ping,tcp:80,tcp:443|[ping\|tcp:[80]\|none]|speed-check-mode ping,tcp:80,tcp:443 |response-mode|First query response mode|first-ping|Mode: [first-ping\|fastest-ip\|fastest-response]
[first-ping]: The fastest dns + ping response mode, DNS query delay + ping delay is the shortest;
[fastest-ip]: The fastest IP address mode, return the fastest ip address, may take some time to test speed.
[fastest-response]: The fastest response DNS result mode, the DNS query waiting time is the shortest. | response-mode first-ping |