Skip to content

Commit

Permalink
v20200701
Browse files Browse the repository at this point in the history
  • Loading branch information
txthinking committed Jul 11, 2020
1 parent ba3546c commit b583da1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 34 deletions.
42 changes: 10 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,10 @@

---

**v20200502**
**v20200701**

* CLI: Add `$ brook dns`
* CLI: Add `$ brook pac`
* CLI: Rename `$ brook vpn` to `$ brook tun`, still experimental
* GUI: Support multiple servers

Some useful tutorial resources

* Slides: https://talks.txthinking.com
* Youtube: https://www.youtube.com/channel/UC5j8-I5Y4lWo4KTa4_0Kx5A
* Telegram Group: https://t.me/brookgroup
* Telegram Channel: https://t.me/brookchannel
* CLI: Add `$ brook hijackhttps`
* GUI: Add tun

---

Expand All @@ -48,7 +39,6 @@ Some useful tutorial resources
- [Socks5 Server](#socks5-server)
- [Socks5 to HTTP](#socks5-to-http)
- [PAC](#pac)
- [System Proxy](#system-proxy)
- [Shadowsocks](#shadowsocks)
- [How to](#how-to)
- [Contributing](#contributing)
Expand Down Expand Up @@ -81,21 +71,21 @@ install GUI on macOS
brew cask install brook
```

**or download GUI: [macOS](https://github.com/txthinking/brook/releases/download/v20200502/Brook.pkg), [Windows](https://github.com/txthinking/brook/releases/download/v20200502/Brook.msi), [Android](https://github.com/txthinking/brook/releases/download/v20200502/Brook.apk), [iOS](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642)**
**or download GUI: [macOS](https://github.com/txthinking/brook/releases/download/v20200701/Brook.dmg), [Windows](https://github.com/txthinking/brook/releases/download/v20200701/Brook.exe), [Android](https://github.com/txthinking/brook/releases/download/v20200701/Brook.apk), [iOS](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642)**

> CLI contains server and client, GUI only contains client. iOS client only supports non-China AppStore.
## Brook

```
NAME:
Brook - A Cross-Platform Proxy/VPN Software
Brook - A cross-platform strong encryption and not detectable proxy
USAGE:
brook [global options] command [command options] [arguments...]
brook_darwin_amd64 [global options] command [command options] [arguments...]
VERSION:
20200502
20200701
AUTHOR:
Cloud <[email protected]>
Expand All @@ -107,7 +97,7 @@ COMMANDS:
tunnel Run as tunnel, both TCP and UDP, this means access [listen address] is equal to [to address], [src <-> listen address <-> $ brook server <-> to address], [works with $ brook server]
dns Run as DNS server, both TCP and UDP, [src <-> $ brook dns <-> $ brook server <-> default dns server] or [src <-> $ brook dns <-> list dns server], [works with $ brook server]
tproxy Run as transparent proxy, both TCP and UDP, only works on Linux, [src <-> $ brook tproxy <-> $ brook server <-> dst], [works with $ brook server]
tun Run as tun, both TCP and UDP, [src <-> $ brook tun <-> $ brook server <-> dst], [works with $ brook server]
tun tun
wsserver Run as brook wsserver, both TCP and UDP, it will start a standard http(s) server and websocket server
wsclient Run as brook wsclient, both TCP and UDP, to start a socks5 proxy or a http proxy, [src <-> $ brook wsclient <-> $ brook wsserver <-> dst], [works with $ brook wsserver]
link Print brook link
Expand All @@ -116,11 +106,11 @@ COMMANDS:
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 hijackhttps <-> socks5 server] or [src <-> direct]
pac Run as PAC server or save PAC to file
systemproxy Set system proxy with pac url, or remove, only works on macOS/Windows
ssserver Run as shadowsocks server, both TCP and UDP, fixed method is aes-256-cfb
ssservers Run as shadowsocks multiple servers, fixed method is aes-256-cfb
ssclient Run as shadowsocks client, both TCP and UDP, to start a socks5 proxy or a http proxy, fixed method is aes-256-cfb, [src <-> $ brook ssclient <-> $ brook ssserver <-> dst], [works with $ brook ssserver]
ssclient Run as shadowsocks client, both TCP and UDP, to start socks5 or http proxy, method is aes-256-cfb, [src <-> $ brook ssclient <-> $ brook ssserver <-> dst], [works with $ brook ssserver]
howto Print some useful tutorial resources
help, h Shows a list of commands or help for one command
Expand Down Expand Up @@ -274,18 +264,6 @@ $ brook pac -f /path/to/file.pac

> More parameters: $ brook pac -h
### System Proxy

```
# Set system PAC proxy
$ brook systemproxy -u pac_url
# Clear system PAC proxy
$ brook systemproxy -r
```

> More parameters: $ brook systemproxy -h
### Shadowsocks

```
Expand Down
3 changes: 1 addition & 2 deletions cli/brook/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ var debugAddress string
func main() {
app := cli.NewApp()
app.Name = "Brook"
app.Version = "20200502"
app.Version = "20200701"
app.Usage = "A cross-platform strong encryption and not detectable proxy"
app.Authors = []*cli.Author{
{
Expand Down Expand Up @@ -1215,7 +1215,6 @@ func main() {
fmt.Println("")
fmt.Println("Nami:", "https://github.com/txthinking/nami")
fmt.Println("Joker:", "https://github.com/txthinking/joker")
fmt.Println("Ipio:", "https://github.com/txthinking/ipio")
fmt.Println("")
return nil
},
Expand Down

0 comments on commit b583da1

Please sign in to comment.