pommee/goaway

GoAway - DNS黑洞

!GitHub Release !GitHub Actions Workflow Status !GitHub Downloads (all assets, all releases) !Docker pulls

一款轻量级DNS黑洞，用于在网络层面阻止不需要的域名。可在广告、跟踪器和***域名到达设备之前对其进行拦截。

!https://github.com/pommee/goaway/blob/main/resources/dashboard.png?raw=true

查看更多截图

🌟 核心功能

• DNS级域名拦截
• 基于Web的管理仪表板
• 跨平台支持
• Docker支持
• 可自定义拦截规则
• 实时统计
• 低资源占用
• 以及更多功能...

📦 安装方法

选项1：Docker安装（推荐）

快速启动：

bash
docker run -d \
    --name goaway \
    -p 53:53/udp \
    -p 53:53/tcp \
    -p 8080:8080 \
    pommee/goaway:latest

使用Docker Compose（生产环境推荐）：

bash
# 下载compose文件
curl -O https://raw.githubusercontent.com/pommee/goaway/main/docker-compose.yml

# 启动服务
docker compose up -d

选项2：快速安装

快速安装脚本：

bash
# 安装最新版本
curl https://raw.githubusercontent.com/pommee/goaway/main/installer.sh | sh

# 安装特定版本
curl https://raw.githubusercontent.com/pommee/goaway/main/installer.sh | sh /dev/stdin 0.40.4

安装程序将：

1. 检测操作系统和架构
2. 下载相应的二进制文件
3. 安装到~/.local/bin
4. 设置必要的权限

手动安装： 直接从https://github.com/pommee/goaway/releases%E4%B8%8B%E8%BD%BD%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E3%80%82

选项3：从源码构建

bash
# 克隆仓库
git clone https://github.com/pommee/goaway.git
cd goaway

# 构建前端
make build

# 构建GoAway二进制文件
go build -o goaway

# 启动服务
./goaway

🚀 快速开始

基本使用

使用默认设置启动GoAway：

bash
goaway

您将看到确认服务正在运行的启动消息：

!https://github.com/pommee/goaway/blob/main/resources/started.png?raw=true

[!IMPORTANT] 首次设置： GoAway默认以认证模式运行，首次启动时会生成随机密码。此密码仅显示一次 - 请务必保存！

访问仪表板

1. 打开浏览器，导航至http://您的服务器IP:端口
2. 默认用户名：admin
3. 使用启动时生成的密码登录

配置设备

要将GoAway用作DNS服务器，请更新设备或路由器设置：

路由器配置（推荐）：

• 将路由器的DNS服务器设置为GoAway的IP地址
• 这将保护网络上的所有设备

单个设备：

• 更新DNS设置以指向GoAway的IP地址
• 主DNS：<goaway服务器IP>
• 备用DNS：1.1.1.1或8.8.8.8 - 用作回退

命令行选项

bash
goaway --help

GoAway是一个带Web界面的DNS黑洞

用法：
  goaway [标志]

标志：
  -h, --help                       显示帮助信息
      --ansi                       切换彩色日志。仅在非JSON格式日志中可用（默认true）
      --auth                       切换管理仪表板认证（默认true）
      --dns-port int               DNS服务器端口（默认53）
      --json                       切换JSON格式日志
      --log-level int              0 = DEBUG | 1 = INFO | 2 = WARNING | 3 = ERROR（默认1）
      --logging                    切换日志记录（默认true）
      --statistics-retention int   统计数据保留天数（默认7）
      --webserver-port int         Web服务器端口（默认8080）

配置文件

设置存储在https://github.com/pommee/goaway/blob/main/settings.yaml%E4%B8%AD%E3%80%82%E6%82%A8%E5%8F%AF%E4%BB%A5%E9%80%9A%E8%BF%87Web%E4%BB%AA%E8%A1%A8%E6%9D%BF%E6%88%96%E7%9B%B4%E6%8E%A5%E7%BC%96%E8%BE%91%E6%AD%A4%E6%96%87%E4%BB%B6%E6%9D%A5%E8%87%AA%E5%AE%9A%E4%B9%89%E6%8B%A6%E6%88%AA%E8%A7%84%E5%88%99%E3%80%81%E4%B8%8A%E6%B8%B8DNS%E6%9C%8D%E5%8A%A1%E5%99%A8%E5%92%8C%E5%85%B6%E4%BB%96%E9%80%89%E9%A1%B9%E3%80%82

使用示例

在自定义端口上运行：

bash
goaway --dns-port 6121 --webserver-port 3000

禁用认证（生产环境不推荐）：

bash
goaway --auth=false

启用调试日志：

bash
goaway --log-level 0

🔧 开发

开发模式运行

仪表板和服务器可以单独启动以进行开发，支持热重载：

bash
# 启动Web界面（带热重载）
make dev-website

# 在另一个终端启动服务器
make dev-server

贡献指南

欢迎贡献！您可以通过以下方式提供帮助：

1. 报告问题： 发现bug？https://github.com/pommee/goaway/issues/new?template=bug_report.md
2. 请求功能： 有想法？https://github.com/pommee/goaway/discussions%E6%88%96%E5%88%9B%E5%BB%BAhttps://github.com/pommee/goaway/issues/new?template=feature_request.md
3. 提交PR： Fork仓库，进行更改，然后提交拉取请求

⚠️ 平台支持

注意：主要测试在Linux（amd64）上进行。虽然旨在支持所有列出的平台，但macOS和Windows上的功能可能有所不同。

🔍 故障排除

常见问题

权限被拒绝（端口53）

• DNS服务器通常需要提升权限才能绑定到53端口

无法访问仪表板

• 检查8080端口是否可用且未被防火墙阻止
• 尝试在同一台机器上通过http://localhost:8080访问

DNS不工作

• 验证GoAway是否正在运行并监听正确的接口
• 检查设备DNS设置是否指向GoAway的IP地址
• 使用nslookup google.com <goaway-ip>或dig @<goaway-ip> google.com.进行测试

📈 性能

GoAway设计为轻量级且高效：

• 内存使用： 通常<50MB RAM
• CPU使用： 对系统性能影响极小
• 网络： 低延迟DNS解析
• 存储： 日志和统计数据占用磁盘空间极小

📜 许可证

本项目采用MIT许可证 - 详见https://github.com/pommee/goaway/blob/main/LICENSE%E6%96%87%E4%BB%B6%E3%80%82

🙏 致谢

本项目深受https://github.com/pi-hole/pi-hole%E5%90%AF%E5%8F%91%E3%80%82%E6%84%9F%E8%B0%A2%E6%89%80%E6%9C%89%E7%9B%B8%E5%85%B3%E4%BA%BA%E5%91%98%E7%9A%84%E5%B7%A5%E4%BD%9C%E3%80%82