Browse Source

docs: update usage of cleardns

dev
Dnomd343 2 years ago
parent
commit
564304f5d6
  1. 195
      README.md

195
README.md

@ -1,31 +1,23 @@
# ClearDNS # ClearDNS
+ 无污染的 DNS 解析,避开运营商和防火长城的污染与劫持 + 无污染的 DNS 解析,避开运营商和防火长城的污染与劫持
+ 支持多种加密协议,包括 DoH 、DoT 、DoQ 与 DNSCrypt + 支持多种加密协议,包括 DoH 、DoT 、DoQ 与 DNSCrypt
+ 部署后更改 DHCP 选项即可生效,无需配置内网设备 + ✅ DNS 请求审计,记录不同设备的查询、拦截、返回等信息
+ DNS 请求审计,记录不同设备的查询日志 + ✅ 自定义拦截规则,可屏蔽指定应用,如 QQ 、微信、微博等
+ 自定义拦截规则,可屏蔽指定应用,如 QQ 、微信、微博等 + ✅ 强制 hosts 功能,将指定域名直接解析到指定 IP 上
+ IPv6支持,拦截特定的 DNS 请求类型,修改指定域名的 TTL + IPv6 支持,拦截特定的 DNS 请求类型,修改指定域名的 TTL
+ 在 DNS 层面上实现去广告与防跟踪功能,按需求配置自定义的拦截规则 + 在 DNS 层面上实现去广告与防跟踪功能,按需求配置自定义规则
+ 无论 APP 、网页还是机顶盒、IoT 设备等均可拦截 由于 ClearDNS 工作在 DNS 层面,无论 APP 、网页还是机顶盒、IoT 设备等均可生效;它可以部署在内网中,为局域网设备提供服务,建议运行在内网一台长期开机的设备上(主路由、树莓派、小主机、旁路由、NAS 设备等),同时 ClearDNS 也可部署在公网服务器上,面向国内网络提供无污染服务。
同时兼具强制 hosts 功能,将指定域名直接解析到指定 IP 上
ClearDNS 可部署在主路由器上,但需要路由器刷入支持 Docker 的固件;对于性能较低或不支持刷机的路由器,建议部署在内网一台长期开机的设备上(树莓派、小主机、旁路由等)。
ClearDNS也可部署在公网服务器上,面向国内提供服务
## 设计架构 ## 设计架构
ClearDNS 运行架构:
> AdGuardHome 用于加载拦截规则,可以自定义是否开启 > AdGuardHome 用于加载拦截规则,可以自定义是否开启
```mermaid ```mermaid
@ -113,11 +105,11 @@ assets:
### Port ### Port
DNS 服务端口,支持常规的 TCP 与 UDP 查询,默认为 `53` ;若您想开放 `DNS over TLS` 、`DNS over HTTPS` 等其他协议的服务,可以在 AdGuardHome 中进行配置。 DNS 服务端口,支持常规的 TCP 与 UDP 查询,默认为 `53` ;若您想开放 `DNS over TLS` 、`DNS over HTTPS` 等其他协议的服务,可以在 AdGuardHome 中进行具体配置。
### Cache ### Cache
DNS 缓存配置,此处与 AdGuardHome 中的缓存不相关,建议打开其中一个即可 DNS 缓存配置,此处与 AdGuardHome 中的缓存不相关,建议打开其中一个即可
```yaml ```yaml
cache: cache:
@ -154,7 +146,7 @@ adguard:
### Diverter ### Diverter
DNS 分流选项,将数据 DNS 分流器选项,指定端口与分流规则
```yaml ```yaml
diverter: diverter:
@ -310,7 +302,7 @@ ClearDNS基于Docker网络有以下三种部署模式:
以下操作均于 root 用户下执行 以下操作均于 root 用户下执行
``` ```bash
# 检查Docker环境 # 检查Docker环境
shell> docker --version shell> docker --version
Docker version ···, build ··· Docker version ···, build ···
@ -319,7 +311,7 @@ Docker version ···, build ···
shell> wget -qO- https://get.docker.com/ | bash shell> wget -qO- https://get.docker.com/ | bash
``` ```
XProxy 同时发布在多个镜像源上: ClearDNS 同时发布在多个镜像源上:
+ `Docker Hub` :`dnomd343/cleardns` + `Docker Hub` :`dnomd343/cleardns`
@ -335,24 +327,25 @@ XProxy 同时发布在多个镜像源上:
<br/> <br/>
``` ```bash
# 检查端口占用 # 检查端口占用
shell> netstat -tlnpu | grep -E ":53|:80" shell> netstat -tlnpu | grep -E ":53|:80"
# 如果TCP/53或UDP/53已被占用,请先关闭对应进程 # 如果TCP/53或UDP/53已被占用,请先关闭对应进程
# 如果TCP/80端口被占用,可以关闭对应进程,也可使用其他端口 # 如果TCP/80端口被占用,可以关闭对应进程,也可使用其他端口
``` ```
``` > 映射系统时间文件以同步容器时区,容器内默认为 UTC0 时区
```bash
# 运行ClearDNS容器 # 运行ClearDNS容器
# 映射系统时间文件以同步容器内部时区 shell> docker run -dit \
shell> docker run --restart always \ --restart always \
--name cleardns -d \ --name cleardns --hostname cleardns \
-v /etc/cleardns/:/cleardns/ \ --volume /etc/cleardns/:/cleardns/ \
-v /etc/timezone:/etc/timezone:ro \ --volume /etc/timezone:/etc/timezone:ro \
-v /etc/localtime:/etc/localtime:ro \ --volume /etc/localtime:/etc/localtime:ro \
-p 53:53/udp -p 53:53 -p 80:80 \ --port 53:53/udp --port 53:53 --port 80:80 \
dnomd343/cleardns dnomd343/cleardns
# 此处为DockerHub镜像源,可按上文链接替换为其他源
``` ```
</details> </details>
@ -363,22 +356,23 @@ dnomd343/cleardns
<br/> <br/>
``` ```bash
# 检查端口占用 # 检查端口占用
shell> netstat -tlnpu | grep -E ":53|:80|:4053|:5353|:6053" shell> netstat -tlnpu | grep -E ":53|:80|:4053|:5353|:6053"
# 如果UDP/53、UDP/4053、UDP/5353、UDP/6053、TCP/53、TCP/80、TCP/4053、TCP/5353、TCP/6053已被占用,请先关闭对应进程 # 如果UDP/53、UDP/4053、UDP/5353、UDP/6053、TCP/53、TCP/80、TCP/4053、TCP/5353、TCP/6053已被占用,请先关闭对应进程
``` ```
``` > 映射系统时间文件以同步容器时区,容器内默认为 UTC0 时区
```bash
# 运行ClearDNS容器 # 运行ClearDNS容器
docker run --restart always \ docker run -dit --network host \
--name cleardns -d \ --restart always \
--network host \ --name cleardns --hostname cleardns \
-v /etc/cleardns/:/cleardns/ \ --volume /etc/cleardns/:/cleardns/ \
-v /etc/timezone:/etc/timezone:ro \ --volume /etc/timezone:/etc/timezone:ro \
-v /etc/localtime:/etc/localtime:ro \ --volume /etc/localtime:/etc/localtime:ro \
dnomd343/cleardns dnomd343/cleardns
# 此处为DockerHub镜像源,可按上文链接替换为其他源
``` ```
</details> </details>
@ -389,9 +383,9 @@ dnomd343/cleardns
<br/> <br/>
启动容器前需要创建一个macvlan网络 启动容器前需要创建 macvlan 网络
``` ```bash
# 开启网卡混杂模式 # 开启网卡混杂模式
shell> ip link set eth0 promisc on shell> ip link set eth0 promisc on
@ -404,11 +398,14 @@ shell> docker network create -d macvlan \
宿主机网络更改配置 宿主机网络更改配置
``` ```bash
# Debian系示例 # Debian系示例
shell> vim /etc/network/interfaces shell> vim /etc/network/interfaces
```
# 添加以下内容,按实际情况指定网络信息 添加以下内容,按实际情况指定网络信息
```ini
auto eth0 auto eth0
iface eth0 inet manual iface eth0 inet manual
@ -420,36 +417,36 @@ iface macvlan inet static
dns-nameservers 192.168.2.3 dns-nameservers 192.168.2.3
pre-up ip link add macvlan link eth0 type macvlan mode bridge pre-up ip link add macvlan link eth0 type macvlan mode bridge
post-down ip link del macvlan link eth0 type macvlan mode bridge post-down ip link del macvlan link eth0 type macvlan mode bridge
```
```bash
# 重启宿主机 # 重启宿主机
shell> reboot shell> reboot
``` ```
运行容器 > 映射系统时间文件以同步容器时区,容器内默认为 UTC0 时区
``` ```bash
shell> docker run --restart always \ # 运行ClearDNS容器
--name cleardns \ shell> docker run -dit --network macvlan \
--network macvlan \ --restart always --privileged \
--privileged -d \ --name cleardns --host cleardns \
-v /etc/cleardns/:/cleardns/ \ --volume /etc/cleardns/:/cleardns/ \
-v /etc/timezone:/etc/timezone:ro \ --volume /etc/timezone:/etc/timezone:ro \
-v /etc/localtime:/etc/localtime:ro \ --volume /etc/localtime:/etc/localtime:ro \
dnomd343/cleardns dnomd343/cleardns
# 此处为DockerHub镜像源,可按上文链接替换为其他源
``` ```
编辑macvlan网路的IP地址 编辑 macvlan 网络的 IP 地址,修改 ClearDNS 配置文件,指定容器的IP与网关,应按实际网络情况配置
```yaml
custom:
- "ip addr flush dev eth0"
- "ip addr add 192.168.2.3/24 dev eth0"
- "ip route add default via 192.168.2.2"
``` ```
# 编辑自定义初始化脚本
shell> vim /etc/cleardns/custom.sh
# 写入以下内容,修改容器的IP与网关,按实际网络情况指定
ip addr flush dev eth0
ip addr add 192.168.2.3/24 brd 192.168.2.255 dev eth0
ip route add default via 192.168.2.2
```bash
# 重启容器生效 # 重启容器生效
shell> docker restart cleardns shell> docker restart cleardns
``` ```
@ -458,17 +455,16 @@ shell> docker restart cleardns
<hr/> <hr/>
``` ClearDNS 会将数据持久化,以在重启 Docker 或宿主机后保留配置及日志
# ClearDNS会将数据持久化,以在重启Docker或宿主机后保留配置及日志
```bash
# 使用以下命令清除之前的ClearDNS配置及数据 # 使用以下命令清除之前的ClearDNS配置及数据
shell> rm -rf /etc/cleardns shell> rm -rf /etc/cleardns
``` ```
### 2. 指定上游DNS服务器 ### 2. 修改配置文件
上游DNS信息位于 `/etc/cleardns/upstream.json`,分为国内外两组,国内组可指定阿里DNS、DNSPod、114DNS等国内公共DNS服务,国外组需要指定可用的加密DNS服务,建议自行搭建DoH或DoT服务器。
ClearDNS支持多种[DNS服务协议](https://blog.dnomd343.top/dns-server/#DNS%E5%90%84%E5%8D%8F%E8%AE%AE%E7%AE%80%E4%BB%8B),包括常规DNS、DNS-over-TLS、DNS-over-HTTPS、DNS-over-QUIC、DNSCrypt `cleardns.yml` 中指定上游 DNS 服务器,国内组可指定阿里 DNS 、DNSPod、114DNS 等国内公共 DNS 服务,国外组需要指定可用的加密 DNS 服务,建议自行搭建服务器,或使用共享的跨境服务器(例如 DH-DNS 与 LoopDNS 等)。
> DNSCrypt使用DNS Stamp封装,可以在[这里](https://dnscrypt.info/stamps)在线解析或生成链接内容。 > DNSCrypt使用DNS Stamp封装,可以在[这里](https://dnscrypt.info/stamps)在线解析或生成链接内容。
@ -494,66 +490,17 @@ quic://dns.adguard.com
sdns://AQIAAAAAAAAAFDE3Ni4xMDMuMTMwLjEzMDo1NDQzINErR_JS3PLCu_iZEIbq95zkSV2LFsigxDIuUso_OQhzIjIuZG5zY3J5cHQuZGVmYXVsdC5uczEuYWRndWFyZC5jb20 sdns://AQIAAAAAAAAAFDE3Ni4xMDMuMTMwLjEzMDo1NDQzINErR_JS3PLCu_iZEIbq95zkSV2LFsigxDIuUso_OQhzIjIuZG5zY3J5cHQuZGVmYXVsdC5uczEuYWRndWFyZC5jb20
``` ```
ClearDNS默认配置了以下DNS服务器 修改配置文件后,重启 Docker 容器生效
```
# 此处指定的国外组服务器可能已被GFW屏蔽,强烈建议使用私有加密DNS服务器
# bootstrap指定DNS服务器IP地址,用于解析加密DNS服务器域名,省略时使用系统DNS
# 若指定多台服务器,DNS请求时将并发查询,因此不宜指定过多服务器
# 当primary中DNS均不可用时,将自动尝试fallback中的DNS地址
{
"domestic": {
"bootstrap": "223.5.5.5",
"primary": [
"tls://dns.alidns.com",
"https://doh.pub/dns-query"
],
"fallback": [
"223.5.5.5",
"119.29.29.29"
]
},
"foreign": {
"bootstrap": "8.8.8.8",
"primary": [
"tls://dns.google",
"https://dns.cloudflare.com/dns-query"
],
"fallback": [
"1.1.1.1",
"8.8.8.8"
]
}
}
```
重启Docker容器生效
``` ```
shell> docker restart cleardns shell> docker restart cleardns
``` ```
### 3. 配置域名分流规则 ### 3. 配置 AdGuardHome
ClearDNS依据规则列表分流解析,使用以下规则文件,位于文件夹 `/etc/cleardns/asset`
+ [`china-ip.txt`](https://res.343.re/Share/chinalist/china-ip.txt):国内IP段
+ [`chinalist.txt`](https://res.343.re/Share/chinalist/chinalist.txt):国内常见域名
+ [`gfwlist.txt`](https://res.343.re/Share/gfwlist/gfwlist.txt):被GFW屏蔽的常见域名
以上文件将在每天凌晨4点自动更新,如果不想启用该功能,创建 `/etc/cleardns/asset/no-update` 文件即可。
规则文件默认从 `res.dnomd343.top` 拉取,若该域名被污染或屏蔽,你可以使用本项目 `asset/gfwlist/build``asset/chinalist/build` 下的构建脚本自行生成规则列表。
> 构建脚本需要访问Github获取资源,手动构建时请注意网络连通性。
### 4. 配置AdGuardHome
浏览器打开ClearDNS服务,host与bridge模式输入宿主机IP地址,macvlan模式输入容器IP,进入AdGuardHome配置界面,设置账号和密码,登录进入AdGuardHome管理界面。 浏览器打开 ClearDNS 服务,host 与 bridge 模式输入宿主机 IP 地址,macvlan 模式输入容器 IP,即可进入 AdGuardHome 配置界面,默认账号为 `admin` ,密码为 `cleardns`,可在配置文件中指定,登录后进入 AdGuardHome 管理界面。
进入 `设置` - `DNS设置`修改上游DNS为 `127.0.0.1:5353`,其他选项保持默认。此外,下方其他设置中建议启用DNSSEC,内存允许的情况下适当拉大缓存大小,并开启乐观缓存。 进入 `设置` - `DNS设置`,建议启用 DNSSEC ,若配置文件中禁用了出口缓存,可在此处配置缓存选项,内存允许的情况下适当拉大缓存大小,并开启乐观缓存。
DNS封锁清单中,可配置以下规则: DNS封锁清单中,可配置以下规则:
@ -569,7 +516,7 @@ DNS封锁清单中,可配置以下规则:
### 5. 配置 DHCP 信息 ### 5. 配置 DHCP 信息
为了使ClearDNS生效,需要在路由器DHCP服务中指定DNS服务器,host与bridge模式指定为宿主机IP,macvlan模式指定为容器IP。 若您的服务部署在内网,为了使 ClearDNS 生效,需要在路由器 DHCP 服务中指定 DNS 服务器,host bridge 模式指定为宿主机 IP ,macvlan 模式指定为容器 IP 即可
> 对于内网中一些固定IP信息的设备,需要手动更改其DNS为上述IP地址。 > 对于内网中一些固定IP信息的设备,需要手动更改其DNS为上述IP地址。
@ -578,10 +525,8 @@ DNS封锁清单中,可配置以下规则:
**本地构建** **本地构建**
``` ```
# 克隆仓库
shell> git clone https://github.com/dnomd343/ClearDNS.git shell> git clone https://github.com/dnomd343/ClearDNS.git
shell> cd ClearDNS shell> cd ./ClearDNS/
# 构建镜像
shell> docker build -t cleardns . shell> docker build -t cleardns .
``` ```

Loading…
Cancel
Save