daxi20/smartdns
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: update document

Browse Source
This commit is contained in:
Nick Peng
2023-03-26 22:47:03 +08:00
parent c2a5232a75
commit 1e9bc6bed9
7 changed files with 76 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/config/block-ipv6.md
View File

@@ -19,15 +19,21 @@ hide:
address /example.com/#6 address /example.com/#6
``` ```
1. 方法三：如需禁用特定查询端口的IPV6查询（比如第二DNS），可以配置如下
```shell
bind :53 -force-aaaa-soa
```
## 其他查询请求的禁用 ## 其他查询请求的禁用
smartdns支持对其他查询请求的禁用，对应参数为force-qtype-SOA 1. smartdns支持对其他查询请求的禁用，对应参数为force-qtype-SOA
```shell ```shell
force-qtype-SOA 28 force-qtype-SOA 28
``` ```
force-qtype-SOA参数后为DNS的类型。具体的类型，可以查询[IANA说明](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) force-qtype-SOA参数后为DNS的类型。具体的类型，可以查询[IANA说明](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4)
## 附加说明 ## 附加说明

23
docs/config/server-config.md
View File

@@ -73,3 +73,26 @@ smartdns目前提供了UDP, TCP, DOT三种服务端模式。
```shell ```shell
tcp-idle-time 120 tcp-idle-time 120
``` ```
## 第二DNS服务
bind-*参数除了支持基本的启用服务外，还支持更多的附加特性，可以作为特殊因为的第二DNS服务器使用。对应的可以启用的功能为：
1. 配置样例：
```shell
bind :53 -no-rule-addr -no-speed-check -no-cache
```
1. 参数介绍：
|参数|功能|
|---|---|
|-no-rule-addr|跳过 address 规则|
|-no-rule-nameserver|跳过 Nameserver 规则|
|-no-rule-ipset|跳过 ipset 和 nftset 规则|
|-no-rule-soa|跳过 SOA(#) 规则|
|-no-dualstack-selection|停用双栈测速|
|-no-speed-check|停用测速|
|-no-cache|停止缓存|
|-force-aaaa-soa|禁用IPV6查询|

6
docs/configuration.md
View File

@@ -13,9 +13,9 @@ hide:
| 键名 | 功能说明 | 默认值 | 可用值/要求 | 举例 | | 键名 | 功能说明 | 默认值 | 可用值/要求 | 举例 |
| :--- | :--- | :--- | :--- | :--- | | :--- | :--- | :--- | :--- | :--- |
| server-name | DNS 服务器名称 | 操作系统主机名 / smartdns | 符合主机名规格的字符串 | server-name smartdns | | server-name | DNS 服务器名称 | 操作系统主机名 / smartdns | 符合主机名规格的字符串 | server-name smartdns |
| bind | DNS 监听端口号 | [::]:53 | 可绑定多个端口。<br />IP:PORT@DEVICE: 服务器 IP:端口号@设备名<br />[-group]: 请求时使用的 DNS 服务器组<br />[-no-rule-addr]：跳过 address 规则<br />[-no-rule-nameserver]：跳过 Nameserver 规则<br />[-no-rule-ipset]：跳过 ipset 和 nftset 规则<br />[-no-rule-soa]：跳过 SOA(#) 规则<br />[-no-dualstack-selection]：停用双栈测速<br />[-no-speed-check]：停用测速<br />[-no-cache]：停止缓存 | bind :53@eth0 | | bind | DNS 监听端口号 | [::]:53 | 可绑定多个端口。<br />IP:PORT@DEVICE: 服务器 IP:端口号@设备名<br />[-group]: 请求时使用的 DNS 服务器组<br />[-no-rule-addr]：跳过 address 规则<br />[-no-rule-nameserver]：跳过 Nameserver 规则<br />[-no-rule-ipset]：跳过 ipset 和 nftset 规则<br />[-no-rule-soa]：跳过 SOA(#) 规则<br />[-no-dualstack-selection]：停用双栈测速<br />[-no-speed-check]：停用测速<br />[-no-cache]：停止缓存 <br />[-force-aaaa-soa]: 禁用IPV6查询 | bind :53@eth0 |
| bind-tcp | DNS TCP 监听端口号 | [::]:53 | 可绑定多个端口。<br />IP:PORT@DEVICE: 服务器 IP:端口号@设备名<br />[-group]: 请求时使用的 DNS 服务器组<br />[-no-rule-addr]：跳过 address 规则<br />[-no-rule-nameserver]：跳过 nameserver 规则<br />[-no-rule-ipset]：跳过 ipset 和 nftset 规则。<br />[-no-rule-soa]：跳过 SOA(#) 规则<br />[-no-dualstack-selection]：停用双栈测速<br />[-no-speed-check]：停用测速<br />[-no-cache]：停止缓存 | bind-tcp :53 | | bind-tcp | DNS TCP 监听端口号 | [::]:53 | 可绑定多个端口。<br />IP:PORT@DEVICE: 服务器 IP:端口号@设备名<br />[-group]: 请求时使用的 DNS 服务器组<br />[-no-rule-addr]：跳过 address 规则<br />[-no-rule-nameserver]：跳过 nameserver 规则<br />[-no-rule-ipset]：跳过 ipset 和 nftset 规则。<br />[-no-rule-soa]：跳过 SOA(#) 规则<br />[-no-dualstack-selection]：停用双栈测速<br />[-no-speed-check]：停用测速<br />[-no-cache]：停止缓存 <br />[-force-aaaa-soa]: 禁用IPV6查询 | bind-tcp :53 |
| bind-tls | DNS Over TLS 监听端口号 | [::]:853 | 可绑定多个端口。<br />IP:PORT@DEVICE: 服务器 IP:端口号@设备名<br />[-group]: 请求时使用的 DNS 服务器组<br />[-no-rule-addr]：跳过 address 规则<br />[-no-rule-nameserver]：跳过 nameserver 规则<br />[-no-rule-ipset]：跳过 ipset 和 nftset 规则。<br />[-no-rule-soa]：跳过 SOA(#) 规则<br />[-no-dualstack-selection]：停用双栈测速<br />[-no-speed-check]：停用测速<br />[-no-cache]：停止缓存 | bind-tls :853 | | bind-tls | DNS Over TLS 监听端口号 | [::]:853 | 可绑定多个端口。<br />IP:PORT@DEVICE: 服务器 IP:端口号@设备名<br />[-group]: 请求时使用的 DNS 服务器组<br />[-no-rule-addr]：跳过 address 规则<br />[-no-rule-nameserver]：跳过 nameserver 规则<br />[-no-rule-ipset]：跳过 ipset 和 nftset 规则。<br />[-no-rule-soa]：跳过 SOA(#) 规则<br />[-no-dualstack-selection]：停用双栈测速<br />[-no-speed-check]：停用测速<br />[-no-cache]：停止缓存 <br />[-force-aaaa-soa]: 禁用IPV6查询 | bind-tls :853 |
| bind-cert-file | SSL证书文件路径 | smartdns-cert.pem | 合法路径字符串 | bind-cert-file cert.pem | | bind-cert-file | SSL证书文件路径 | smartdns-cert.pem | 合法路径字符串 | bind-cert-file cert.pem |
| bind-cert-key-file | SSL证书KEY文件路径 | smartdns-key.pem | 合法路径字符串 | bind-cert-key-file key.pem | | bind-cert-key-file | SSL证书KEY文件路径 | smartdns-key.pem | 合法路径字符串 | bind-cert-key-file key.pem |
| bind-cert-key-pass | SSL证书KEY文件密码 | 无 | 字符串 | bind-cert-key-pass password | | bind-cert-key-pass | SSL证书KEY文件密码 | 无 | 字符串 | bind-cert-key-pass password |

4
en/docs/config/ad-block.md
View File

@@ -63,7 +63,7 @@ The community provides regularly updated ad-blocking list files for SmartDNS. Yo
For non-SmartDNS data, simple shell commands can convert it. For non-SmartDNS data, simple shell commands can convert it.
### `hosts` Format ### hosts Format
The following command converts the `/path/to/hosts/file` file (replace the path with your actual file) to the format supported by SmartDNS: The following command converts the `/path/to/hosts/file` file (replace the path with your actual file) to the format supported by SmartDNS:
@@ -71,7 +71,7 @@ The following command converts the `/path/to/hosts/file` file (replace the path
cat /path/to/hosts/file | grep -v "^#" | awk '{print "address /"$2"/#"}' > anti-ad-smartdns.conf cat /path/to/hosts/file | grep -v "^#" | awk '{print "address /"$2"/#"}' > anti-ad-smartdns.conf
``` ```
### `dnsmasq` Format ### dnsmasq Format
The dnsmasq format is similar to SmartDNS, but not compatible. You can convert it using the following command: The dnsmasq format is similar to SmartDNS, but not compatible. You can convert it using the following command:

16
en/docs/config/block-ipv6.md
View File

@@ -19,15 +19,21 @@ Currently, IPV6 has entered thousands of households. However, in some cases, IPV
address /example.com/#6 address /example.com/#6
``` ```
1. Method 3: If you need to disable IPV6 queries for a specific query port (such as the second DNS), you can configure it as follows:
```shell
bind :53 -force-aaaa-soa
```
## Disable Other Query Requests ## Disable Other Query Requests
Smartdns supports disabling other query requests, and the corresponding parameter is `force-qtype-SOA`. 1. Smartdns supports disabling other query requests, and the corresponding parameter is `force-qtype-SOA`.
```shell ```shell
force-qtype-SOA 28 force-qtype-SOA 28
``` ```
After force-qtype-SOA parameter is the type of DNS. The specific types can be queried from the IANA Explanation. After force-qtype-SOA parameter is the type of DNS. The specific types can be queried from the IANA Explanation.
## Additional Notes ## Additional Notes

23
en/docs/config/server-config.md
View File

@@ -72,3 +72,26 @@ Currently, smartdns provides three server modes: UDP, TCP, and DOT.
```shell ```shell
tcp-idle-time 120 tcp-idle-time 120
``` ```
## Second DNS Server
In addition to supporting basic service, the `bind-*` parameter also supports more additional features, which can be used as a special second DNS server for specific needs. The corresponding functions that can be enabled are:
1. Configuration example:
```shell
bind :53 -no-rule-addr -no-speed-check -no-cache
```
1. Parameter introduction:
| Parameter | Function |
| --------- | ---------------------------------------- |
| `-no-rule-addr` | Skip address rules |
| `-no-rule-nameserver` | Skip Nameserver rules |
| `-no-rule-ipset` | Skip ipset and nftset rules |
| `-no-rule-soa` | Skip SOA(#) rules |
| `-no-dualstack-selection` | Disable dual-stack speed test |
| `-no-speed-check` | Disable speed test |
| `-no-cache` | Stop caching |
| `-force-aaaa-soa` | Disable IPV6 queries |

6
en/docs/configuration.md
View File

@@ -9,9 +9,9 @@ hide:
|parameter|Parameter function|Default value|Value type|Example| |parameter|Parameter function|Default value|Value type|Example|
|--|--|--|--|--| |--|--|--|--|--|
|server-name|DNS name|host name/smartdns|any string like hostname|server-name smartdns |server-name|DNS name|host name/smartdns|any string like hostname|server-name smartdns
|bind|DNS listening port number|[::]:53|Support binding multiple ports<br />`IP:PORT@DEVICE`: server IP, port number, and device. <br />`[-group]`: The DNS server group used when requesting. <br />`[-no-rule-addr]`: Skip the address rule. <br />`[-no-rule-nameserver]`: Skip the Nameserver rule. <br />`[-no-rule-ipset]`: Skip the Ipset or nftset rules. <br />`[-no-rule-soa]`: Skip address SOA(#) rules.<br />`[-no-dualstack-selection]`: Disable dualstack ip selection.<br />`[-no-speed-check]`: Disable speed measurement. <br />`[-no-cache]`: stop caching |bind :53@eth0 |bind|DNS listening port number|[::]:53|Support binding multiple ports<br />`IP:PORT@DEVICE`: server IP, port number, and device. <br />`[-group]`: The DNS server group used when requesting. <br />`[-no-rule-addr]`: Skip the address rule. <br />`[-no-rule-nameserver]`: Skip the Nameserver rule. <br />`[-no-rule-ipset]`: Skip the Ipset or nftset rules. <br />`[-no-rule-soa]`: Skip address SOA(#) rules.<br />`[-no-dualstack-selection]`: Disable dualstack ip selection.<br />`[-no-speed-check]`: Disable speed measurement. <br />`[-no-cache]`: stop caching <br />[-force-aaaa-soa]: force AAAA query return SOA |bind :53@eth0
|bind-tcp|TCP mode DNS listening port number|[::]:53|Support binding multiple ports<br />`IP:PORT@DEVICE`: server IP, port number and device. <br />`[-group]`: The DNS server group used when requesting. <br />`[-no-rule-addr]`: Skip the address rule. <br />`[-no-rule-nameserver]`: Skip the Nameserver rule. <br />`[-no-rule-ipset]`: Skip the ipset or nftset rules. <br />`[-no-rule-soa]`: Skip address SOA(#) rules.<br />`[-no-dualstack-selection]`: Disable dualstack ip selection.<br />`[-no-speed-check]`: Disable speed measurement. <br />`[-no-cache]`: stop caching |bind-tcp :53 |bind-tcp|TCP mode DNS listening port number|[::]:53|Support binding multiple ports<br />`IP:PORT@DEVICE`: server IP, port number and device. <br />`[-group]`: The DNS server group used when requesting. <br />`[-no-rule-addr]`: Skip the address rule. <br />`[-no-rule-nameserver]`: Skip the Nameserver rule. <br />`[-no-rule-ipset]`: Skip the ipset or nftset rules. <br />`[-no-rule-soa]`: Skip address SOA(#) rules.<br />`[-no-dualstack-selection]`: Disable dualstack ip selection.<br />`[-no-speed-check]`: Disable speed measurement. <br />`[-no-cache]`: stop caching <br />[-force-aaaa-soa]: force AAAA query return SOA |bind-tcp :53
|bind-tls|DOT mode DNS listening port number|[::]:853|Support binding multiple ports<br />`IP:PORT@DEVICE`: server IP, port number and device. <br />`[-group]`: The DNS server group used when requesting. <br />`[-no-rule-addr]`: Skip the address rule. <br />`[-no-rule-nameserver]`: Skip the Nameserver rule. <br />`[-no-rule-ipset]`: Skip the ipset or nftset rules. <br />`[-no-rule-soa]`: Skip address SOA(#) rules.<br />`[-no-dualstack-selection]`: Disable dualstack ip selection.<br />`[-no-speed-check]`: Disable speed measurement. <br />`[-no-cache]`: stop caching |bind-tcp :853 |bind-tls|DOT mode DNS listening port number|[::]:853|Support binding multiple ports<br />`IP:PORT@DEVICE`: server IP, port number and device. <br />`[-group]`: The DNS server group used when requesting. <br />`[-no-rule-addr]`: Skip the address rule. <br />`[-no-rule-nameserver]`: Skip the Nameserver rule. <br />`[-no-rule-ipset]`: Skip the ipset or nftset rules. <br />`[-no-rule-soa]`: Skip address SOA(#) rules.<br />`[-no-dualstack-selection]`: Disable dualstack ip selection.<br />`[-no-speed-check]`: Disable speed measurement. <br />`[-no-cache]`: stop caching <br />[-force-aaaa-soa]: force AAAA query return SOA |bind-tcp :853
|bind-cert-file|SSL Certificate file path|smartdns-cert.pem|path| bind-cert-file cert.pem | |bind-cert-file|SSL Certificate file path|smartdns-cert.pem|path| bind-cert-file cert.pem |
|bind-cert-key-file|SSL Certificate key file path|none|smartdns-key.pem| bind-cert-key-file key.pem | |bind-cert-key-file|SSL Certificate key file path|none|smartdns-key.pem| bind-cert-key-file key.pem |
|bind-cert-key-pass|SSL Certificate key file password|none|string| bind-cert-key-pass password | |bind-cert-key-pass|SSL Certificate key file password|none|string| bind-cert-key-pass password |