Skip to content

Commit

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

### Install CLI

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

> [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
Expand All @@ -32,7 +32,7 @@ Brook's goal is to keep it **simple**, **stupid** and **not detectable**.
bash <(curl https://bash.ooo/nami.sh)
```
2. install brook, [joker](https://github.com/txthinking/joker)
2. install brook, joker
> [joker](https://github.com/txthinking/joker) can turn process into daemon
Expand All @@ -50,7 +50,7 @@ Brook's goal is to keep it **simple**, **stupid** and **not detectable**.
To learn more please read the [documentation](https://txthinking.github.io/brook/#/install-cli)
### Install via [brook.sh](https://bash.ooo)
### Install via brook.sh
```
bash <(curl https://bash.ooo/brook.sh)
Expand Down
4 changes: 2 additions & 2 deletions README_ZH.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Brook 是一个跨平台的强加密无特征的代理软件. 偏爱 KISS 哲学

### 安装 CLI

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

> [nami](https://github.com/txthinking/nami) 会自动下载对应你系统的命令<br/>
> 如果你的系统不是 Linux, MacOS, Windows, 你可以直接在 [release](https://github.com/txthinking/brook/releases) 页面下载
Expand All @@ -31,7 +31,7 @@ Brook 是一个跨平台的强加密无特征的代理软件. 偏爱 KISS 哲学
bash <(curl https://bash.ooo/nami.sh)
```
2. 安装 brook, [joker](https://github.com/txthinking/joker)
2. 安装 brook, joker
> [joker](https://github.com/txthinking/joker) 可以将进程变成守护进程.
Expand Down
70 changes: 35 additions & 35 deletions docs/brook-link.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
brook://KIND?QUERY
```

- **KIND**: `server`, `wsserver`, `wssserver`, `socks5`
- **QUERY**: key=value, key and value should be urlencoded(RFC3986), such as `key0=xxx&key1=xxx`
- **KIND**: `server`, `wsserver`, `wssserver`, `socks5`
- **QUERY**: key=value, key and value should be urlencoded(RFC3986), such as `key0=xxx&key1=xxx`

#### brook server

- **KIND**: `server`
- **QUERY**:
- `server`: brook server, such as `1.2.3.4:9999` [Required]
- `password`: password [Required]
- `name`: such as `my server` [Optional]
- Any other custom key
- **KIND**: `server`
- **QUERY**:
- `server`: brook server, such as `1.2.3.4:9999`
- `password`: password
- `name`: such as `my server` [Optional]
- Any other custom key

Example

Expand All @@ -24,13 +24,13 @@ brook://server?password=hello&server=1.2.3.4%3A9999

#### brook wsserver

- **KIND**: `wsserver`
- **QUERY**:
- `wsserver`: brook wsserver, such as `ws://1.2.3.4:9999`, `ws://1.2.3.4:9999/ws`
- `password`: password
- `name`: such as `my wsserver` [Optional]
- `address`: such as `1.2.3.4:9999` [Optional]
- Any other custom key
- **KIND**: `wsserver`
- **QUERY**:
- `wsserver`: brook wsserver, such as `ws://1.2.3.4:9999`, `ws://1.2.3.4:9999/ws`
- `password`: password
- `name`: such as `my wsserver` [Optional]
- `address`: such as `1.2.3.4:9999` [Optional]
- Any other custom key

Example

Expand All @@ -41,14 +41,14 @@ brook://wsserver?password=hello&wsserver=ws%3A%2F%2F1.2.3.4%3A9999%2Fws

#### brook wssserver

- **KIND**: `wssserver`
- **QUERY**:
- `wssserver`: brook wssserver, such as `wss://domain.com:443`, `wss://domain.com:443/ws`
- `password`: password
- `name`: such as `my wssserver` [Optional]
- `address`: such as `1.2.3.4:9999` [Optional]
- `insecure`: `true` [Optional]
- Any other custom key
- **KIND**: `wssserver`
- **QUERY**:
- `wssserver`: brook wssserver, such as `wss://domain.com:443`, `wss://domain.com:443/ws`
- `password`: password
- `name`: such as `my wssserver` [Optional]
- `address`: such as `1.2.3.4:9999` [Optional]
- `insecure`: `true` [Optional]
- Any other custom key

Example

Expand All @@ -59,13 +59,13 @@ brook://wssserver?password=hello&wssserver=wss%3A%2F%2Fdomain.com%3A443%2Fws

#### socks5 server

- **KIND**: `socks5`
- **QUERY**:
- `socks5`: socks5 server, such as `socks5://1.2.3.4:9999`
- `username`: username, such as `hello`, optional
- `password`: password, such as `world`, optional
- `name`: such as `my socks5 server` [Optional]
- Any other custom key
- **KIND**: `socks5`
- **QUERY**:
- `socks5`: socks5 server, such as `socks5://1.2.3.4:9999`
- `username`: username, such as `hello`, [Optional]
- `password`: password, such as `world`, [Optional]
- `name`: such as `my socks5 server` [Optional]
- Any other custom key

Example

Expand All @@ -77,9 +77,9 @@ brook://socks5?password=world&socks5=socks5%3A%2F%2F1.2.3.4%3A9999&username=hell
### brook link

```
brook link -s server_address:port -p password
brook link -s ws://wsserver_address:port -p password
brook link -s wss://wsserver_domain:port -p password
brook link -s socks5://server_address:port
brook link -s socks5://server_address:port -u username -p password
brook link --server server_address:port --password password
brook link --server ws://wsserver_address:port --password password
brook link --server wss://wsserver_domain:port --password password
brook link --server socks5://server_address:port
brook link --server socks5://server_address:port --username username --password password
```
4 changes: 2 additions & 2 deletions docs/brook-wssserver.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ brook link --server wss://domain.com:443 --password hello --name 'my brook wssse

- Assume the domain is `domain.com`, with port `443`, with password `hello`
- If there is a firewall, remember to open **TCP on port 443**
- The cert is `/root/cert.pem`, your cert key is `/root/certkey.pem`
- The cert is `/root/cert.pem`, your cert key is `/root/certkey.pem`. [How to issue a certificate yourself](https://github.com/txthinking/mad)
- Make sure your `domain.com` has been resolved to your server IP successfully

```
Expand Down Expand Up @@ -96,7 +96,7 @@ brook link --server wss://domain.com:443 --password hello --name 'my brook wssse
## Run brook wssserver with custom certificate with [not your own domain name]

- Assume the domain is `domain.com`, with port `443`, with password `hello`
- The cert is `/root/cert.pem`, your cert key is `/root/certkey.pem`
- The cert is `/root/cert.pem`, your cert key is `/root/certkey.pem`. [How to issue a certificate yourself](https://github.com/txthinking/mad)
- If there is a firewall, remember to open **TCP on port 443**

```
Expand Down
70 changes: 35 additions & 35 deletions docs/zh-cn/brook-link.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
brook://KIND?QUERY
```

- **KIND**: `server`, `wsserver`, `wssserver`, `socks5`
- **QUERY**: key=value, key and value should be urlencoded(RFC3986), such as `key0=xxx&key1=xxx`
- **KIND**: `server`, `wsserver`, `wssserver`, `socks5`
- **QUERY**: key=value, key and value should be urlencoded(RFC3986), such as `key0=xxx&key1=xxx`

#### brook server

- **KIND**: `server`
- **QUERY**:
- `server`: brook server, such as `1.2.3.4:9999` [Required]
- `password`: password [Required]
- `name`: such as `my server` [Optional]
- Any other custom key
- **KIND**: `server`
- **QUERY**:
- `server`: brook server, such as `1.2.3.4:9999`
- `password`: password
- `name`: such as `my server` [Optional]
- Any other custom key

Example

Expand All @@ -24,13 +24,13 @@ brook://server?password=hello&server=1.2.3.4%3A9999

#### brook wsserver

- **KIND**: `wsserver`
- **QUERY**:
- `wsserver`: brook wsserver, such as `ws://1.2.3.4:9999`, `ws://1.2.3.4:9999/ws`
- `password`: password
- `name`: such as `my wsserver` [Optional]
- `address`: such as `1.2.3.4:9999` [Optional]
- Any other custom key
- **KIND**: `wsserver`
- **QUERY**:
- `wsserver`: brook wsserver, such as `ws://1.2.3.4:9999`, `ws://1.2.3.4:9999/ws`
- `password`: password
- `name`: such as `my wsserver` [Optional]
- `address`: such as `1.2.3.4:9999` [Optional]
- Any other custom key

Example

Expand All @@ -41,14 +41,14 @@ brook://wsserver?password=hello&wsserver=ws%3A%2F%2F1.2.3.4%3A9999%2Fws

#### brook wssserver

- **KIND**: `wssserver`
- **QUERY**:
- `wssserver`: brook wssserver, such as `wss://domain.com:443`, `wss://domain.com:443/ws`
- `password`: password
- `name`: such as `my wssserver` [Optional]
- `address`: such as `1.2.3.4:9999` [Optional]
- `insecure`: `true` [Optional]
- Any other custom key
- **KIND**: `wssserver`
- **QUERY**:
- `wssserver`: brook wssserver, such as `wss://domain.com:443`, `wss://domain.com:443/ws`
- `password`: password
- `name`: such as `my wssserver` [Optional]
- `address`: such as `1.2.3.4:9999` [Optional]
- `insecure`: `true` [Optional]
- Any other custom key

Example

Expand All @@ -59,13 +59,13 @@ brook://wssserver?password=hello&wssserver=wss%3A%2F%2Fdomain.com%3A443%2Fws

#### socks5 server

- **KIND**: `socks5`
- **QUERY**:
- `socks5`: socks5 server, such as `socks5://1.2.3.4:9999`
- `username`: username, such as `hello`, optional
- `password`: password, such as `world`, optional
- `name`: such as `my socks5 server` [Optional]
- Any other custom key
- **KIND**: `socks5`
- **QUERY**:
- `socks5`: socks5 server, such as `socks5://1.2.3.4:9999`
- `username`: username, such as `hello` [Optional]
- `password`: password, such as `world` [Optional]
- `name`: such as `my socks5 server` [Optional]
- Any other custom key

Example

Expand All @@ -77,9 +77,9 @@ brook://socks5?password=world&socks5=socks5%3A%2F%2F1.2.3.4%3A9999&username=hell
### brook link

```
brook link -s server_address:port -p password
brook link -s ws://wsserver_address:port -p password
brook link -s wss://wsserver_domain:port -p password
brook link -s socks5://server_address:port
brook link -s socks5://server_address:port -u username -p password
brook link --server server_address:port --password password
brook link --server ws://wsserver_address:port --password password
brook link --server wss://wsserver_domain:port --password password
brook link --server socks5://server_address:port
brook link --server socks5://server_address:port --username username --password password
```
4 changes: 2 additions & 2 deletions docs/zh-cn/brook-wssserver.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ brook link --server wss://domain.com:443 --password hello --name 'my brook wssse

- 假设你的域名是 `domain.com`, 选择端口 `443`, 密码 `hello`
- 防火墙记得开放 **TCP 443**
- The cert is `/root/cert.pem`, your cert key is `/root/certkey.pem`
- The cert is `/root/cert.pem`, your cert key is `/root/certkey.pem`. [如何自己签发证书](https://github.com/txthinking/mad/blob/master/readme_zh.md)
- 确保你的域名 `domain.com` 已成功解析到你服务器的 IP

```
Expand Down Expand Up @@ -97,7 +97,7 @@ brook link --server wss://domain.com:443 --password hello --name 'my brook wssse

- 假设你的域名是 `domain.com`, 选择端口 `443`, 密码 `hello`
- 防火墙记得开放 **TCP 443**
- The cert is `/root/cert.pem`, your cert key is `/root/certkey.pem`
- The cert is `/root/cert.pem`, your cert key is `/root/certkey.pem`. [如何自己签发证书](https://github.com/txthinking/mad/blob/master/readme_zh.md)

```
brook wssserver --domainaddress domain.com:443 --password hello --cert /root/cert.pem --certkey /root/certkey.pem
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-cn/install-gui-client.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ GUI(图形用户界面), Brook 图形客户端.

## Windows

**运行之前请先删除同目录目录下的 wintun 所有文件!!!**
**新版首次运行之前请先删除同目录目录下的 wintun 所有文件!!!**

(Brook.exe 需要你已经安装了最新版(基于 chromium 的那款)的 Edge 浏览器)

Expand Down

0 comments on commit c7d7398

Please sign in to comment.