Skip to content

Commit

Permalink
v20220401
Browse files Browse the repository at this point in the history
  • Loading branch information
txthinking committed Feb 21, 2022
1 parent d060ac8 commit b592155
Show file tree
Hide file tree
Showing 61 changed files with 1,119 additions and 1,176 deletions.
38 changes: 15 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,28 +23,28 @@ Brook's goal is to keep it **simple**, **stupid** and **not detectable**.

### Install CLI

install [nami](https://github.com/txthinking/nami)
1. install [nami](https://github.com/txthinking/nami)

> nami will automatically download the command corresponding to your system<br/>
> If your system is not Linux, MacOS, Windows, you can download it directly on the [release](https://github.com/txthinking/brook/releases) page
> [nami](https://github.com/txthinking/nami) will automatically download the command corresponding to your system<br/>
> If your system is not Linux, MacOS, Windows, you can download it directly on the [release](https://github.com/txthinking/brook/releases) page
```
bash <(curl https://bash.ooo/nami.sh)
```
```
bash <(curl https://bash.ooo/nami.sh)
```
install brook, [joker](https://github.com/txthinking/joker)
2. install brook, [joker](https://github.com/txthinking/joker)
> [joker](https://github.com/txthinking/joker) can turn process into daemon
> [joker](https://github.com/txthinking/joker) can turn process into daemon
```
nami install brook joker
```
```
nami install brook joker
```
run `brook server`
3. run `brook server`
```
joker brook server --listen :9999 --password hello
```
```
joker brook server --listen :9999 --password hello
```
> Then, your `brook server` is `YOUR_SERVER_IP:9999`, password is `hello`
Expand All @@ -69,9 +69,6 @@ NAME:
USAGE:
brook [global options] command [command options] [arguments...]

VERSION:
20210701
AUTHOR:
Cloud <cloud@txthinking.com>

Expand All @@ -86,7 +83,6 @@ COMMANDS:
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
Expand All @@ -111,10 +107,6 @@ COPYRIGHT:
[Read Document](https://txthinking.github.io/brook/)
## Contributing

Please read [CONTRIBUTING.md](https://github.com/txthinking/brook/blob/master/.github/CONTRIBUTING.md) first

## License
Licensed under The GPLv3 License
38 changes: 15 additions & 23 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,28 @@ Brook 是一个跨平台的强加密无特征的代理软件. 偏爱 KISS 哲学

### 安装 CLI

安装 [nami](https://github.com/txthinking/nami)
1. 安装 [nami](https://github.com/txthinking/nami)

> nami 会自动下载对应你系统的命令<br/>
> 如果你的系统不是 Linux, MacOS, Windows, 你可以直接在 [release](https://github.com/txthinking/brook/releases) 页面下载
> [nami](https://github.com/txthinking/nami) 会自动下载对应你系统的命令<br/>
> 如果你的系统不是 Linux, MacOS, Windows, 你可以直接在 [release](https://github.com/txthinking/brook/releases) 页面下载
```
bash <(curl https://bash.ooo/nami.sh)
```
```
bash <(curl https://bash.ooo/nami.sh)
```
安装 brook, [joker](https://github.com/txthinking/joker)
2. 安装 brook, [joker](https://github.com/txthinking/joker)
> [joker](https://github.com/txthinking/joker) 可以将进程变成守护进程.
> [joker](https://github.com/txthinking/joker) 可以将进程变成守护进程.
```
nami install brook joker
```
```
nami install brook joker
```
运行 `brook server`
3. 运行 `brook server`
```
joker brook server --listen :9999 --password hello
```
```
joker brook server --listen :9999 --password hello
```
> 然后, 你的 `brook server` 是 `YOUR_SERVER_IP:9999`, 密码是 `hello`
Expand All @@ -68,9 +68,6 @@ NAME:
USAGE:
brook [global options] command [command options] [arguments...]

VERSION:
20210701
AUTHOR:
Cloud <cloud@txthinking.com>

Expand All @@ -85,7 +82,6 @@ COMMANDS:
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
Expand All @@ -110,10 +106,6 @@ COPYRIGHT:
[文档](https://txthinking.github.io/brook/#/zh-cn/)
## 贡献

请先阅读 [CONTRIBUTING.md](https://github.com/txthinking/brook/blob/master/.github/CONTRIBUTING.md)

## 开源协议
基于 GPLv3 协议开源
1 change: 1 addition & 0 deletions cli/brook/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ if [ $# -ne 1 ]; then
exit
fi

rm -rf _
mkdir _

CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags="-w -s" -o _/brook_darwin_amd64 .
Expand Down
Loading

0 comments on commit b592155

Please sign in to comment.