Skip to content

Commit

Permalink
v20210401
Browse files Browse the repository at this point in the history
  • Loading branch information
txthinking committed Mar 30, 2021
1 parent b4a2f24 commit e1af24b
Show file tree
Hide file tree
Showing 37 changed files with 462 additions and 413 deletions.
1 change: 0 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

1. Please create a issue first
1. Don't use internal package
1. Don't use any package manager
1. Single function better than multiple functions
1. Single file better than multiple files
1. Single diretory better than multiple directories
Expand Down
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,17 @@

---

**v20210214**

- Only updated the client, optimized link, QR, sharing, import
- [Document](https://txthinking.github.io/brook/)
- [Community](https://github.com/txthinking/brook/discussions)
**v20210401**

- [GUI] Block list(Ad Block)
- [Bypass & Block rule](https://github.com/txthinking/bypass)
- [GUI] Forward DNS
- [GUI] OpenWrt GUI client
- [GUI] Fake DNS
- [CLI] \$ brook tproxy
- [Document](https://txthinking.github.io/brook/)
- [Community(ask here)](https://github.com/txthinking/brook/discussions)
- go mod

---

Expand All @@ -37,9 +43,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, v20210214
# For example, on linux amd64, v20210401
curl -L https://github.com/txthinking/brook/releases/download/v20210214/brook_linux_amd64 -o /usr/bin/brook
curl -L https://github.com/txthinking/brook/releases/download/v20210401/brook_linux_amd64 -o /usr/bin/brook
chmod +x /usr/bin/brook
```

Expand All @@ -49,18 +55,28 @@ Install via [nami](https://github.com/txthinking/nami)
nami install github.com/txthinking/brook
```

Install via brew

```
brew install brook
```

### Install GUI

> The GUI file has only client function
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.exe), [Android](https://github.com/txthinking/brook/releases/download/v20210214/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/v20210401/Brook.dmg), [Windows](https://github.com/txthinking/brook/releases/download/v20210401/Brook.exe), [Android](https://github.com/txthinking/brook/releases/download/v20210401/Brook.apk), [iOS](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642)

Install via brew

```
brew install --cask brook
```

```
brew install --cask brooklite
```

## Usage

[Docs](https://txthinking.github.io/brook/)
Expand All @@ -73,7 +89,7 @@ USAGE:
brook [global options] command [command options] [arguments...]
VERSION:
20210214
20210401
AUTHOR:
Cloud <[email protected]>
Expand Down
34 changes: 25 additions & 9 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,17 @@

---

**v20210214**

- 只是更新了客户端, 优化link, QR, 分享, 导入
- [官方文档](https://txthinking.github.io/brook/#/zh-cn/)
- [官方论坛](https://github.com/txthinking/brook/discussions)
**v20210401**

- [GUI] Block list(广告过滤)
- [Bypass & Block 规则](https://github.com/txthinking/bypass)
- [GUI] DNS 转发
- [GUI] OpenWrt 图形客户端
- [GUI] Fake DNS
- [CLI] \$ brook tproxy
- [官方文档](https://txthinking.github.io/brook/#/zh-cn/)
- [官方论坛(问问题的地方](https://github.com/txthinking/brook/discussions)
- go mod

---

Expand All @@ -36,9 +42,9 @@ Brook 是一个跨平台的强加密无特征的代理软件. 偏爱 KISS 哲学
[releases](https://github.com/txthinking/brook/releases) 页面下载

```
# 举例, linux amd64, v20210214
# 举例, linux amd64, v20210401
curl -L https://github.com/txthinking/brook/releases/download/v20210214/brook_linux_amd64 -o /usr/bin/brook
curl -L https://github.com/txthinking/brook/releases/download/v20210401/brook_linux_amd64 -o /usr/bin/brook
chmod +x /usr/bin/brook
```

Expand All @@ -48,16 +54,26 @@ chmod +x /usr/bin/brook
nami install github.com/txthinking/brook
```

通过 brew 安装

```
brew install brook
```

### 安装 GUI (图形客户端)

[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.exe), [Android](https://github.com/txthinking/brook/releases/download/v20210214/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/v20210401/Brook.dmg), [Windows](https://github.com/txthinking/brook/releases/download/v20210401/Brook.exe), [Android](https://github.com/txthinking/brook/releases/download/v20210401/Brook.apk), [iOS](https://apps.apple.com/us/app/brook-a-cross-platform-proxy/id1216002642)

通过 brew 安装

```
brew install --cask brook
```

```
brew install --cask brooklite
```

## 使用

[文档](https://txthinking.github.io/brook/#/zh-cn/)
Expand All @@ -70,7 +86,7 @@ USAGE:
brook [global options] command [command options] [arguments...]
VERSION:
20210214
20210401
AUTHOR:
Cloud <[email protected]>
Expand Down
4 changes: 2 additions & 2 deletions cli/brook/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,6 @@ mv brook.ipk ../cli/brook/_/brook_linux_ppc64le.ipk

cd ../cli/brook/

# nami release github.com/txthinking/brook $1 _
nami release github.com/txthinking/brook $1 _

# rm -rf _
rm -rf _
2 changes: 1 addition & 1 deletion cli/brook/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var debugAddress string
func main() {
app := cli.NewApp()
app.Name = "Brook"
app.Version = "20210214"
app.Version = "20210401"
app.Usage = "A cross-platform strong encryption and not detectable proxy"
app.Authors = []*cli.Author{
{
Expand Down
14 changes: 14 additions & 0 deletions cli/brook/static/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no">
<title>Brook</title>
<script async src="https://www.googletagmanager.com/gtag/js?id=G-96ENZWNBX1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'G-96ENZWNBX1');
</script>
<style>
body{
margin:0;
Expand Down Expand Up @@ -136,6 +144,12 @@ <h2>Brook for OpenWrt</h2>
<wl-button flat inverted style="color:black;text-transform: none;"><a target="_blank" href="https://t.me/brookchannel">Telegram Channel</a></wl-button>
</div>
</div>
<div style="display:flex;flex-direction:row;background-color:black;justify-content:space-between;margin-top:auto;padding:20px;">
<div style="display:flex;width:100%;flex-direction:row;justify-content:space-between;align-items:flex-start;flex-wrap: wrap;">
<wl-button flat inverted style="color:white;text-transform:none;">A project by&nbsp;<a target="_blank" href="https://www.txthinking.com">txthinking</a></wl-button>
<wl-text style="color:#919191;margin-top:10px;"></wl-text>
</div>
</div>
<script>
document.querySelector('#ing').style.display='none';

Expand Down
110 changes: 63 additions & 47 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,63 +2,79 @@

## `CLI` and `GUI`

- CLI(Command-line interface)
- CLI(Command-line interface)

- You can run commands after **entering the command-line interface**. [What is CLI(Chinese)](https://talks.txthinking.com/)
- Usually, everyone uses the command line interface on Linux servers. Of course, Linux also has desktops that can also run GUI
- Of course, macOS and Windows also have command-line interfaces, but you may not use them frequently
- You can run commands after **entering the command-line interface**. [What is CLI(Chinese)](https://talks.txthinking.com/)
- Usually, everyone uses the command line interface on Linux servers. Of course, Linux also has desktops that can also run GUI
- Of course, macOS and Windows also have command-line interfaces, but you may not use them frequently

- GUI(Graphical user interface)
- GUI(Graphical user interface)

- Usually, the applications opened by **double-clicking/clicking** on macOS/Windows/iOS/Android are all GUIs
- Usually, the applications opened by **double-clicking/clicking** on macOS/Windows/iOS/Android are all GUIs

## Brook CLI files and GUI files

**Usually**, if you use Brook, you will need a combination of **Server** and **Client**, **Of course** Brook CLI also has **many other independent functions**

- Brook CLI file
- Brook CLI file

- The Brook CLI file is an **independent command file**, it can be said that there is no concept of installation, just download this file to your computer, **run it after granting it executable permissions in the command line interface**
- Brook CLI file has both **server function** and **client function**, Brook CLI file also has **many other independent functions**
- If you are under Linux and you are not very familiar with Linux, **It is strongly recommended to use the ubuntu system and root user** to run commands. The command to switch to the root user is `$ sudo su`
- **Each function of Brook requires only one command, no configuration is required**
- The Brook CLI file is an **independent command file**, it can be said that there is no concept of installation, just download this file to your computer, **run it after granting it executable permissions in the command line interface**
- Brook CLI file has both **server function** and **client function**, Brook CLI file also has **many other independent functions**
- If you are under Linux and you are not very familiar with Linux, **It is strongly recommended to use the ubuntu system and root user** to run commands. The command to switch to the root user is `$ sudo su`
- **Each function of Brook requires only one command, no configuration is required**

- Brook GUI file
- Brook GUI file

- **Keep system up to date**
- Brook GUI file is a graphical client, only has **client function**
- **Keep system up to date**
- Brook GUI file is a graphical client, only has **client function**

**Brook files description**, all can be downloaded in [Releases](https://github.com/txthinking/brook/releases/tag/v20210214) page
**Brook files description**, all can be downloaded in [Releases](https://github.com/txthinking/brook/releases) page. Of course, you can also see in the left menu that use `nami` to automatically select Brook CLI file

| File Name | CLI/GUI | Applicable system |
| --- | --- | --- |
| brook_linux_amd64 | CLI| Linux 64 bit |
| brook_linux_386 | CLI| Linux 32 bit |
| brook_linux_arm64 | CLI| Linux arm64 |
| brook_linux_arm7 | CLI| Linux arm7 |
| brook_linux_arm6 | CLI| Linux arm6 |
| brook_linux_arm5 | CLI| Linux arm5 |
| brook_linux_mips | CLI| Linux mips |
| brook_linux_mipsle | CLI| Linux mipsle |
| brook_linux_mips_softfloat | CLI| Linux mips softfloat |
| brook_linux_mipsle_softfloat | CLI| Linux mipsle softfloat |
| brook_linux_mips64 | CLI| Linux mips64 |
| brook_linux_mips64le | CLI| Linux mips64le |
| brook_linux_mips64_softfloat | CLI| Linux mips64 softfloat |
| brook_linux_mips64le_softfloat | CLI| Linux mips64le softfloat |
| brook_linux_ppc64 | CLI| Linux ppc64 |
| brook_linux_ppc64le | CLI| Linux ppc64le |
| brook_freebsd_386 | CLI| FreeBSD 32 bit |
| brook_freebsd_amd64| CLI| FreeBSD 64 bit |
| brook_netbsd_386 | CLI| NetBSD 32 bit |
| brook_netbsd_amd64 | CLI| NetBSD 64 bit |
| brook_openbsd_386 | CLI| OpenBSD 32 bit |
| brook_openbsd_amd64| CLI| OpenBSD 64 bit |
| brook_windows_amd64.exe| CLI| Windows 64 bit |
| brook_windows_386.exe| CLI| Windows 32 bit |
| brook_darwin_amd64.exe| CLI| macOS 64 bit |
| Brook.dmg | GUI| macOS 64 bit |
| Brook.exe | GUI| Windows 64 bit |
| Brook.apk | GUI| Android |
| BrookLite.dmg | GUI| macOS 64 bit |
| BrookLite.exe | GUI| Windows 64 bit |
| File Name | CLI/GUI | Applicable system |
| ---------------------------------- | ------- | -------------------------------- |
| brook_linux_amd64 | CLI | Linux 64 bit |
| brook_linux_386 | CLI | Linux 32 bit |
| brook_linux_arm64 | CLI | Linux arm64 |
| brook_linux_arm7 | CLI | Linux arm7 |
| brook_linux_arm6 | CLI | Linux arm6 |
| brook_linux_arm5 | CLI | Linux arm5 |
| brook_linux_mips | CLI | Linux mips |
| brook_linux_mipsle | CLI | Linux mipsle |
| brook_linux_mips_softfloat | CLI | Linux mips softfloat |
| brook_linux_mipsle_softfloat | CLI | Linux mipsle softfloat |
| brook_linux_mips64 | CLI | Linux mips64 |
| brook_linux_mips64le | CLI | Linux mips64le |
| brook_linux_mips64_softfloat | CLI | Linux mips64 softfloat |
| brook_linux_mips64le_softfloat | CLI | Linux mips64le softfloat |
| brook_linux_ppc64 | CLI | Linux ppc64 |
| brook_linux_ppc64le | CLI | Linux ppc64le |
| brook_freebsd_386 | CLI | FreeBSD 32 bit |
| brook_freebsd_amd64 | CLI | FreeBSD 64 bit |
| brook_netbsd_386 | CLI | NetBSD 32 bit |
| brook_netbsd_amd64 | CLI | NetBSD 64 bit |
| brook_openbsd_386 | CLI | OpenBSD 32 bit |
| brook_openbsd_amd64 | CLI | OpenBSD 64 bit |
| brook_windows_amd64.exe | CLI | Windows 64 bit |
| brook_windows_386.exe | CLI | Windows 32 bit |
| brook_darwin_amd64.exe | CLI | macOS 64 bit |
| Brook.dmg | GUI | macOS 64 bit |
| Brook.exe | GUI | Windows 64 bit |
| Brook.apk | GUI | Android |
| BrookLite.dmg | GUI | macOS 64 bit |
| BrookLite.exe | GUI | Windows 64 bit |
| brook_linux_amd64.ipk | GUI | OpenWrt Linux 64 bit |
| brook_linux_386.ipk | GUI | OpenWrt Linux 32 bit |
| brook_linux_arm64.ipk | GUI | OpenWrt Linux arm64 |
| brook_linux_arm7.ipk | GUI | OpenWrt Linux arm7 |
| brook_linux_arm6.ipk | GUI | OpenWrt Linux arm6 |
| brook_linux_arm5.ipk | GUI | OpenWrt Linux arm5 |
| brook_linux_mips.ipk | GUI | OpenWrt Linux mips |
| brook_linux_mipsle.ipk | GUI | OpenWrt Linux mipsle |
| brook_linux_mips_softfloat.ipk | GUI | OpenWrt Linux mips softfloat |
| brook_linux_mipsle_softfloat.ipk | GUI | OpenWrt Linux mipsle softfloat |
| brook_linux_mips64.ipk | GUI | OpenWrt Linux mips64 |
| brook_linux_mips64le.ipk | GUI | OpenWrt Linux mips64le |
| brook_linux_mips64_softfloat.ipk | GUI | OpenWrt Linux mips64 softfloat |
| brook_linux_mips64le_softfloat.ipk | GUI | OpenWrt Linux mips64le softfloat |
| brook_linux_ppc64.ipk | GUI | OpenWrt Linux ppc64 |
| brook_linux_ppc64le.ipk | GUI | OpenWrt Linux ppc64le |
Loading

0 comments on commit e1af24b

Please sign in to comment.