docs: update installation guide

This commit is contained in:
xvzc 2024-08-30 17:02:03 +09:00
parent 8a252f4df9
commit 53f06aa80a
7 changed files with 36 additions and 27 deletions

View File

@ -9,7 +9,7 @@ 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) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md). See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md).
# Usage # Usage
``` ```

11
_docs/BUILD.md Normal file
View File

@ -0,0 +1,11 @@
# Building from Source
Although pre-built binaries are available for multiple platforms, you can also build your own binaries on your need.
## Prerequisites
1. Ensure you've installed go version `1.21`
2. Clone this repository to a location of your choice.
## Build
```bash
CGO_ENABLED=0 go build -ldflags="-w -s" ./cmd/...
```

View File

@ -1,12 +1,18 @@
# Quick Start # Installation Guide
<!--ts-->
* [Binary](#binary)
* [Go](#go)
* [Package Manager](#package-manager)
* [brew(MacOS)](#brew(MacOS))
* [pkg(FreeBSD)](#pkg(freebsd))
<!--te-->
## Binary # Binary
SpoofDPI will be installed in `~/.spoofdpi/bin`. SpoofDPI will be installed in `~/.spoofdpi/bin`.
To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...` To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...`
```bash ```bash
export PATH=$PATH:~/.spoofdpi/bin export PATH=$PATH:~/.spoofdpi/bin
``` ```
---
```bash ```bash
# macOS Intel # macOS Intel
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64 curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s darwin-amd64
@ -30,29 +36,21 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas
curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle
``` ```
## FreeBSD 😈 # Go
```
# Build from ports tree
make -C /usr/ports/net/spoofdpi install clean
# Install the package
pkg install spoofdpi
```
## Homebrew 🍻
```bash
brew install spoofdpi
```
## Go
You can also install SpoofDPI with `go install`.
```bash ```bash
go install github.com/xvzc/SpoofDPI/cmd/spoofdpi@latest go install github.com/xvzc/SpoofDPI/cmd/spoofdpi@latest
``` ```
## How to build # Package Manager
## brew(MacOS)
```bash ```bash
git clone https://github.com/xvzc/SpoofDPI.git brew install spoofdpi
cd SpoofDPI
go build ./cmd/...
``` ```
## pkg(FreeBSD)
```bash
pkg install spoofdpi
```

View File

@ -9,7 +9,7 @@
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md). See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md).
# 使用方法 # 使用方法
``` ```

View File

@ -9,7 +9,7 @@ DPI(Deep Packet Inspection) 우회를 위해 고안된 소프트웨어
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md)를 참고바랍니다. SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md)를 참고바랍니다.
# 사용법 # 사용법
``` ```

View File

@ -9,7 +9,7 @@
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
Инструкции по установке SpoofDPI вы можете найти [здесь](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md). Инструкции по установке SpoofDPI вы можете найти [здесь](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md).
# Использование # Использование
``` ```

View File

@ -11,7 +11,7 @@
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md). See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md).
# 使用方法 # 使用方法