Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Mar 30, 2021
May 28, 2021
May 28, 2021
ipk
May 28, 2021
Feb 11, 2020
May 28, 2021
Mar 19, 2021
May 28, 2021
May 28, 2021
NT
Aug 13, 2020
May 28, 2021
Mar 22, 2021
Aug 5, 2020
May 28, 2021
May 28, 2021
Aug 11, 2020
doc
May 23, 2021
NT
Aug 13, 2020
Aug 11, 2020
NT
Aug 13, 2020
Aug 5, 2020
NT
Aug 13, 2020
May 28, 2021
May 28, 2021
Aug 28, 2020
May 28, 2021
Aug 14, 2020

Brook

中文

Build Status Docs Blog Youtube License: GPL v3 Donate

Brook


v20210601

  • [CLI] $ brook map supports brook server/wsserver/wssserver
  • [CLI] $ brook dns supports brook server/wsserver/wssserver
  • [CLI] $ brook tproxy supports brook server/wsserver/wssserver
  • [GUI] OpenWrt supports brook server/wsserver/wssserver
  • Document
  • Community(ask here)

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.

Read Document

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

Read Document

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

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

VERSION:
   20210601

AUTHOR:
   Cloud <cloud@txthinking.com>

COMMANDS:
   server        Run as brook server, both TCP and UDP
   servers       Run as multiple brook servers
   client        Run as brook client, both TCP and UDP, to start a socks5 proxy, [src <-> socks5 <-> $ brook client <-> $ brook server <-> dst], [works with
$ brook server]
   map           Run as mapping, both TCP and UDP, this means access [from address] is equal to [to address], [src <-> from address <-> $ brook <-> to addres
s], works with $ brook server/wsserver/wssserver
   dns           Run as DNS server, both TCP and UDP, [src <-> $ brook dns <-> $ brook <-> dns server] or [src <-> $ brook dns <-> dns server for bypass], wo
rks with $ brook server/wsserver/wssserver
   tproxy        Run as transparent proxy, both TCP and UDP, only works on Linux, [src <-> $ brook tproxy <-> $ brook <-> dst], works with $ brook server/wss
erver/wssserver
   wsserver      Run as brook wsserver, both TCP and UDP, it will start a standard http server and websocket server
   wssserver     Run as brook wssserver, both TCP and UDP, it will start a standard https 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], [works
 with $ brook wsserver]
   wssclient     Run as brook wssclient, both TCP and UDP, to start a socks5 proxy, [src <-> socks5 <-> $ brook wssclient <-> $ brook wssserver <-> dst], [wo
rks with $ brook wssserver]
   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 [listen address] is equal to access [to address], [src <-> listen address <-> t
o address]
   relays        Run as multiple standalone relays
   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 hijackhtt
ps <-> socks5 server] or [src <-> direct]
   pac           Run as PAC server or save PAC to file
   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