Brook

---

v20180707

• Mode wiki
• Thanks KarlZeo for letting us can brew cask install brook

---

Table of Contents

• What is Brook
• Download
• Packages
• Server
• Client (CLI)
• Client (GUI)
• Tunnel
• Tproxy
• Relay
• Socks5
• Socks5 to HTTP
• Shadowsocks
• Contributing
• License

What is Brook

Brook is a cross-platform(Linux/MacOS/Windows/Android/iOS) proxy/vpn software.
Brook's goal is to keep it simple, stupid and not detectable.

Download

Download	Server/Client	OS	Arch	Remark
brook	Server & Client	Linux	amd64	CLI
brook_linux_386	Server & Client	Linux	386	CLI
brook_linux_arm64	Server & Client	Linux	arm64	CLI
brook_linux_arm5	Server & Client	Linux	arm5	CLI
brook_linux_arm6	Server & Client	Linux	arm6	CLI
brook_linux_arm7	Server & Client	Linux	arm7	CLI
brook_linux_mips	Server & Client	Linux	mips	CLI
brook_linux_mipsle	Server & Client	Linux	mipsle	CLI
brook_linux_mips64	Server & Client	Linux	mips64	CLI
brook_linux_mips64le	Server & Client	Linux	mips64le	CLI
brook_linux_ppc64	Server & Client	Linux	ppc64	CLI
brook_linux_ppc64le	Server & Client	Linux	ppc64le	CLI
brook_macos_amd64	Server & Client	MacOS	amd64	CLI
brook_windows_amd64.exe	Server & Client	Windows	amd64	CLI
brook_windows_386.exe	Server & Client	Windows	386	CLI
Brook.dmg	Client	MacOS	amd64	GUI
Brook.Setup.exe	Client	Windows	amd64	GUI
App Store	Client	iOS	-	GUI
Brook.apk(No Google Play)	Client	Android	-	GUI

See wiki for more tutorials

Packages

ArchLinux

sudo pacman -S brook

Snap

sudo snap install brook

MacOS(GUI)

brew cask install brook

Brook

NAME:
   Brook - A Cross-Platform Proxy Software

USAGE:
   brook [global options] command [command options] [arguments...]

VERSION:
   20180707

AUTHOR:
   Cloud <[email protected]>

COMMANDS:
     server         Run as server mode
     servers        Run as multiple servers mode
     client         Run as client mode
     tunnel         Run as tunnel mode
     tproxy         Run as tproxy mode, transparent proxy, only works on Linux
     streamserver   Run as server mode
     streamservers  Run as multiple servers mode
     streamclient   Run as client mode
     ssserver       Run as shadowsocks server mode, fixed method is aes-256-cfb
     ssservers      Run as shadowsocks multiple servers mode, fixed method is aes-256-cfb
     ssclient       Run as shadowsocks client mode, fixed method is aes-256-cfb
     socks5         Run as raw socks5 server
     relay          Run as relay mode
     relays         Run as multiple relays mode
     qr             Print brook server QR code
     socks5tohttp   Convert socks5 to http proxy
     systemproxy    Set system proxy with pac url, or remove, only works on MacOS/Windows
     help, h        Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug, -d               Enable debug
   --listen value, -l value  Listen address for debug (default: ":6060")
   --help, -h                show help
   --version, -v             print the version

Server

# Run as a brook server
$ brook server -l :9999 -p password

# Run as multiple brook servers
$ brook servers -l ":9999 password" -l ":8888 password"

If you run a public/shared server, do not forget this parameter --tcpDeadline

Client (CLI)

# Run as brook client, start a socks5 proxy socks5://127.0.0.1:1080
$ brook client -l 127.0.0.1:1080 -i 127.0.0.1 -s server_address:port -p password

# Run as brook client, start a http(s) proxy http(s)://127.0.0.1:8080
$ brook client -l 127.0.0.1:8080 -i 127.0.0.1 -s server_address:port -p password --http

Client (GUI)

See wiki

Tunnel

# Run as tunnel 127.0.0.1:5 to 1.2.3.4:5
$ brook tunnel -l 127.0.0.1:5 -t 1.2.3.4:5 -s server_address:port -p password

Tproxy

See wiki

Relay

# Run as relay to 1.2.3.4:5
$ brook relay -l :5 -r 1.2.3.4:5

Socks5

# Run as a raw socks5 server 1.2.3.4:1080
$ brook socks5 -l :1080 -i 1.2.3.4

Socks5 to HTTP

# Convert socks5://127.0.0.1:1080 to http(s)://127.0.0.1:8080 proxy
$ brook socks5tohttp -l 127.0.0.1:8080 -s 127.0.0.1:1080

Shadowsocks

# Run as a shadowsocks server
$ brook ssserver -l :9999 -p password

# Run as multiple shadowsocks servers
$ brook ssservers -l ":9999 password" -l ":8888 password"

If you run a public/shared server, do not forget this parameter --tcpDeadline

# Run as shadowsocks client, start a socks5 proxy socks5://127.0.0.1:1080
$ brook ssclient -l 127.0.0.1:1080 -i 127.0.0.1 -s server_address:port -p password

# Run as shadowsocks client, start a http(s) proxy http(s)://127.0.0.1:8080
$ brook ssclient -l 127.0.0.1:8080 -i 127.0.0.1 -s server_address:port -p password --http

Fixed method is aes-256-cfb

See wiki for more tutorials

Contributing

Please read CONTRIBUTING.md first

License

Licensed under The GPLv3 License