# brook

**Repository Path**: gbrook/brook

## Basic Information

- **Project Name**: brook
- **Description**: No description available
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-04
- **Last Updated**: 2026-08-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img src="document/logo.svg" alt="Brook Logo" width="120" height="120" />
</p>

<p align="center">
  <img src="document/font-dark.svg" alt="Brook" width="260" height="60" />
</p>

<p align="center">
  <strong>支持 TCP / UDP / HTTP(S) / WebSocket 与 Web 管理面板的自托管网络隧道</strong>
</p>

<p align="center">
  <a href="https://github.com/g-brook/brook/releases">
    <img src="https://img.shields.io/github/v/release/g-brook/brook?label=Latest&style=flat-square&color=blue" alt="Latest Release" />
  </a>
  <a href="https://github.com/g-brook/brook/stargazers">
    <img src="https://img.shields.io/github/stars/g-brook/brook?style=flat-square&logo=github" alt="Stars" />
  </a>
  <a href="https://github.com/g-brook/brook/network/members">
    <img src="https://img.shields.io/github/forks/g-brook/brook?style=flat-square&logo=github" alt="Forks" />
  </a>
  <a href="https://github.com/g-brook/brook/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/g-brook/brook?style=flat-square&color=orange" alt="License" />
  </a>
  <img src="https://img.shields.io/github/go-mod/go-version/g-brook/brook?style=flat-square&logo=go" alt="Go Version" />
  <a href="https://github.com/g-brook/brook/issues">
    <img src="https://img.shields.io/github/issues/g-brook/brook?style=flat-square&color=red" alt="Issues" />
  </a>
</p>

<p align="center">
  <a href="README.md">English</a> |
  <a href="https://www.gbrook.cc">官方网站</a> |
  <a href="#-快速开始">快速开始</a> |
  <a href="#-常见问题解答faq">常见问题</a>
</p>

---

**g-brook/brook** 是一个使用 Go 编写的自托管网络隧道。它把 NAT 后方的服务连接到您自行控制的服务端，并通过 Web 管理界面管理 TCP、UDP、HTTP(S) 和 WebSocket 隧道。

## 适用场景

| 场景 | Brook 可以做什么 |
| :--- | :--- |
| 预览本地 Web 应用 | 无需在客户端网络开放入站端口，即可临时发布 HTTP(S) 路由。 |
| 访问 TCP 或 UDP 服务 | 通过 Brook 服务端转发 SSH、数据库、游戏服务或自定义协议。 |
| 管理多条隧道 | 在 Web 面板中创建 Token 和路由，并集中查看连接状态。 |
| 混合系统部署 | 使用 Linux、macOS 和 Windows 的服务端及客户端预编译包。 |

> [!NOTE]
> 分享或搜索本项目时，请使用完整仓库名 **`g-brook/brook`**。“Brook”这个名称也被其他网络工具使用。

## ✨ 核心亮点

- 🚀 **极速性能**：基于 Go 协程的高并发架构，低延迟、低资源占用。
- 🛡️ **全能兼容**：支持 SSH、HTTP/HTTPS、MySQL、Redis、RDP 等几乎所有主流应用协议。
- 🎨 **可视化管理**：内置现代化的 Web 面板，一键初始化，实时监控流量与连接状态。
- 🔗 **多变协议**：原生支持 TCP / UDP / HTTP(S) / WebSocket 隧道，轻松应对各种网络环境（包括 CDN 和防火墙限制）。
- 🛠️ **极简配置**：只需一个 JSON 文件，支持自动重连，让运维无忧。
- 💻 **跨平台支持**：预编译包覆盖 Linux, macOS (Intel/M-series), Windows (x64/ARM64)。

---

## 📸 界面预览

<details open>
<summary>点击展开查看管理界面截图</summary>

| **初始化向导** | **安全登录** |
|:---:|:---:|
| <img src="document/img_1.png" width="400" /> | <img src="document/img_2.png" width="400" /> |
| **Token 管理** | **隧道配置** |
| <img src="document/img_7.png" width="400" /> | <img src="document/img_4.png" width="400" /> |

</details>

---

## ⚡ 快速开始

