Awesome Open Source
Awesome Open Source

Brook

中文

Build Status License: GPL v3 Donate

v20210701

  • [CLI] $ brook relayoverbrook
  • [CLI] $ brook servers removed, please use multiple $ brook server instead, joker will be useful, read the document
  • [CLI] $ brook relays removed, please use multiple $ brook relay instead, , joker will be useful, read the document
  • [GUI] macOS, optimize tun mode
  • [GUI] Windows, optimize compatibility, such as virtual machines
  • [GUI] If the server information is added through brook link, the details will not be displayed
🌚 🌝
MUST READ https://txthinking.github.io/brook/#/README
Install CLI https://txthinking.github.io/brook/#/install-cli
Install GUI https://txthinking.github.io/brook/#/install-gui
OpenWrt GUI https://txthinking.github.io/brook/#/brook-tproxy-gui
Document https://txthinking.github.io/brook/
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.

❤️ A project by txthinking.com

Install CLI

$ curl -L https://github.com/txthinking/brook/releases/latest/download/brook_linux_amd64 -o /usr/bin/brook
$ chmod +x /usr/bin/brook

Read Document

Install GUI

Read Document

Usage

NAME:
   Brook - A cross-platform strong encryption and not detectable proxy

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

VERSION:
   20210701

AUTHOR:
   Cloud <[email protected]>

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

Read Document

Contributing

Please read CONTRIBUTING.md first

License

Licensed under The GPLv3 License


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
go (15,340
android (6,459
ios (3,681
linux (2,566
macos (1,806
windows (1,507
cross-platform (707
proxy (562
encryption (338
vpn (264
shadowsocks (177
socks5 (83
socks (52
zero-configuration (41