Skip to content

Commit 62ede37

Browse files
authored
docs: move installation guide to INSTALL.md (#200)
* chore: update docs
1 parent 774240e commit 62ede37

File tree

6 files changed

+60
-220
lines changed

6 files changed

+60
-220
lines changed

README.md

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,12 @@
44

55
Read in other Languages: [🇬🇧English](https://github.com/xvzc/SpoofDPI), [🇰🇷한국어](https://github.com/xvzc/SpoofDPI/blob/main/_docs/README_ko.md), [🇨🇳简体中文](https://github.com/xvzc/SpoofDPI/blob/main/_docs/README_zh-cn.md), [🇷🇺Русский](https://github.com/xvzc/SpoofDPI/blob/main/_docs/README_ru.md), [🇯🇵日本語](https://github.com/xvzc/SpoofDPI/blob/main/_docs/README_ja.md)
66

7-
A simple and fast software designed to bypass **Deep Packet Inspection**
7+
A simple and fast software designed to bypass **Deep Packet Inspection**.
88

99
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
1010

1111
# Installation
12-
## Binary
13-
SpoofDPI will be installed in `~/.spoof-dpi/bin`.
14-
To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...`
15-
```
16-
export PATH=$PATH:~/.spoof-dpi/bin
17-
```
18-
---
19-
```bash
20-
# macOS Intel
21-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64
22-
23-
# macOS Apple Silicon
24-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-arm64
25-
26-
# linux-amd64
27-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64
28-
29-
# linux-arm
30-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm
31-
32-
# linux-arm64
33-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64
34-
35-
# linux-mips
36-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips
37-
38-
# linux-mipsle
39-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle
40-
```
41-
42-
43-
## Go
44-
You can also install SpoofDPI with `go install`
45-
```bash
46-
$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
47-
```
48-
49-
## Git
50-
You can also build your own
51-
```bash
52-
$ git clone https://github.com/xvzc/SpoofDPI.git
53-
$ cd SpoofDPI
54-
$ go build ./cmd/...
55-
```
12+
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md).
5613

5714
# Usage
5815
```
@@ -109,5 +66,5 @@ google-chrome --proxy-server="http://127.0.0.1:8080"
10966
and then send the rest.
11067

11168
# Inspirations
112-
[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) by @SadeghHayeri
69+
[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) by @SadeghHayeri
11370
[GoodbyeDPI](https://github.com/ValdikSS/GoodbyeDPI) by @ValdikSS

_docs/INSTALL.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Installation
2+
3+
## Binary
4+
SpoofDPI will be installed in `~/.spoof-dpi/bin`.
5+
To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...`
6+
```
7+
export PATH=$PATH:~/.spoof-dpi/bin
8+
```
9+
---
10+
```bash
11+
# macOS Intel
12+
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64
13+
14+
# macOS Apple Silicon
15+
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-arm64
16+
17+
# linux-amd64
18+
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64
19+
20+
# linux-arm
21+
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm
22+
23+
# linux-arm64
24+
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64
25+
26+
# linux-mips
27+
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips
28+
29+
# linux-mipsle
30+
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle
31+
```
32+
33+
34+
## Go
35+
You can also install SpoofDPI with `go install`
36+
```bash
37+
$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
38+
```
39+
40+
## Git
41+
You can also build your own
42+
```bash
43+
$ git clone https://github.com/xvzc/SpoofDPI.git
44+
$ cd SpoofDPI
45+
$ go build ./cmd/...
46+
```
47+

_docs/README_ja.md

Lines changed: 2 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -8,48 +8,8 @@
88

99
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
1010

11-
# インストール
12-
## バイナリ
13-
SpoofDPIは`~/.spoof-dpi/bin`にインストールされます。
14-
任意のディレクトリでSpoofDPIを実行するには、以下の行を`~/.bashrc || ~/.zshrc || ...`に追加してください。
15-
```
16-
export PATH=$PATH:~/.spoof-dpi/bin
17-
```
18-
---
19-
```bash
20-
# OSX
21-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64
22-
23-
# linux-amd64
24-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64
25-
26-
# linux-arm
27-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm
28-
29-
# linux-arm64
30-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64
31-
32-
# linux-mips
33-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips
34-
35-
# linux-mipsle
36-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle
37-
```
38-
39-
40-
## Go
41-
`go install` でインストールすることもできます
42-
```bash
43-
$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
44-
```
45-
46-
## Git
47-
自分でビルドすることもできます
48-
```bash
49-
$ git clone https://github.com/xvzc/SpoofDPI.git
50-
$ cd SpoofDPI
51-
$ go build ./cmd/...
52-
```
11+
# Installation
12+
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md).
5313

5414
# 使用方法
5515
```

_docs/README_ko.md

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,8 @@ DPI(Deep Packet Inspection) 우회를 위해 고안된 소프트웨어
88

99
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
1010

11-
# 설치
12-
## Binary
13-
SpoofDPI는 `~/.spoof-dpi/bin` 경로에 설치됩니다.
14-
모든 경로에서 SpoofDPI를 실행 가능하도록 하기위해서 아래 라인을 `~/.bashrc || ~/.zshrc || ...`에 추가해주세요.
15-
```
16-
export PATH=$PATH:~/.spoof-dpi/bin
17-
```
18-
---
19-
```bash
20-
# OSX
21-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64
22-
23-
# linux-amd64
24-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64
25-
26-
# linux-arm
27-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm
28-
29-
# linux-arm64
30-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64
31-
32-
# linux-mips
33-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips
34-
35-
# linux-mipsle
36-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle
37-
```
38-
39-
40-
## Go
41-
`go install`로 설치하기
42-
```bash
43-
$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
44-
```
45-
46-
## Git
47-
직접 빌드하기
48-
`$ git clone https://github.com/xvzc/SpoofDPI.git`
49-
`$ cd SpoofDPI`
50-
`$ go build ./cmd/...`
11+
# Installation
12+
SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md)를 참고바랍니다.
5113

5214
# 사용법
5315
```

_docs/README_ru.md

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -8,50 +8,8 @@
88

99
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
1010

11-
# Установка
12-
## Бинарник
13-
SpoofDPI будет установлен в директорию `~/.spoof-dpi/bin`.
14-
Чтобы запустить SpoofDPI в любой директории, добавьте строку ниже в `~/.bashrc || ~/.zshrc || ...`
15-
```
16-
export PATH=$PATH:~/.spoof-dpi/bin
17-
```
18-
---
19-
```bash
20-
# macOS Intel
21-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64
22-
23-
# macOS Apple Silicon
24-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-arm64
25-
26-
# linux-amd64
27-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64
28-
29-
# linux-arm
30-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm
31-
32-
# linux-arm64
33-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64
34-
35-
# linux-mips
36-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips
37-
38-
# linux-mipsle
39-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle
40-
```
41-
42-
## Go
43-
Вы также можете установить SpoofDPI с помощью `go install`
44-
```bash
45-
$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
46-
```
47-
48-
## Git
49-
Вы также можете собрать SpoofDPI
50-
```bash
51-
$ git clone https://github.com/xvzc/SpoofDPI.git
52-
$ cd SpoofDPI
53-
$ go build ./cmd/...
54-
```
11+
# Installation
12+
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md).
5513

5614
# Использование
5715
```
@@ -104,5 +62,5 @@ google-chrome --proxy-server="http://127.0.0.1:8080"
10462
Я попробовал несколько способов обойти это, и обнаружил, что, похоже, проверяется только первый фрагмент, когда мы отправляем пакет Client Hello, разделенный на фрагменты. Чтобы обойти DPI, SpoofDPI отправляет на сервер первый 1 байт запроса, а затем отправляет все остальное.
10563

10664
# Вдохновение
107-
[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) от @SadeghHayeri
65+
[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) от @SadeghHayeri
10866
[GoodbyeDPI](https://github.com/ValdikSS/GoodbyeDPI) от @ValdikSS

_docs/README_zh-cn.md

Lines changed: 3 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -10,52 +10,8 @@
1010

1111
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
1212

13-
# 安装
14-
## Binary
15-
16-
SpoofDPI 会被安装在 `~/.spoof-dpi/bin`
17-
要在其他目录下运行,请给 `~/.bashrc || ~/.zshrc || ...` 添加
18-
19-
```
20-
export PATH=$PATH:~/.spoof-dpi/bin
21-
```
22-
---
23-
```bash
24-
# macOS Intel
25-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64
26-
27-
# macOS Apple Silicon
28-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-arm64
29-
30-
# linux-amd64
31-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64
32-
33-
# linux-arm
34-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm
35-
36-
# linux-arm64
37-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64
38-
39-
# linux-mips
40-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips
41-
42-
# linux-mipsle
43-
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle
44-
```
45-
46-
## Go
47-
也可以用 `go install` 安装
48-
```bash
49-
$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
50-
```
51-
52-
## Git
53-
You can also build your own
54-
```bash
55-
$ git clone https://github.com/xvzc/SpoofDPI.git
56-
$ cd SpoofDPI
57-
$ go build ./cmd/...
58-
```
13+
# Installation
14+
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md).
5915

6016
# 使用方法
6117

@@ -111,5 +67,5 @@ google-chrome --proxy-server="http://127.0.0.1:8080"
11167

11268
# 启发
11369

114-
[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) by @SadeghHayeri
70+
[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) by @SadeghHayeri
11571
[GoodbyeDPI](https://github.com/ValdikSS/GoodbyeDPI) by @ValdikSS

0 commit comments

Comments
 (0)