brook

Self-hosted TCP / UDP / HTTP(S) / WebSocket tunnels with a Web management panel

中文文档 | English (Docs) | Official Website | Quick Start | FAQ

---

g-brook/brook is a self-hosted network tunnel written in Go. It connects services behind NAT to a server you control and supports TCP, UDP, HTTP(S), and WebSocket tunnels through a Web management interface.

What can I use it for?

Use case	How Brook helps
Preview a local Web app	Publish a temporary HTTP(S) route without opening an inbound port on the client network.
Reach a TCP or UDP service	Forward SSH, databases, game servers, or custom protocols through a Brook server.
Operate several tunnels	Create tokens and routes in the Web panel and inspect connection status in one place.
Run on mixed environments	Use pre-built server and client packages for Linux, macOS, and Windows.

✨ Key Highlights

• 🚀 Blazing Fast Performance: High-concurrency architecture based on Go routines, with low latency and low resource consumption.
• 🛡️ All-around Compatibility: Supports SSH, HTTP/HTTPS, MySQL, Redis, RDP, and almost all mainstream application protocols.
• 🎨 Visual Management: Built-in modern Web panel for one-click initialization, real-time traffic monitoring, and connection status.
• 🔗 Versatile Protocols: Native support for TCP / UDP / HTTP(S) / WebSocket tunnels, easily handling various network environments (including CDN and firewall restrictions).
• 🛠️ Minimal Configuration: Only one JSON file needed, with auto-reconnection for worry-free operation.
• 💻 Cross-platform Support: Pre-compiled packages for Linux, macOS (Intel/M-series), and Windows (x64/ARM64).

---

📸 Interface Preview

Click to expand and view management interface screenshots

Initialization Wizard	Secure Login
Token Management	Tunnel Configuration

---

⚡ Quick Start

1. One-click Online Installation (Recommended)

bash -c "$(curl -fsSL https://www.gbrook.cc/install.sh)"

2. Manual Server Deployment

1. Download and Extract: Download the brook-sev for your platform from GitHub Releases.
2. Prepare Configuration (server.json):

   {
     "enableWeb": true,
     "webPort": 8000,
     "serverPort": 8909,
     "tunnelPort": 8919,
     "logger": { "logLevel": "info", "logPath": "./", "outs": "file" }
   }
   

3. Start Service:

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

4. Access Panel: Open your browser and visit http://your-ip:8000/index for initialization.

3. Client Configuration

1. Get Token: Generate it in the Web management backend.
2. Prepare Configuration (client.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. Start Client:

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

4. Linux Background Mode (systemd)

On Linux distributions with systemd, Brook provides built-in service management commands. The first time you run start, it will automatically create the unit file under /etc/systemd/system/ and then start the service.

Server:

sudo ./brook-sev start -c ./server.json
sudo ./brook-sev restart
sudo ./brook-sev stop
sudo ./brook-sev status
./brook-sev version

Client:

sudo ./brook-cli start -c ./client.json
sudo ./brook-cli restart
sudo ./brook-cli stop
sudo ./brook-cli status
./brook-cli version

5. Windows Startup

• Foreground (run in console): open cmd in the extracted directory and run brook-sev.exe -c server.json / brook-cli.exe -c client.json
• Console helper: use run.bat to launch and keep the console window open
• Background mode: brook-sev.exe start / brook-cli.exe start (then use restart / stop / status / version)

---

📥 Resource Download

Server (brook-sev)

Platform	Arch	File	Direct Download
Linux	amd64	brook-sev_Linux-x86_64.amd64.tar.gz	⬇️ Download
Linux	arm64	brook-sev_Linux-arm64.tar.gz	⬇️ Download
macOS	ARM64 (Apple M)	brook-sev_macOS-ARM64.Apple-M.tar.gz	⬇️ Download
macOS	Intel	brook-sev_macOS-Intel.tar.gz	⬇️ Download
Windows	x86_64	brook-sev_Windows-x86_64.tar.gz	⬇️ Download
Windows	ARM64	brook-sev_Windows-ARM64.tar.gz	⬇️ Download

Client (brook-cli)

Platform	Arch	File	Direct Download
Linux	amd64	brook-cli_Linux-x86_64.amd64.tar.gz	⬇️ Download
Linux	arm64	brook-cli_Linux-arm64.tar.gz	⬇️ Download
macOS	ARM64 (Apple M)	brook-cli_macOS-ARM64.Apple-M.tar.gz	⬇️ Download
macOS	Intel	brook-cli_macOS-Intel.tar.gz	⬇️ Download
Windows	x86_64	brook-cli_Windows-x86_64.tar.gz	⬇️ Download
Windows	arm64	brook-cli_Windows-arm64.tar.gz	⬇️ Download

---

🛠️ Advanced Development

Build from Source

# Frontend Build
cd portal/server/ && npm install && npm run build

# Server/Client Build
cd scmd/ && bash build.sh
cd ccmd/ && bash build.sh

---

❓ FAQ

How to solve connection timeouts?

Please ensure that ports 8909 and 8919 on the server side are open in the firewall/security group.

Does it support CDN forwarding?

Yes, by using WebSocket protocol tunnels, you can implement CDN forwarding with Nginx or Cloudflare.

How to run in the background?

Linux users can use `systemd` scripts or directly run `sudo ./brook-cli start`.

---

📄 Open Source License

This project is open-sourced under the Apache License 2.0 agreement.

---

If Brook helps you, please give it a ⭐ Star!