From 74b7428f99a2859bf0215671afd1d0591f20c37d Mon Sep 17 00:00:00 2001 From: txthinking Date: Sun, 21 Feb 2021 00:44:09 +0800 Subject: [PATCH] 20210214 --- README.md | 30 ++++++++++++------------------ README_ZH.md | 30 ++++++++++++------------------ docs/README.md | 4 ++-- docs/_sidebar.md | 11 +++++++++-- docs/brook-link.md | 5 +++-- docs/brook-wsclient.md | 2 +- docs/brook-wssclient-gui.md | 20 ++++++++++++++++++++ docs/brook-wssclient.md | 22 ++++++++++++++++++++++ docs/brook-wsserver.md | 10 ---------- docs/brook-wssserver.md | 16 ++++++++++++++++ docs/install-gui-client.md | 6 +++--- docs/zh-cn/README.md | 6 ++++-- docs/zh-cn/_sidebar.md | 10 ++++++++-- docs/zh-cn/brook-link.md | 5 +++-- docs/zh-cn/brook-tproxy.md | 2 +- docs/zh-cn/brook-wsclient-gui.md | 2 +- docs/zh-cn/brook-wsclient.md | 2 +- docs/zh-cn/brook-wssclient-gui.md | 17 +++++++++++++++++ docs/zh-cn/brook-wssclient.md | 21 +++++++++++++++++++++ docs/zh-cn/brook-wsserver.md | 10 ---------- docs/zh-cn/brook-wssserver.md | 16 ++++++++++++++++ docs/zh-cn/install-gui-client.md | 14 ++++---------- ping/ping.json | 4 ++-- 23 files changed, 178 insertions(+), 87 deletions(-) create mode 100644 docs/brook-wssclient-gui.md create mode 100644 docs/brook-wssclient.md create mode 100644 docs/brook-wssserver.md create mode 100644 docs/zh-cn/brook-wssclient-gui.md create mode 100644 docs/zh-cn/brook-wssclient.md create mode 100644 docs/zh-cn/brook-wssserver.md diff --git a/README.md b/README.md index 953b2e119..7c458360f 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,10 @@ [![Build Status](https://travis-ci.org/txthinking/brook.svg?branch=master)](https://travis-ci.org/txthinking/brook) [![Docs](https://img.shields.io/badge/Tutorial-docs-yellow.svg)](https://txthinking.github.io/brook/) -[![Slides](https://img.shields.io/badge/Tutorial-Slides-blueviolet.svg)](https://talks.txthinking.com) +[![Blog](https://img.shields.io/badge/Tutorial-Slides-blueviolet.svg)](https://talks.txthinking.com) [![Youtube](https://img.shields.io/badge/Tutorial-Youtube-red.svg)](https://www.youtube.com/channel/UC5j8-I5Y4lWo4KTa4_0Kx5A) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](http://www.gnu.org/licenses/gpl-3.0) [![Donate](https://img.shields.io/badge/Support-Donate-ff69b4.svg)](https://www.txthinking.com/opensource-support.html) -[![Slack](https://img.shields.io/badge/Join-Slack-ff69b4.svg)](https://docs.google.com/forms/d/e/1FAIpQLSdzMwPtDue3QoezXSKfhW88BXp57wkbDXnLaqokJqLeSWP9vQ/viewform)

Brook @@ -16,16 +15,9 @@ --- -**v20200901** +**v20210214** -- **❗️Breaking change, you should upgrade both server and client** -- New [Docs](https://txthinking.github.io/brook/) - - -**v20210101** - -- Support iOS 13 -- Import server list from URL. [ref here](https://txthinking.github.io/brook/#/brook-link) and [here](https://gist.githubusercontent.com/txthinking/7ecdb282982e14cc95714141c0ce2581/raw/350363229d1ce123b87b7cb0789e459969620cb3/brooklink.list) +- more and more... --- @@ -41,9 +33,9 @@ Brook's goal is to keep it **simple**, **stupid** and **not detectable**. Download from [releases](https://github.com/txthinking/brook/releases) ``` -# For example, on linux amd64, v20210101 +# For example, on linux amd64, v20210214 -curl -L https://github.com/txthinking/brook/releases/download/v20210101/brook_linux_amd64 -o /usr/bin/brook +curl -L https://github.com/txthinking/brook/releases/download/v20210214/brook_linux_amd64 -o /usr/bin/brook chmod +x /usr/bin/brook ``` @@ -57,7 +49,7 @@ nami install github.com/txthinking/brook > The GUI file has only client function -Download from [releases](https://github.com/txthinking/brook/releases): [macOS](https://github.com/txthinking/brook/releases/download/v20210101/Brook.dmg), [Windows](https://github.com/txthinking/brook/releases/download/v20210101/Brook.exe), [Android](https://github.com/txthinking/brook/releases/download/v20210101/Brook.apk), [iOS](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642) +Download from [releases](https://github.com/txthinking/brook/releases): [macOS](https://github.com/txthinking/brook/releases/download/v20210214/Brook.dmg), [Windows](https://github.com/txthinking/brook/releases/download/v20210214/Brook.msi), [Android](https://github.com/txthinking/brook/releases/download/v20210214/Brook.apk), [iOS](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642) Install via brew @@ -77,7 +69,7 @@ USAGE: brook [global options] command [command options] [arguments...] VERSION: - 20210101 + 20210214 AUTHOR: Cloud @@ -85,12 +77,14 @@ AUTHOR: 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 or a http proxy, [src <-> socks5 <-> $ brook client <-> $ brook server <-> dst], [works with $ brook server] + 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 server <-> to address], [works with $ brook server] dns Run as DNS server, both TCP and UDP, [src <-> $ brook dns <-> $ brook server <-> dns server] or [src <-> $ brook dns <-> dns server for bypass], [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] - 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 <-> socks5 <-> $ brook wsclient <-> $ brook wsserver <-> dst], [works with $ brook wsserver] + 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], [works with $ brook wssserver] link Print brook link qr Print brook server QR code relay Run as standalone relay, both TCP and UDP, this means access [listen address] is equal to access [to address], [src <-> listen address <-> to address] diff --git a/README_ZH.md b/README_ZH.md index edece5da1..204a16b5b 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -4,11 +4,10 @@ [![Build Status](https://travis-ci.org/txthinking/brook.svg?branch=master)](https://travis-ci.org/txthinking/brook) [![文档](https://img.shields.io/badge/%E6%95%99%E7%A8%8B-%E6%96%87%E6%A1%A3-yellow.svg)](https://txthinking.github.io/brook/#/zh-cn/) -[![幻灯片](https://img.shields.io/badge/%E6%95%99%E7%A8%8B-%E5%B9%BB%E7%81%AF%E7%89%87-blueviolet.svg)](https://talks.txthinking.com) +[![博客](https://img.shields.io/badge/%E6%95%99%E7%A8%8B-%E5%B9%BB%E7%81%AF%E7%89%87-blueviolet.svg)](https://talks.txthinking.com) [![视频](https://img.shields.io/badge/%E6%95%99%E7%A8%8B-%E8%A7%86%E9%A2%91-red.svg)](https://www.youtube.com/channel/UC5j8-I5Y4lWo4KTa4_0Kx5A) [![开源协议: GPL v3](https://img.shields.io/badge/%E5%BC%80%E6%BA%90%E5%8D%8F%E8%AE%AE-GPL%20v3-yellow.svg)](http://www.gnu.org/licenses/gpl-3.0) [![捐赠](https://img.shields.io/badge/%E6%94%AF%E6%8C%81-%E6%8D%90%E8%B5%A0-ff69b4.svg)](https://www.txthinking.com/opensource-support.html) -[![交流群](https://img.shields.io/badge/%E7%94%B3%E8%AF%B7%E5%8A%A0%E5%85%A5-%E4%BA%A4%E6%B5%81%E7%BE%A4-ff69b4.svg)](https://docs.google.com/forms/d/e/1FAIpQLSdzMwPtDue3QoezXSKfhW88BXp57wkbDXnLaqokJqLeSWP9vQ/viewform)

Brook @@ -16,16 +15,9 @@ --- -**v20200901** +**v20210214** -- **此版本不兼容之前的版本, 建议一起升级服务端和客户端** -- [新的文档站点](https://txthinking.github.io/brook/#/zh-cn/) - - -**v20210101** - -- 支持从HTTP URL导入服务器列表. [参考这里](https://txthinking.github.io/brook/#/brook-link) 和 [这里](https://gist.githubusercontent.com/txthinking/7ecdb282982e14cc95714141c0ce2581/raw/350363229d1ce123b87b7cb0789e459969620cb3/brooklink.list) -- 恢复支持iOS 13 +- more and more... --- @@ -40,9 +32,9 @@ Brook 是一个跨平台的强加密无特征的代理软件. 偏爱 KISS 哲学 从 [releases](https://github.com/txthinking/brook/releases) 页面下载 ``` -# 举例, linux amd64, v20210101 +# 举例, linux amd64, v20210214 -curl -L https://github.com/txthinking/brook/releases/download/v20210101/brook_linux_amd64 -o /usr/bin/brook +curl -L https://github.com/txthinking/brook/releases/download/v20210214/brook_linux_amd64 -o /usr/bin/brook chmod +x /usr/bin/brook ``` @@ -54,7 +46,7 @@ nami install github.com/txthinking/brook ### 安装 GUI (图形客户端) -从 [releases](https://github.com/txthinking/brook/releases) 页面下载: [macOS](https://github.com/txthinking/brook/releases/download/v20210101/Brook.dmg), [Windows](https://github.com/txthinking/brook/releases/download/v20210101/Brook.exe), [Android](https://github.com/txthinking/brook/releases/download/v20210101/Brook.apk), [iOS](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642) +从 [releases](https://github.com/txthinking/brook/releases) 页面下载: [macOS](https://github.com/txthinking/brook/releases/download/v20210214/Brook.dmg), [Windows](https://github.com/txthinking/brook/releases/download/v20210214/Brook.msi), [Android](https://github.com/txthinking/brook/releases/download/v20210214/Brook.apk), [iOS](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642) 通过 brew 安装 @@ -74,7 +66,7 @@ USAGE: brook [global options] command [command options] [arguments...] VERSION: - 20210101 + 20210214 AUTHOR: Cloud @@ -82,12 +74,14 @@ AUTHOR: 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 or a http proxy, [src <-> socks5 <-> $ brook client <-> $ brook server <-> dst], [works with $ brook server] + 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 server <-> to address], [works with $ brook server] dns Run as DNS server, both TCP and UDP, [src <-> $ brook dns <-> $ brook server <-> dns server] or [src <-> $ brook dns <-> dns server for bypass], [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] - 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 <-> socks5 <-> $ brook wsclient <-> $ brook wsserver <-> dst], [works with $ brook wsserver] + 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], [works with $ brook wssserver] link Print brook link qr Print brook server QR code relay Run as standalone relay, both TCP and UDP, this means access [listen address] is equal to access [to address], [src <-> listen address <-> to address] diff --git a/docs/README.md b/docs/README.md index b88cf054a..620de7e42 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,10 +6,10 @@ You may need to run the below commands as **root user or sudo**, if you are not ## Install via curl -Let's take the v20200909 version downloaded on linux amd64 as an example +Let's take the v20210214 version downloaded on linux amd64 as an example ``` -$ curl -L https://github.com/txthinking/brook/releases/download/v20200909/brook_linux_amd64 -o /usr/bin/brook +$ curl -L https://github.com/txthinking/brook/releases/download/v20210214/brook_linux_amd64 -o /usr/bin/brook $ chmod +x /usr/bin/brook ``` diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 9da57ee82..6b98d0eb8 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -16,6 +16,13 @@ * [$ brook wsclient](brook-wsclient.md) * [GUI WSClient](brook-wsclient-gui.md) +* WSSServer and WSSClient + + * [$ brook wssserver](brook-wssserver.md) + * [$ brook wssclient](brook-wssclient.md) + * [GUI WSClient](brook-wssclient-gui.md) + + * Server and Map * [$ brook map](brook-map.md) @@ -44,9 +51,9 @@ * [$ brook hijackhttps](brook-hijackhttps.md) -* Brook Link +* Brook Link & QR - * [Brook Link](brook-link.md) + * [$ brook link](brook-link.md) * PAC diff --git a/docs/brook-link.md b/docs/brook-link.md index dd6f4c894..cf38645d0 100644 --- a/docs/brook-link.md +++ b/docs/brook-link.md @@ -1,6 +1,6 @@ ### Brook Link -#### brook server & brook wsserver +#### brook server & brook wsserver & brook wssserver ``` brook://urlencode(SERVER PASSWORD) @@ -11,7 +11,8 @@ brook://urlencode(SERVER PASSWORD) SERVER format: * brook server: `server_ip:port` -* brook wsserver: `ws://wsserver_ip:port`, `wss://wsserver_domain:port` +* brook wsserver: `ws://wsserver_ip:port` +* brook wssserver: `wss://wsserver_domain:port` #### socks5 server diff --git a/docs/brook-wsclient.md b/docs/brook-wsclient.md index 4afeb05e9..e74d4d49a 100644 --- a/docs/brook-wsclient.md +++ b/docs/brook-wsclient.md @@ -14,7 +14,7 @@ $ brook wsclient -s ws://1.2.3.4:9999 -p hello --socks5 127.0.0.1:1080 > More parameters: $ brook wsclient -h -## Use the socks5 proxy created by brook client +## Use the socks5 proxy > TODO: Please help improve the documentation here diff --git a/docs/brook-wssclient-gui.md b/docs/brook-wssclient-gui.md new file mode 100644 index 000000000..5fa329379 --- /dev/null +++ b/docs/brook-wssclient-gui.md @@ -0,0 +1,20 @@ +Assume your brook wssserver is `wss://domain.com:443` and password is `hello` + + +## On Brook GUI Client + +1. Select `wssserver` +2. Type `wss://domain.com:443` on server field +3. Type `hello` on password field +4. Tap `Connect` button + +## Tips + +* On desktop, Please prefer to use Chrome browser +* You may need to restart your browser or application + +## TODO + +> TODO: Please help improve the documentation here + +* Different modes and configurations in GUI Client diff --git a/docs/brook-wssclient.md b/docs/brook-wssclient.md new file mode 100644 index 000000000..c67c20553 --- /dev/null +++ b/docs/brook-wssclient.md @@ -0,0 +1,22 @@ +## $ brook wssclient + +Assume your brook wssserver is `wss://domain.com:443` and password is `hello`, and you want to create a socks5 proxy `127.0.0.1:1080` on local. + +``` +send request <--> local socks5 <-- | brook wssserver protocol | --> brook wssserver <--> a remote address +``` + +## Run brook wssclient + +``` +$ brook wssclient -s wss://domain.com:443 -p hello --socks5 127.0.0.1:1080 +``` + +> More parameters: $ brook wssclient -h + +## Use the socks5 proxy + +> TODO: Please help improve the documentation here + +* Configure it on your system network settings +* Configure it on your browser diff --git a/docs/brook-wsserver.md b/docs/brook-wsserver.md index f0c0c96c1..70ff70552 100644 --- a/docs/brook-wsserver.md +++ b/docs/brook-wsserver.md @@ -10,16 +10,6 @@ Assume your server public IP is `1.2.3.4`, then your brook wsserver is: `ws://1. > More parameters: $ brook wsserver -h -## Run brook wsserver with domain - -Make sure your domain name has been successfully resolved, 80 and 443 are open, brook will automatically issue certificate for you, assume your domain is `domain.com` - -``` -$ brook wsserver --domain domain.com -p hello -``` - -Then your brook wsserver is: `wss://domain.com:443` - ## Run in background or daemon * Reference [Background](brook-server.md) diff --git a/docs/brook-wssserver.md b/docs/brook-wssserver.md new file mode 100644 index 000000000..896e05e8e --- /dev/null +++ b/docs/brook-wssserver.md @@ -0,0 +1,16 @@ +## Run brook wssserver + +Make sure your domain name has been successfully resolved, 80 and 443 are open, brook will automatically issue certificate for you, assume your domain is `domain.com` + +``` +$ brook wssserver --domain domain.com -p hello +``` + +> More parameters: $ brook wssserver -h + +Then your brook wsserver is: `wss://domain.com:443` + +## Run in background or daemon + +* Reference [Background](brook-server.md) +* Reference [Daemon](joker.md) diff --git a/docs/install-gui-client.md b/docs/install-gui-client.md index c8995b36d..1537644bd 100644 --- a/docs/install-gui-client.md +++ b/docs/install-gui-client.md @@ -2,19 +2,19 @@ GUI(Graphical user interface), Brook GUI has only client function. ## macOS -[Brook for macOS](https://github.com/txthinking/brook/releases/download/v20200909/Brook.dmg) +[Brook for macOS](https://github.com/txthinking/brook/releases/download/v20210214/Brook.dmg) Please prefer to use the latest version of macOS ## Windows -[Brook for Windows](https://github.com/txthinking/brook/releases/download/v20200909/Brook.exe) +[Brook for Windows](https://github.com/txthinking/brook/releases/download/v20210214/Brook.exe) Please prefer to use the latest version of Windows ## Android -[Brook for Android](https://github.com/txthinking/brook/releases/download/v20200909/Brook.apk) +[Brook for Android](https://github.com/txthinking/brook/releases/download/v20210214/Brook.apk) Please prefer to use the latest version of Android and Native ROM or Google ROM diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index bbe51c620..ee061f6f2 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -4,12 +4,14 @@ CLI 是命令行界面, 与之对应的另一个概念是 GUI 图形用户界面 你可能需要用 **root** 用户或 **sudo** 来运行下面提到的命令, **如果你不是非常熟悉 Linux, 我们建议你使用 ubuntu 和 root 用户来进行操作.** +[如果你想了解命令行的本质, 点这里->](https://talks.txthinking.com/) + ## 用curl直接下载brook文件 -截止目前最新版是v20210101, 以linux 64位系统为例 +截止目前最新版是v20210214, 以linux 64位系统为例 ``` -$ curl -L https://github.com/txthinking/brook/releases/download/v20210101/brook_linux_amd64 -o /usr/bin/brook +$ curl -L https://github.com/txthinking/brook/releases/download/v20210214/brook_linux_amd64 -o /usr/bin/brook $ chmod +x /usr/bin/brook ``` diff --git a/docs/zh-cn/_sidebar.md b/docs/zh-cn/_sidebar.md index deeb2a52a..6535ad888 100644 --- a/docs/zh-cn/_sidebar.md +++ b/docs/zh-cn/_sidebar.md @@ -16,6 +16,12 @@ * [$ brook wsclient](brook-wsclient.md) * [图形客户端](brook-wsclient-gui.md) +* WSS服务端和WSS客户端 + + * [$ brook wssserver](brook-wssserver.md) + * [$ brook wssclient](brook-wssclient.md) + * [图形客户端](brook-wssclient-gui.md) + * 服务端和 Map * [$ brook map](brook-map.md) @@ -44,9 +50,9 @@ * [$ brook hijackhttps](brook-hijackhttps.md) -* Brook 链接 +* Brook 链接 & QR - * [Brook Link](brook-link.md) + * [$ brook link](brook-link.md) * PAC diff --git a/docs/zh-cn/brook-link.md b/docs/zh-cn/brook-link.md index 474987d09..a35469d71 100644 --- a/docs/zh-cn/brook-link.md +++ b/docs/zh-cn/brook-link.md @@ -1,6 +1,6 @@ ### Brook Link -#### brook server & brook wsserver +#### brook server & brook wsserver & brook wssserver ``` brook://urlencode(SERVER PASSWORD) @@ -11,7 +11,8 @@ brook://urlencode(SERVER PASSWORD) SERVER 格式可以是: * brook server: `server_ip:port` -* brook wsserver: `ws://wsserver_ip:port`, `wss://wsserver_domain:port` +* brook wsserver: `ws://wsserver_ip:port` +* brook wssserver: `wss://wsserver_domain:port` #### socks5 server diff --git a/docs/zh-cn/brook-tproxy.md b/docs/zh-cn/brook-tproxy.md index f97d6ba38..919fef4ad 100644 --- a/docs/zh-cn/brook-tproxy.md +++ b/docs/zh-cn/brook-tproxy.md @@ -6,7 +6,7 @@ $ brook tproxy 可以创建透明代理在你的Linux路由器, Linux需要有TP ## 运行 brook tproxy -> 以下仅供参考 +> 以下步骤在官方openwrt x86-64位固件, 使用的brook_linux_amd64文件测试通过 #### 1. Enable forward diff --git a/docs/zh-cn/brook-wsclient-gui.md b/docs/zh-cn/brook-wsclient-gui.md index b2f298f83..3c5df1afc 100644 --- a/docs/zh-cn/brook-wsclient-gui.md +++ b/docs/zh-cn/brook-wsclient-gui.md @@ -1,4 +1,4 @@ -假设你的brook server是 `ws://1.2.3.4:9999`, 密码是 `hello` +假设你的brook wsserver是 `ws://1.2.3.4:9999`, 密码是 `hello` ## 在Brook图形客户端 diff --git a/docs/zh-cn/brook-wsclient.md b/docs/zh-cn/brook-wsclient.md index 740839bd6..11035b1bf 100644 --- a/docs/zh-cn/brook-wsclient.md +++ b/docs/zh-cn/brook-wsclient.md @@ -1,6 +1,6 @@ ## $ brook wsclient -假设你的brook server是 `ws://1.2.3.4:9999`, 密码是 `hello`, 你要在本地创建一个socks5代理 `127.0.0.1:1080` +假设你的brook wsserver是 `ws://1.2.3.4:9999`, 密码是 `hello`, 你要在本地创建一个socks5代理 `127.0.0.1:1080` ``` 请求 <--> 本地socks5 <-- | brook wsserver 协议 | --> brook wsserver <--> 目标 diff --git a/docs/zh-cn/brook-wssclient-gui.md b/docs/zh-cn/brook-wssclient-gui.md new file mode 100644 index 000000000..75e076efe --- /dev/null +++ b/docs/zh-cn/brook-wssclient-gui.md @@ -0,0 +1,17 @@ +假设你的brook wssserver是 `wss://domain.com:443`, 密码是 `hello` + +## 在Brook图形客户端 + +1. 选择 `wssserver` +2. 输入server `wss://domain.com:443` +3. 输入密码 `hello` +4. 点击 `Connect` 按钮 + +## 提示 + +* 建议使用Chrome浏览器 +* 你可能需要重启浏览器 + +## TODO + +> TODO: 请帮助完善此文档 diff --git a/docs/zh-cn/brook-wssclient.md b/docs/zh-cn/brook-wssclient.md new file mode 100644 index 000000000..3347e6920 --- /dev/null +++ b/docs/zh-cn/brook-wssclient.md @@ -0,0 +1,21 @@ +## $ brook wssclient + +假设你的brook wssserver是 `wss://domain.com:443`, 密码是 `hello`, 你要在本地创建一个socks5代理 `127.0.0.1:1080` + +``` +请求 <--> 本地socks5 <-- | brook wssserver 协议 | --> brook wssserver <--> 目标 +``` + +## 运行 brook wssclient + +``` +$ brook wssclient -s wss://domain.com:443 -p hello --socks5 127.0.0.1:1080 +``` + +> 更多参数: $ brook wssclient -h + +## 使用刚才创建的socks5代理 + +> TODO: 请帮助完善此文档 + +* 手动配置系统代理 diff --git a/docs/zh-cn/brook-wsserver.md b/docs/zh-cn/brook-wsserver.md index ca7a381cb..be987b769 100644 --- a/docs/zh-cn/brook-wsserver.md +++ b/docs/zh-cn/brook-wsserver.md @@ -10,16 +10,6 @@ $ brook wsserver -l :9999 -p hello > 更多参数介绍: $ brook wsserver -h -## 运行 brook wsserver 和域名 - -确保你的域名已经解析到你的服务器IP, 并且防火墙已开放80和443端口. brook 会自动签发域名证书. 假设你的域名是 `domain.com` - -``` -$ brook wsserver --domain domain.com -p hello -``` - -那么你的 brook wsserver是: `wss://domain.com:443` - ## 后台运行和守护进程 * 参考 [后台运行](brook-server.md) diff --git a/docs/zh-cn/brook-wssserver.md b/docs/zh-cn/brook-wssserver.md new file mode 100644 index 000000000..92b5599c4 --- /dev/null +++ b/docs/zh-cn/brook-wssserver.md @@ -0,0 +1,16 @@ +## 运行 brook wssserver + +确保你的域名已经解析到你的服务器IP, 并且防火墙已开放80和443端口. brook 会自动签发域名证书. 假设你的域名是 `domain.com` + +``` +$ brook wssserver --domain domain.com -p hello +``` + +> 更多参数介绍: $ brook wssserver -h + +那么你的 brook wssserver是: `wss://domain.com:443` + +## 后台运行和守护进程 + +* 参考 [后台运行](brook-server.md) +* 参考 [守护进程](joker.md) diff --git a/docs/zh-cn/install-gui-client.md b/docs/zh-cn/install-gui-client.md index 0caa48a84..c1eb5678f 100644 --- a/docs/zh-cn/install-gui-client.md +++ b/docs/zh-cn/install-gui-client.md @@ -2,27 +2,21 @@ GUI(图形用户界面), Brook 图形客户端. ## macOS -[Brook macOS 图形客户端](https://github.com/txthinking/brook/releases/download/v20200909/Brook.dmg) - -最好保持你的系统为最新版 +[Brook macOS 图形客户端](https://github.com/txthinking/brook/releases/download/v20210214/Brook.dmg) ## Windows -[Brook Windows 图形客户端](https://github.com/txthinking/brook/releases/download/v20200909/Brook.exe) - -最好保持你的系统为最新版 +[Brook Windows 图形客户端](https://github.com/txthinking/brook/releases/download/v20210214/Brook.msi) ## Android -[Brook Android 图形客户端](https://github.com/txthinking/brook/releases/download/v20200909/Brook.apk) - -最好保持你的系统为最新版 +[Brook Android 图形客户端](https://github.com/txthinking/brook/releases/download/v20210214/Brook.apk) ## iOS [Brook iOS 图形客户端](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642) -最好保持你的系统为最新版. 因为不可抗因素, 请使用非中国大陆Apple ID下载. +请使用非中国大陆Apple ID下载. --- diff --git a/ping/ping.json b/ping/ping.json index b151a31de..c35d9e8a1 100644 --- a/ping/ping.json +++ b/ping/ping.json @@ -1,5 +1,5 @@ { - "version": "v20210101", - "text": "Only support the English input method that comes with the system", + "version": "20210214", + "text": "", "link": "" }