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

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.
### `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:
@@ -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
```
### `dnsmasq` Format
### dnsmasq Format
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
```
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
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
force-qtype-SOA 28
```
```shell
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

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

@@ -72,3 +72,26 @@ Currently, smartdns provides three server modes: UDP, TCP, and DOT.
```shell
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|
|--|--|--|--|--|
|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-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-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|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 <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 <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-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 |