English

Brook 是一款跨平台（Linux/macOS/Windows）的高性能网络隧道与代理工具，专为内网穿透设计，采用 Go 语言开发。它支持多种传输协议，包括 TCP、UDP、HTTP(S) 和 WebSocket，并兼容 SSH、HTTP、Redis、MySQL 等主流应用协议，同时提供直观的可视化管理界面，方便进行配置和实时监控。

• ✅ 多协议支持：TCP / UDP / HTTP(S) / WebSocket 隧道
• 🔧 广泛兼容性：兼容 SSH、HTTP(S)、MySQL、Redis 等常见协议
• 🖥️ 可视化界面：内置 Web 管理面板，支持初始化、配置与状态监控
• ⚙️ 简单易用：通过 client.json 和 server.json 快速完成配置，支持自动重连和日志记录
• 🚀 轻量高效：资源占用低，适用于各种规模的应用场景
• 🌍 跨平台部署：支持主流操作系统，灵活适应不同环境需求

前往 GitHub Releases 页面下载适合您系统的预编译包：

💡 提示：上述链接将自动跳转到最新版本。若需查看历史版本，请访问 Releases 页面。

mkdir -p ./brook-sev && tar -xzf brook-sev_Linux-arm64.tar.gz -C ./brook-sev cd brook-sev

{
  "enableWeb": true,
  "webPort": 8000,
  "serverPort": 8909,
  "tunnelPort": 8919,
  "token": "", // 若不启用 Web 模式，可在此设置静态 token
  "logger": {
    "logLevel": "info",
    "logPath": "./",
    "outs": "file"
  }
}

./brook-sev -c ./server.json

打开浏览器访问 http://localhost:8000/index，首次登录需要初始化账户信息。

1. 设置管理员账号与密码
2. 登录后生成 Token

相关截图说明：

mkdir -p ./brook-cli && tar -xzf brook-cli_Linux-arm64.tar.gz -C ./brook-cli cd brook-cli

您可以从服务端管理界面下载模板并根据实际需求修改：

{
  "serverPort": 8909,
  "serverHost": "127.0.0.1",
  "token": "<在管理后台生成的Token>",
  "pingTime": 2000,
  "tunnels": [
    {
      "type": "udp",
      "destination": "127.0.0.1:9000",
      "proxyId": "333223"
    },
    {
      "type": "http",
      "destination": "127.0.0.1:8081",
      "proxyId": "HttpLocal-2",
      "httpId": "local"
    }
  ]
}

./brook-cli -c ./client.json

• 获取 ProxyId 模板：

  

• 获取 httpId（仅限 HTTP/HTTPS 隧道）：

  

./brook-sev -c ./server.json

./brook-sev --configs ./server.json

./brook-cli -c ./client.json

./brook-cli --configs ./client.json

sudo ./brook-cli start

./brook-cli help

cd portal/server/ npm install npm run build

cd server/ bash gobuild.sh

cd client/ bash gobuild.sh

• 解压失败？

  使用正确的命令：tar -xzf <file>.tar.gz，避免误用打包命令 tar -czvf。

• 连接不上服务端？

  请检查 serverHost、serverPort 和 token 是否正确；确认服务端是否正常运行且防火墙允许对应端口访问。

• HTTP/HTTPS 隧道异常？

  客户端中的 httpId 必须与服务端 Web 设置完全匹配。

• 端口冲突？

  如果默认端口（如 8000/8909/8919）已被占用，可以在配置中更换其他空闲端口。

• 如何调试问题？

  查阅 logger.logPath 中的日志文件，如有必要，可临时将 logLevel 调整为 debug 获取更详细的信息。

├── server/ # 服务端核心逻辑与 Web 管理界面
├── client/ # 客户端核心逻辑与 CLI 接口
├── common/ # 公共模块（配置解析、日志系统、传输封装等）
├── portal/server/ # 前端管理页面（基于 Vite 构建）
└── document/ # 文档资料、截图和其他辅助资源

如需进一步了解功能细节或扩展协议支持，请参阅各目录下的源代码及注释。