crab-hole 的安装和配置教程

项目基础介绍

crab-hole 是一个用 Rust 编写的跨平台 Pi-hole 克隆项目。它可以作为网络范围内的广告和恶意软件屏蔽工具，或者在你的个人电脑上运行。crab-hole 支持多种安全通信协议，如 DNS-over-HTTPS (DOH)、DNS-over-QUIC (DOQ) 和 DNS-over-TLS (DOT)，同时为上游提供 DNSSEC 支持。此外，它还配备了隐私友好的默认日志设置。

项目使用的关键技术和框架

该项目主要使用 Rust 语言编写，利用了 hickory-dns 和 trust-dns 这两个库来实现 DNS 相关的功能。Rust 语言以其安全性和性能而闻名，是系统编程的首选语言之一。hickory-dns 和 trust-dns 是处理 DNS 查询和解析的常用框架。

项目安装和配置的准备工作

在开始安装 crab-hole 前，请确保你的系统已经安装了 Rust 编程语言环境。Rust 的安装可以通过官方的 rustup 工具来进行。

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

安装完成后，确保将 Rust 的 cargo 工具的路径添加到系统的环境变量中。

source $HOME/.cargo/env

安装步骤

1. 克隆项目

首先，需要从 GitHub 上克隆 crab-hole 项目到本地。

git clone https://github.com/LuckyTurtleDev/crab-hole.git
cd crab-hole

2. 构建项目

在项目目录中，使用 cargo 来构建项目。

cargo install crab-hole --locked

确保 ~/.cargo/bin 路径已经添加到系统的 PATH 环境变量中，这样你就可以在命令行中直接运行 crab-hole 命令。

3. 配置项目

在项目目录中，应该有一个名为 config.toml 的配置文件。你需要根据实际情况修改此文件中的设置。以下是一个基本的配置示例：

[blocklist]
include_subdomains = true
lists = [
    "https://raw.githubusercontent.com/StevenBlack/hosts/master/alternates/fakenews-gambling-porn/hosts",
    "https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt",
    "file:///blocked.txt"
]

[allow_list]
lists = [
    "file:///allowed.txt"
]

[api]
port = 8080
listen = "127.0.0.1"
show_doc = true

[downstream]
protocol = "udp"
listen = "localhost"
port = 8080

[downstream]
protocol = "udp"
listen = "::"
port = 8053

[downstream.tls]
listen = "::"
port = 8054
certificate = "dns.example.com.crt"
key = "dns.example.com.key"

[downstream.quic]
listen = "127.0.0.1"
port = 8055
certificate = "dns.example.com.crt"
key = "dns.example.com.key"
dns_hostname = "dns.example.com"

请注意，你需要用自己的证书和密钥替换 certificate 和 key 字段的值。

4. 运行项目

配置完成后，你可以在命令行中直接运行以下命令来启动 crab-hole 服务。

crab-hole

如果需要检查配置文件的语法是否正确，可以使用以下命令来进行验证。

crab-hole validate-config

如果配置文件中没有语法错误，服务将会启动，并且你可以在浏览器中访问配置的 API 端口（例如 http://127.0.0.1:8080）来查看服务的状态和统计信息。

以上就是 crab-hole 的安装和配置指南，希望对初学者有所帮助。