docs

jakeslee · Apr 5, 2022 · 289d9d8 · 289d9d8
1 parent 81e41ad
commit 289d9d8
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -28,10 +28,11 @@ Brook is a cross-platform strong encryption and not detectable proxy. Keep it si
 > or<br/>
 > the script but only some parameters are supported: `bash <(curl https://bash.ooo/brook.sh)`<br/>
 > or<br/>
-> Archlinux: `pacman -S brook`<br/>
+> scripts written by others<br/>
 > or<br/>
-> brew: `brew install brook`<br/><br/>
-> recommend run command with root<br/>
+> Archlinux: `pacman -S brook` (may be outdated)<br/>
+> or<br/>
+> brew: `brew install brook` (may be outdated)<br/>
 
 Install nami
 
@@ -365,6 +366,14 @@ brook tproxy --link 'brook://...' --dnsListen :53
 1. You may need to manually configure the computer or mobile gateway and DNS.
 2. If you are running in a virtual machine and the host is using a wireless card, it may not work.
 
+### brook tproxy Transparent Proxy Gateway on macOS
+
+[https://talks.txthinking.com/articles/brook-gateway-on-macos-en.article](https://talks.txthinking.com/articles/brook-gateway-on-macos-en.article)
+
+### brook tproxy Transparent Proxy Gateway on Windows
+
+[https://talks.txthinking.com/articles/brook-gateway-on-windows-en.article](https://talks.txthinking.com/articles/brook-gateway-on-windows-en.article)
+
 ### GUI for official OpenWrt
 
 > **Dependencies: ca-certificates openssl-util ca-bundle coreutils-nohup iptables-mod-tproxy**

diff --git a/README_ZH.md b/README_ZH.md
@@ -28,10 +28,11 @@ Brook 是一个跨平台的强加密无特征的代理软件. Keep it simple, st
 > 或<br/>
 > 一键脚本，目前仅支持部分命令参数: `bash <(curl https://bash.ooo/brook.sh)`<br/>
 > 或<br/>
-> Archlinux: `pacman -S brook`<br/>
+> 使用网上其他同学写的脚本<br/>
 > 或<br/>
-> brew: `brew install brook`<br/><br/>
-> 建议使用 root 用户运行命令<br/>
+> Archlinux: `pacman -S brook` (可能不是最新版本)<br/>
+> 或<br/>
+> brew: `brew install brook` (可能不是最新版本)<br/>
 
 安装 nami
 
@@ -366,6 +367,14 @@ brook tproxy --link 'brook://...' --dnsListen :53
 1. 配置其他机器的网关和 DNS 为这台机器的 IP 即可
 2. 如果你运行在虚拟机里并且宿主机使用的是无线网卡, 可能不能工作。
 
+### brook tproxy 透明代理网关在 macOS
+
+[https://talks.txthinking.com/articles/brook-gateway-on-macos.article](https://talks.txthinking.com/articles/brook-gateway-on-macos.article)
+
+### brook tproxy 透明代理网关在 Windows
+
+[https://talks.txthinking.com/articles/brook-gateway-on-windows.article](https://talks.txthinking.com/articles/brook-gateway-on-windows.article)
+
 ### 官网原版 OpenWrt 图形客户端
 
 > **依赖: ca-certificates openssl-util ca-bundle coreutils-nohup iptables-mod-tproxy**

diff --git a/cli/brook/main.go b/cli/brook/main.go
@@ -1386,23 +1386,21 @@ func main() {
 					s = "socks5"
 				}
 				v := url.Values{}
-				v.Set("name", c.String("name"))
-				v.Set("address", c.String("address"))
-				yn := ""
+				if c.String("name") != "" {
+					v.Set("name", c.String("name"))
+				}
+				if c.String("address") != "" {
+					v.Set("address", c.String("address"))
+				}
 				if c.Bool("insecure") {
-					yn = "true"
+					v.Set("insecure", "true")
 				}
-				v.Set("insecure", yn)
-				yn = ""
 				if c.Bool("withoutBrookProtocol") {
-					yn = "true"
+					v.Set("withoutBrookProtocol", "true")
 				}
-				v.Set("withoutBrookProtocol", yn)
-				yn = ""
 				if c.Bool("udpovertcp") {
-					yn = "true"
+					v.Set("udpovertcp", "true")
 				}
-				v.Set("udpovertcp", yn)
 				if c.String("ca") != "" {
 					b, err := ioutil.ReadFile(c.String("ca"))
 					if err != nil {

diff --git a/docs/index.html b/docs/index.html
@@ -78,6 +78,8 @@ <h1><a name="table-of-contents" class="anchor" href="#table-of-contents" rel="no
 <li><a href="#brook-dns-can-create-a-encrypted-dns-server-both-tcp-and-udp-it-works-with-brook-server-wsserver-wssserver" rel="nofollow">brook dns can create a encrypted DNS server, both TCP and UDP, it works with brook server wsserver wssserver.</a></li>
 <li><a href="#brook-tproxy-transparent-proxy-gateway-on-official-openwrt" rel="nofollow">brook tproxy Transparent Proxy Gateway on official OpenWrt</a></li>
 <li><a href="#brook-tproxy-transparent-proxy-gateway-on-ubuntu" rel="nofollow">brook tproxy Transparent Proxy Gateway on Ubuntu</a></li>
+<li><a href="#brook-tproxy-transparent-proxy-gateway-on-macos" rel="nofollow">brook tproxy Transparent Proxy Gateway on macOS</a></li>
+<li><a href="#brook-tproxy-transparent-proxy-gateway-on-windows" rel="nofollow">brook tproxy Transparent Proxy Gateway on Windows</a></li>
 <li><a href="#gui-for-official-openwrt" rel="nofollow">GUI for official OpenWrt</a></li>
 <li><a href="#brook-relay-can-relay-a-address-to-a-remote-address-it-can-relay-any-tcp-and-udp-server" rel="nofollow">brook relay can relay a address to a remote address. It can relay any tcp and udp server</a></li>
 <li><a href="#brook-socks5tohttp-can-convert-a-socks5-to-a-http-proxy" rel="nofollow">brook socks5tohttp can convert a socks5 to a http proxy</a></li>
@@ -111,10 +113,11 @@ <h3><a name="install-brook-command" class="anchor" href="#install-brook-command"
 or<br/>
 the script but only some parameters are supported: <code>bash &lt;(curl https://bash.ooo/brook.sh)</code><br/>
 or<br/>
-Archlinux: <code>pacman -S brook</code><br/>
+scripts written by others<br/>
 or<br/>
-brew: <code>brew install brook</code><br/><br/>
-recommend run command with root<br/></p>
+Archlinux: <code>pacman -S brook</code> (may be outdated)<br/>
+or<br/>
+brew: <code>brew install brook</code> (may be outdated)<br/></p>
 </blockquote>
 
 <p>Install nami</p>
@@ -437,6 +440,14 @@ <h3><a name="brook-tproxy-transparent-proxy-gateway-on-ubuntu" class="anchor" hr
 <li>You may need to manually configure the computer or mobile gateway and DNS.</li>
 <li>If you are running in a virtual machine and the host is using a wireless card, it may not work.</li>
 </ol>
+<h3><a name="brook-tproxy-transparent-proxy-gateway-on-macos" class="anchor" href="#brook-tproxy-transparent-proxy-gateway-on-macos" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
+brook tproxy Transparent Proxy Gateway on macOS</h3>
+
+<p><a href="https://talks.txthinking.com/articles/brook-gateway-on-macos-en.article" rel="nofollow">https://talks.txthinking.com/articles/brook-gateway-on-macos-en.article</a></p>
+<h3><a name="brook-tproxy-transparent-proxy-gateway-on-windows" class="anchor" href="#brook-tproxy-transparent-proxy-gateway-on-windows" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
+brook tproxy Transparent Proxy Gateway on Windows</h3>
+
+<p><a href="https://talks.txthinking.com/articles/brook-gateway-on-windows-en.article" rel="nofollow">https://talks.txthinking.com/articles/brook-gateway-on-windows-en.article</a></p>
 <h3><a name="gui-for-official-openwrt" class="anchor" href="#gui-for-official-openwrt" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
 GUI for official OpenWrt</h3>
 

diff --git a/docs/index_zh.html b/docs/index_zh.html
@@ -78,6 +78,8 @@ <h1><a name="table-of-contents" class="anchor" href="#table-of-contents" rel="no
 <li><a href="#brook-dns-%E7%94%A8%E6%9D%A5%E5%88%9B%E5%BB%BA%E4%B8%80%E4%B8%AA%E5%8A%A0%E5%AF%86-dns-server-tcp-and-udp-%E5%AE%83%E4%B8%8E-brook-server-wsserver-wssserver-%E4%B8%80%E8%B5%B7%E5%B7%A5%E4%BD%9C" rel="nofollow">brook dns 用来创建一个加密 DNS Server, TCP and UDP, 它与 brook server wsserver wssserver 一起工作</a></li>
 <li><a href="#brook-tproxy-%E9%80%8F%E6%98%8E%E4%BB%A3%E7%90%86%E7%BD%91%E5%85%B3%E5%9C%A8%E5%AE%98%E7%BD%91%E5%8E%9F%E7%89%88-openwrt" rel="nofollow">brook tproxy 透明代理网关在官网原版 OpenWrt</a></li>
 <li><a href="#brook-tproxy-%E9%80%8F%E6%98%8E%E4%BB%A3%E7%90%86%E7%BD%91%E5%85%B3%E5%9C%A8-ubuntu" rel="nofollow">brook tproxy 透明代理网关在 Ubuntu</a></li>
+<li><a href="#brook-tproxy-%E9%80%8F%E6%98%8E%E4%BB%A3%E7%90%86%E7%BD%91%E5%85%B3%E5%9C%A8-macos" rel="nofollow">brook tproxy 透明代理网关在 macOS</a></li>
+<li><a href="#brook-tproxy-%E9%80%8F%E6%98%8E%E4%BB%A3%E7%90%86%E7%BD%91%E5%85%B3%E5%9C%A8-windows" rel="nofollow">brook tproxy 透明代理网关在 Windows</a></li>
 <li><a href="#%E5%AE%98%E7%BD%91%E5%8E%9F%E7%89%88-openwrt-%E5%9B%BE%E5%BD%A2%E5%AE%A2%E6%88%B7%E7%AB%AF" rel="nofollow">官网原版 OpenWrt 图形客户端</a></li>
 <li><a href="#brook-relay-%E5%8F%AF%E4%BB%A5%E4%B8%AD%E7%BB%A7%E4%BB%BB%E4%BD%95-tcp-%E5%92%8C-udp-server-%E8%BF%99%E6%98%AF%E4%B8%80%E4%B8%AA%E7%8B%AC%E7%AB%8B%E7%9A%84%E5%8A%9F%E8%83%BD-%E5%AE%83%E4%B8%8D%E4%BE%9D%E8%B5%96-brook-server-wsserver-wssserver" rel="nofollow">brook relay 可以中继任何 TCP 和 UDP server, 这是一个独立的功能, 它不依赖 brook server wsserver wssserver</a></li>
 <li><a href="#brook-socks5tohttp-%E5%B0%86-socks5-proxy-%E8%BD%AC%E6%8D%A2%E4%B8%BA-http-proxy" rel="nofollow">brook socks5tohttp 将 socks5 proxy 转换为 http proxy</a></li>
@@ -111,10 +113,11 @@ <h3><a name="安装-brook-命令" class="anchor" href="#%E5%AE%89%E8%A3%85-brook
 或<br/>
 一键脚本，目前仅支持部分命令参数: <code>bash &lt;(curl https://bash.ooo/brook.sh)</code><br/>
 或<br/>
-Archlinux: <code>pacman -S brook</code><br/>
+使用网上其他同学写的脚本<br/>
 或<br/>
-brew: <code>brew install brook</code><br/><br/>
-建议使用 root 用户运行命令<br/></p>
+Archlinux: <code>pacman -S brook</code> (可能不是最新版本)<br/>
+或<br/>
+brew: <code>brew install brook</code> (可能不是最新版本)<br/></p>
 </blockquote>
 
 <p>安装 nami</p>
@@ -438,6 +441,14 @@ <h3><a name="brook-tproxy-透明代理网关在-ubuntu" class="anchor" href="#br
 <li>配置其他机器的网关和 DNS 为这台机器的 IP 即可</li>
 <li>如果你运行在虚拟机里并且宿主机使用的是无线网卡, 可能不能工作。</li>
 </ol>
+<h3><a name="brook-tproxy-透明代理网关在-macos" class="anchor" href="#brook-tproxy-%E9%80%8F%E6%98%8E%E4%BB%A3%E7%90%86%E7%BD%91%E5%85%B3%E5%9C%A8-macos" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
+brook tproxy 透明代理网关在 macOS</h3>
+
+<p><a href="https://talks.txthinking.com/articles/brook-gateway-on-macos.article" rel="nofollow">https://talks.txthinking.com/articles/brook-gateway-on-macos.article</a></p>
+<h3><a name="brook-tproxy-透明代理网关在-windows" class="anchor" href="#brook-tproxy-%E9%80%8F%E6%98%8E%E4%BB%A3%E7%90%86%E7%BD%91%E5%85%B3%E5%9C%A8-windows" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
+brook tproxy 透明代理网关在 Windows</h3>
+
+<p><a href="https://talks.txthinking.com/articles/brook-gateway-on-windows.article" rel="nofollow">https://talks.txthinking.com/articles/brook-gateway-on-windows.article</a></p>
 <h3><a name="官网原版-openwrt-图形客户端" class="anchor" href="#%E5%AE%98%E7%BD%91%E5%8E%9F%E7%89%88-openwrt-%E5%9B%BE%E5%BD%A2%E5%AE%A2%E6%88%B7%E7%AB%AF" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
 官网原版 OpenWrt 图形客户端</h3>