From 62ede3726b9eebe3c137d8277d71ea40762632b2 Mon Sep 17 00:00:00 2001 From: xvzc <45588457+xvzc@users.noreply.github.com> Date: Mon, 26 Aug 2024 20:54:54 +0900 Subject: [PATCH] docs: move installation guide to INSTALL.md (#200) * chore: update docs --- README.md | 49 +++--------------------------------------- _docs/INSTALL.md | 47 ++++++++++++++++++++++++++++++++++++++++ _docs/README_ja.md | 44 ++----------------------------------- _docs/README_ko.md | 42 ++---------------------------------- _docs/README_ru.md | 48 +++-------------------------------------- _docs/README_zh-cn.md | 50 +++---------------------------------------- 6 files changed, 60 insertions(+), 220 deletions(-) create mode 100644 _docs/INSTALL.md diff --git a/README.md b/README.md index 64db368..c6416b1 100644 --- a/README.md +++ b/README.md @@ -4,55 +4,12 @@ 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) -A simple and fast software designed to bypass **Deep Packet Inspection** +A simple and fast software designed to bypass **Deep Packet Inspection**. ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # Installation -## Binary -SpoofDPI will be installed in `~/.spoof-dpi/bin`. -To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...` -``` -export PATH=$PATH:~/.spoof-dpi/bin -``` ---- -```bash -# macOS Intel -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64 - -# macOS Apple Silicon -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-arm64 - -# linux-amd64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64 - -# linux-arm -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm - -# linux-arm64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64 - -# linux-mips -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips - -# linux-mipsle -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle -``` - - -## Go -You can also install SpoofDPI with `go install` -```bash -$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest -``` - -## Git -You can also build your own -```bash -$ git clone https://github.com/xvzc/SpoofDPI.git -$ cd SpoofDPI -$ go build ./cmd/... -``` +See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). # Usage ``` @@ -109,5 +66,5 @@ google-chrome --proxy-server="http://127.0.0.1:8080" and then send the rest. # Inspirations -[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) by @SadeghHayeri +[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) by @SadeghHayeri [GoodbyeDPI](https://github.com/ValdikSS/GoodbyeDPI) by @ValdikSS diff --git a/_docs/INSTALL.md b/_docs/INSTALL.md new file mode 100644 index 0000000..222df0d --- /dev/null +++ b/_docs/INSTALL.md @@ -0,0 +1,47 @@ +# Installation + +## Binary +SpoofDPI will be installed in `~/.spoof-dpi/bin`. +To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...` +``` +export PATH=$PATH:~/.spoof-dpi/bin +``` +--- +```bash +# macOS Intel +curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64 + +# macOS Apple Silicon +curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-arm64 + +# linux-amd64 +curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64 + +# linux-arm +curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm + +# linux-arm64 +curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64 + +# linux-mips +curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips + +# linux-mipsle +curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle +``` + + +## Go +You can also install SpoofDPI with `go install` +```bash +$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest +``` + +## Git +You can also build your own +```bash +$ git clone https://github.com/xvzc/SpoofDPI.git +$ cd SpoofDPI +$ go build ./cmd/... +``` + diff --git a/_docs/README_ja.md b/_docs/README_ja.md index 06f5b77..04c63b7 100644 --- a/_docs/README_ja.md +++ b/_docs/README_ja.md @@ -8,48 +8,8 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) -# インストール -## バイナリ -SpoofDPIは`~/.spoof-dpi/bin`にインストールされます。 -任意のディレクトリでSpoofDPIを実行するには、以下の行を`~/.bashrc || ~/.zshrc || ...`に追加してください。 -``` -export PATH=$PATH:~/.spoof-dpi/bin -``` ---- -```bash -# OSX -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64 - -# linux-amd64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64 - -# linux-arm -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm - -# linux-arm64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64 - -# linux-mips -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips - -# linux-mipsle -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle -``` - - -## Go -`go install` でインストールすることもできます -```bash -$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest -``` - -## Git -自分でビルドすることもできます -```bash -$ git clone https://github.com/xvzc/SpoofDPI.git -$ cd SpoofDPI -$ go build ./cmd/... -``` +# Installation +See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). # 使用方法 ``` diff --git a/_docs/README_ko.md b/_docs/README_ko.md index ed57b58..dbc04ba 100644 --- a/_docs/README_ko.md +++ b/_docs/README_ko.md @@ -8,46 +8,8 @@ DPI(Deep Packet Inspection) 우회를 위해 고안된 소프트웨어 ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) -# 설치 -## Binary -SpoofDPI는 `~/.spoof-dpi/bin` 경로에 설치됩니다. -모든 경로에서 SpoofDPI를 실행 가능하도록 하기위해서 아래 라인을 `~/.bashrc || ~/.zshrc || ...`에 추가해주세요. -``` -export PATH=$PATH:~/.spoof-dpi/bin -``` ---- -```bash -# OSX -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64 - -# linux-amd64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64 - -# linux-arm -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm - -# linux-arm64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64 - -# linux-mips -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips - -# linux-mipsle -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle -``` - - -## Go -`go install`로 설치하기 -```bash -$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest -``` - -## Git -직접 빌드하기 -`$ git clone https://github.com/xvzc/SpoofDPI.git` -`$ cd SpoofDPI` -`$ go build ./cmd/...` +# Installation +SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md)를 참고바랍니다. # 사용법 ``` diff --git a/_docs/README_ru.md b/_docs/README_ru.md index 8e7b932..05e68ec 100644 --- a/_docs/README_ru.md +++ b/_docs/README_ru.md @@ -8,50 +8,8 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) -# Установка -## Бинарник -SpoofDPI будет установлен в директорию `~/.spoof-dpi/bin`. -Чтобы запустить SpoofDPI в любой директории, добавьте строку ниже в `~/.bashrc || ~/.zshrc || ...` -``` -export PATH=$PATH:~/.spoof-dpi/bin -``` ---- -```bash -# macOS Intel -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64 - -# macOS Apple Silicon -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-arm64 - -# linux-amd64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64 - -# linux-arm -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm - -# linux-arm64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64 - -# linux-mips -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips - -# linux-mipsle -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle -``` - -## Go -Вы также можете установить SpoofDPI с помощью `go install` -```bash -$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest -``` - -## Git -Вы также можете собрать SpoofDPI -```bash -$ git clone https://github.com/xvzc/SpoofDPI.git -$ cd SpoofDPI -$ go build ./cmd/... -``` +# Installation +See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). # Использование ``` @@ -104,5 +62,5 @@ google-chrome --proxy-server="http://127.0.0.1:8080" Я попробовал несколько способов обойти это, и обнаружил, что, похоже, проверяется только первый фрагмент, когда мы отправляем пакет Client Hello, разделенный на фрагменты. Чтобы обойти DPI, SpoofDPI отправляет на сервер первый 1 байт запроса, а затем отправляет все остальное. # Вдохновение -[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) от @SadeghHayeri +[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) от @SadeghHayeri [GoodbyeDPI](https://github.com/ValdikSS/GoodbyeDPI) от @ValdikSS diff --git a/_docs/README_zh-cn.md b/_docs/README_zh-cn.md index e2fa68d..7b5d4a3 100644 --- a/_docs/README_zh-cn.md +++ b/_docs/README_zh-cn.md @@ -10,52 +10,8 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) -# 安装 -## Binary - -SpoofDPI 会被安装在 `~/.spoof-dpi/bin` -要在其他目录下运行，请给 `~/.bashrc || ~/.zshrc || ...` 添加 - -``` -export PATH=$PATH:~/.spoof-dpi/bin -``` ---- -```bash -# macOS Intel -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64 - -# macOS Apple Silicon -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-arm64 - -# linux-amd64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-amd64 - -# linux-arm -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm - -# linux-arm64 -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-arm64 - -# linux-mips -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mips - -# linux-mipsle -curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle -``` - -## Go -也可以用 `go install` 安装 -```bash -$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest -``` - -## Git -You can also build your own -```bash -$ git clone https://github.com/xvzc/SpoofDPI.git -$ cd SpoofDPI -$ go build ./cmd/... -``` +# Installation +See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). # 使用方法 @@ -111,5 +67,5 @@ google-chrome --proxy-server="http://127.0.0.1:8080" # 启发 -[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) by @SadeghHayeri +[Green Tunnel](https://github.com/SadeghHayeri/GreenTunnel) by @SadeghHayeri [GoodbyeDPI](https://github.com/ValdikSS/GoodbyeDPI) by @ValdikSS