Skip to content

taianjianbing/brook

 
 

Repository files navigation

Brook

Build Status Go Report Card License: GPL v3 Wiki

Brook

Table of Content

What is Brook

Brook is a cross-platform(Linux/MacOS/Windows/Android/iOS) proxy/vpn software.
Brook's goal is to reduce the configuration steps. Keep it simple, stupid.

Server

Download brook for Linux (amd64) [Version: 20170516] China Mirror | Other Platforms

NAME:
   Brook - A Cross-Platform Proxy Software

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

VERSION:
   20170516

AUTHOR:
   Cloud <cloud@txthinking.com>

COMMANDS:
     bkserver   Run as brook protocol server mode
     bkservers  Run as brook protocol multiple servers mode
     bkclient   Run as brook protocol client mode
     s5server   Run as socks5 encrypt protocol server mode
     s5servers  Run as socks5 encrypt protocol multiple servers mode
     s5client   Run as socks5 encrypt protocol client mode
     ssserver   Run as shadowsocks protocol server mode, fixed method is aes-256-cfb
     ssservers  Run as shadowsocks protocol multiple servers mode, fixed method is aes-256-cfb
     ssclient   Run as shadowsocks protocol client mode, fixed method is aes-256-cfb
     relay      Run as relay mode
     relays     Run as multi relays mode
     help, h    Shows a list of commands or help for one command

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

Brook Server

# Run as a brook server
$ brook bkserver -l :9999 -p password -t 10
# Run as a brook server with music
$ brook bkserver -l :9999 -p password -t 10 -m music_name
# Run as multiple brook servers
$ brook bkservers \
        -l ":9999 password" \
        -l ":8888 password" \
        -l ":7777 password music_name" \
        -l ":6666 password music_name" \
        -t 10

More about Brook Music

If you run a public/shared server, do not forget this parameter --deadline 60 or -d 60

Shadowsocks Server

# Run as a shadowsocks server
$ brook ssserver -l :9999 -p password -t 10
# Run as multiple shadowsocks servers
$ brook ssservers \
        -l ":9999 password" \
        -l ":8888 password" \
        -t 10

Fixed method is aes-256-cfb

If you run a public/shared server, do not forget this parameter --deadline 60 or -d 60

Client

Linux Client

Download (Same as the above server link, server and client are in one on linux)

Brook Client

# Run as brook client, start a socks5 proxy
$ brook bkclient -l 127.0.0.1:1080 -s server_address:port -p password
# Run as brook client, start a http(s) proxy
$ brook bkclient -l 127.0.0.1:8080 -s server_address:port -p password --http
# Run as brook client with music, music must be same as server's
$ brook bkclient -l 127.0.0.1:1080 -s server_address:port -p password -m muisc_name

Shadowsocks Client

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

MacOS Client

Download Brook.app.zip for MacOS (amd64) [Version: 20170516] China Mirror

  • Need MacOS version >= 10.12
  • If MacOS notice it is from an unidentified developer, then go System Preferences -> Security & Privacy, click Open Anyway
  • You may prefer to copy Brook.app to Application folder
  • This client use this pac white list auto proxy rule

Windows Client

Download Brook.exe for Windows (amd64) [Version: 20170516] China Mirror

  • Need Windows version >= 7
  • Please like to use Chrome browser
  • This client use this pac white list auto proxy rule

Android Client

iOS Client

Advanced Usage

Run as Daemon

With nohup

# Start
$ nohup brook bkserver -l :9999 -p password -t 10 &

# Stop
$ killall brook

With systemd

If your linux run with systemd, like Ubuntu 16.04, Archlinux, etc:

# Install
$ curl -L git.io/getbrook | sudo bash
$ sudo systemctl daemon-reload

# Config command options
$ sudo vim /etc/default/brook

# Start
$ sudo systemctl start brook.service

# Stop
$ sudo systemctl stop brook.service

# Start on bootup
$ sudo systemctl enable brook.service

Relay Server

What is Relay Server

client <---> relay server <---> server

Relay Server

# Run as a relay server
$ brook relay -l :9999 -s server_address:port -t 10
# Run as multiple relay servers
$ brook relays \
        -l ":9999 server1_address:port" \
        -l ":8888 server2_address:port" \
        -t 10

Developer

$ go get github.com/txthinking/brook/cli/brook
$ brook -h

Contributing

  • Please create PR on develop branch

License

Licensed under The GPLv3 License

About

Brook is a cross-platform(Linux/MacOS/Windows/Android/iOS) proxy software

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 85.5%
  • JavaScript 11.9%
  • HTML 2.3%
  • Shell 0.3%