> [!IMPORTANT]
> Brook 会跨越网络边界暴露服务。经核验，v0.3.2 的管理连接和 smux 数据连接未默认封装 TLS。用于本地测试以外的环境前，请使用加密覆盖网络与应用层 TLS/SSH，配置防火墙，并将 Web 管理面板置于 TLS 反向代理或可信网络之后。执行一键安装前请先审阅 [`install.sh`](install.sh)；也可以从 [Releases](https://github.com/g-brook/brook/releases) 手动下载并核对 SHA-256 摘要。

### 1. 一键在线安装 (推荐)
```shell
bash -c "$(curl -fsSL https://www.gbrook.cc/install.sh)"
```

### 2. 手动部署服务端
1. **下载并解压**：从 [GitHub Releases](https://github.com/g-brook/brook/releases) 下载对应平台的 `brook-sev`。
2. **准备配置** (`server.json`)：
   ```json
   {
     "enableWeb": true,
     "webPort": 8000,
     "serverPort": 8909,
     "tunnelPort": 8919,
     "logger": { "logLevel": "info", "logPath": "./", "outs": "file" }
   }
   ```
3. **启动服务**：
   ```shell
   ./brook-sev -c ./server.json
   ```
4. **访问面板**：打开浏览器访问 `http://your-ip:8000/index` 进行初始化。

### 3. 配置客户端
1. **获取 Token**：在 Web 管理后台生成。
2. **准备配置** (`client.json`)：
   ```json
   {
     "serverHost": "your-server-ip",
     "serverPort": 8909,
     "token": "YOUR_GENERATED_TOKEN",
     "tunnels": [
       { "type": "tcp", "destination": "127.0.0.1:80", "proxyId": "web-proxy-1" }
     ]
   }
   ```
3. **启动客户端**：
   ```shell
   ./brook-cli -c ./client.json
   ```

### 4. Linux 后台启动 (systemd)

在支持 `systemd` 的 Linux 发行版上，Brook 内置了服务管理命令。首次执行 `start` 会自动在 `/etc/systemd/system/` 生成对应的 service 文件，然后启动服务。

服务端：
```shell
sudo ./brook-sev start -c ./server.json
sudo ./brook-sev restart
sudo ./brook-sev stop
sudo ./brook-sev status
./brook-sev version
```

客户端：
```shell
sudo ./brook-cli start -c ./client.json
sudo ./brook-cli restart
sudo ./brook-cli stop
sudo ./brook-cli status
./brook-cli version
```

### 5. Windows 运行方式

- 前台运行（控制台）：在解压目录打开 `cmd`，执行 `brook-sev.exe -c server.json` / `brook-cli.exe -c client.json`
- 控制台启动：使用 `run.bat` 启动并保持控制台窗口不退出
- 后台运行：`brook-sev.exe start` / `brook-cli.exe start`（再用 `restart` / `stop` / `status` / `version` 管理）

---

## 📥 资源下载

### 服务端 (brook-sev)

| 平台 | 架构 | 文件 | 直链下载 |
| :--- | :--- | :--- | :---: |
| Linux | amd64 | `brook-sev_Linux-x86_64.amd64.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-sev_Linux-x86_64.amd64.tar.gz) |
| Linux | arm64 | `brook-sev_Linux-arm64.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-sev_Linux-arm64.tar.gz) |
| macOS | ARM64 (Apple M) | `brook-sev_macOS-ARM64.Apple-M.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-sev_macOS-ARM64.Apple-M.tar.gz) |
| macOS | Intel | `brook-sev_macOS-Intel.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-sev_macOS-Intel.tar.gz) |
| Windows | x86_64 | `brook-sev_Windows-x86_64.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-sev_Windows-x86_64.tar.gz) |
| Windows | ARM64 | `brook-sev_Windows-ARM64.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-sev_Windows-ARM64.tar.gz) |

### 客户端 (brook-cli)

| 平台 | 架构 | 文件 | 直链下载 |
| :--- | :--- | :--- | :---: |
| Linux | amd64 | `brook-cli_Linux-x86_64.amd64.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-cli_Linux-x86_64.amd64.tar.gz) |
| Linux | arm64 | `brook-cli_Linux-arm64.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-cli_Linux-arm64.tar.gz) |
| macOS | ARM64 (Apple M) | `brook-cli_macOS-ARM64.Apple-M.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-cli_macOS-ARM64.Apple-M.tar.gz) |
| macOS | Intel | `brook-cli_macOS-Intel.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-cli_macOS-Intel.tar.gz) |
| Windows | x86_64 | `brook-cli_Windows-x86_64.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-cli_Windows-x86_64.tar.gz) |
| Windows | arm64 | `brook-cli_Windows-arm64.tar.gz` | [⬇️ 下载](https://github.com/g-brook/brook/releases/latest/download/brook-cli_Windows-arm64.tar.gz) |

---

## 🛠️ 进阶开发

### 从源码构建
```bash
# 前端构建
cd portal/server/ && npm install && npm run build

# 服务端/客户端构建
cd scmd/ && bash build.sh
cd ccmd/ && bash build.sh
```

---

## ❓ 常见问题解答 (FAQ)

<details>
<summary>如何解决连接超时？</summary>
请确保服务端的 8909 和 8919 端口已在防火墙/安全组中开放。
</details>

<details>
<summary>支持 CDN 转发吗？</summary>
是的，通过使用 WebSocket 协议隧道，您可以配合 Nginx 或 Cloudflare 实现 CDN 转发。
</details>

<details>
<summary>如何实现后台运行？</summary>
Linux 用户可以使用 `systemd` 脚本或直接运行 `sudo ./brook-cli start`。
</details>

---

## 📄 开源协议
本项目采用 [Apache License 2.0](LICENSE) 协议开源。

---

<p align="center">
  <b>如果 Brook 对您有所帮助，请点一个 ⭐ Star 以资鼓励！</b><br/>
  <img src="https://img.shields.io/badge/Made%20with-Go-00ADD8?style=flat-square&logo=go" alt="Made with Go" />
</p>