config: add basic and server configuration guide.

This commit is contained in:
Nick Peng
2023-03-15 23:13:44 +08:00
parent 6e6c6af0c9
commit b388ca1504
5 changed files with 116 additions and 11 deletions

View File

@@ -0,0 +1,75 @@
---
hide:
- toc
---
# 服务端配置
smartdns目前提供了UDP, TCP, DOT三种服务端模式。
## UDP服务端
1. 通过`bind`参数配置,配置例子如下:
```shell
bind 0.0.0.0:53@eth0
bind [::]:53@eth0
bind :53@eth0
```
选项中:
* @eth0表示仅在对应的网口上提供服务。
* [::]:53 表示监听IPV6和IPV4地址。
* :53表示监听IPV4地址
## TCP服务端
1. 通过`bind-tcp`参数配置,配置例子如下:
```shell
bind-tcp 0.0.0.0:53@eth0
bind-tcp [::]:53@eth0
bind-tcp :53@eth0
```
1. 可选参数tcp-idle-time控制TCP空闲断链时间
```shell
tcp-idle-time 120
```
## DOT服务端
1. 通过`bind-tcp`参数配置,配置例子如下:
```shell
bind-tcp 0.0.0.0:53@eth0
bind-tcp [::]:53@eth0
bind-tcp :53@eth0
```
1. 设置证书和密钥文件
```shell
bind-cert-file smartdns-cert.pem
bind-cert-key-file smartdns-key.pem
bind-cert-key-pass pass
```
选项中:
* bind-cert-file: 表示证书文件路径。
* bind-cert-key-file表示证书密钥文件路径。
* bind-cert-key-pass 表示证书密钥文件密码,可选。
注意:
上述三个参数如果不指定的情况下smartdns将会自动在/etc/smartdns目录自动生成自签名证书`smartdns-cert.pem`和`smartdns-key.pem` key文件CN为smartdns。
1. 可选参数tcp-idle-time控制TCP空闲断链时间
```shell
tcp-idle-time 120
```