Brook
MUST READ | https://txthinking.github.io/brook/#/README |
Install CLI | https://txthinking.github.io/brook/#/install-cli |
Install GUI (macOS, Windows, iOS, Android, OpenWrt) | https://txthinking.github.io/brook/#/install-gui-client |
OpenWrt CLI | https://txthinking.github.io/brook/#/brook-tproxy |
Blog | https://talks.txthinking.com |
Youtube | https://www.youtube.com/txthinking |
Discussions | https://github.com/txthinking/brook/discussions |
Telegram Channel | https://t.me/brookchannel |
What is Brook
Brook is a cross-platform strong encryption and not detectable proxy.
Brook's goal is to keep it simple, stupid and not detectable.
Install CLI
curl -L https://github.com/txthinking/brook/releases/latest/download/brook_linux_amd64 -o /usr/bin/brook
chmod +x /usr/bin/brook
nami, run brook wsserver
with joker
[Recommend] Install CLI via
😘 Just copy and paste these four lines of commands, you can call this💛 one-click script💛
source <(curl -L https://git.io/getnami)
nami install github.com/txthinking/joker
nami install github.com/txthinking/brook
joker brook wsserver --listen :9999 --password hello
Then, your
brook wsserver
isws://YOUR_SERVER_IP:9999
, password ishello
Install GUI
Usage
NAME:
Brook - A cross-platform strong encryption and not detectable proxy
USAGE:
brook [global options] command [command options] [arguments...]
VERSION:
20210701
AUTHOR:
Cloud <cloud@txthinking.com>
COMMANDS:
server Run as brook server, both TCP and UDP
client Run as brook client, both TCP and UDP, to start a socks5 proxy, [src <-> socks5 <-> brook client <-> brook server <-> dst]
wsserver Run as brook wsserver, both TCP and UDP, it will start a standard http server and websocket server
wsclient Run as brook wsclient, both TCP and UDP, to start a socks5 proxy, [src <-> socks5 <-> brook wsclient <-> brook wsserver <-> dst]
wssserver Run as brook wssserver, both TCP and UDP, it will start a standard https server and websocket server
wssclient Run as brook wssclient, both TCP and UDP, to start a socks5 proxy, [src <-> socks5 <-> brook wssclient <-> brook wssserver <-> dst]
relayoverbrook Run as relay over brook, both TCP and UDP, this means access [from address] is equal to [to address], [src <-> from address <-> brook server/wsserver/wssserver <-> to address]
dns Run as dns server over brook, both TCP and UDP, [src <-> brook dns <-> brook server/wsserver/wssserver <-> dns] or [src <-> brook dns <-> dnsForBypass]
tproxy Run as transparent proxy, both TCP and UDP, only works on Linux, [src <-> brook tproxy <-> brook server/wsserver/wssserver <-> dst]
link Print brook link
qr Print brook server QR code
connect Connect via standard sharing link (brook server & brook wsserver & brook wssserver)
relay Run as standalone relay, both TCP and UDP, this means access [from address] is equal to access [to address], [src <-> from address <-> to address]
socks5 Run as standalone standard socks5 server, both TCP and UDP
socks5tohttp Convert socks5 to http proxy, [src <-> listen address(http proxy) <-> socks5 address <-> dst]
hijackhttps Hijack domains and assume is TCP/TLS/443. Requesting these domains from anywhere in the system will be hijacked . [src <-> brook hijackhttps <-> socks5 server] or [src <-> direct]
pac Run as PAC server or save PAC to file
servers Run as multiple brook servers
relays Run as multiple standalone relays
map Run as mapping, both TCP and UDP, this means access [from address] is equal to [to address], [src <-> from address <-> brook <-> to address]
howto Print some useful tutorial resources
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--debug, -d Enable debug (default: false)
--listen value, -l value Listen address for debug (default: ":6060")
--help, -h show help (default: false)
--version, -v print the version (default: false)
COPYRIGHT:
https://github.com/txthinking/brook
Contributing
Please read CONTRIBUTING.md first
License
Licensed under The GPLv3 License