mirror of
https://github.com/masterking32/MasterHttpRelayVPN.git
synced 2026-05-17 21:24:37 +03:00
Merge pull request #6 from ramzxy/simplify-install
Add one-click launcher and interactive setup wizard
This commit is contained in:
@@ -45,12 +45,42 @@ This means the filter sees normal-looking Google traffic, while the actual desti
|
||||
|
||||
---
|
||||
|
||||
## Step-by-Step Setup Guide
|
||||
## Quick Start (Recommended)
|
||||
|
||||
One command sets up a virtualenv, installs dependencies, launches an interactive
|
||||
config wizard, and starts the proxy.
|
||||
|
||||
**Windows:**
|
||||
```cmd
|
||||
git clone https://github.com/masterking32/MasterHttpRelayVPN.git
|
||||
cd MasterHttpRelayVPN
|
||||
start.bat
|
||||
```
|
||||
|
||||
**Linux / macOS:**
|
||||
```bash
|
||||
git clone https://github.com/masterking32/MasterHttpRelayVPN.git
|
||||
cd MasterHttpRelayVPN
|
||||
chmod +x start.sh
|
||||
./start.sh
|
||||
```
|
||||
|
||||
The first time it runs, the wizard asks for your Google Apps Script Deployment ID
|
||||
and generates a strong random password for you. Follow the Apps Script deployment
|
||||
instructions in **Step 2** below before running the wizard so you have a
|
||||
Deployment ID ready.
|
||||
|
||||
After it's running, jump to **Step 5** (browser proxy) and **Step 6** (CA
|
||||
certificate).
|
||||
|
||||
---
|
||||
|
||||
## Step-by-Step Setup Guide (Manual)
|
||||
|
||||
### Step 1: Download This Project
|
||||
|
||||
```bash
|
||||
git clone -b python_testing https://github.com/masterking32/MasterHttpRelayVPN.git
|
||||
git clone https://github.com/masterking32/MasterHttpRelayVPN.git
|
||||
cd MasterHttpRelayVPN
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
@@ -60,7 +90,7 @@ pip install -r requirements.txt
|
||||
> pip install -r requirements.txt -i https://mirror-pypi.runflare.com/simple/ --trusted-host mirror-pypi.runflare.com
|
||||
> ```
|
||||
|
||||
Or download the ZIP from [GitHub](https://github.com/masterking32/MasterHttpRelayVPN/tree/python_testing) and extract it.
|
||||
Or download the ZIP from [GitHub](https://github.com/masterking32/MasterHttpRelayVPN) and extract it.
|
||||
|
||||
### Step 2: Set Up the Google Relay (Code.gs)
|
||||
|
||||
@@ -86,6 +116,15 @@ This is the "relay" that sits on Google's servers and fetches websites for you.
|
||||
|
||||
### Step 3: Configure
|
||||
|
||||
**Option A — interactive wizard (recommended):**
|
||||
```bash
|
||||
python setup.py
|
||||
```
|
||||
It'll prompt for your Deployment ID, generate a random `auth_key`, and write
|
||||
`config.json` for you.
|
||||
|
||||
**Option B — manual:**
|
||||
|
||||
1. Copy the example config file:
|
||||
```bash
|
||||
cp config.example.json config.json
|
||||
@@ -298,8 +337,10 @@ python3 main.py --no-cert-check # Skip automatic CA install check on st
|
||||
```
|
||||
MasterHttpRelayVPN/
|
||||
├── main.py # Entry point: starts the proxy
|
||||
├── setup.py # Interactive wizard — writes config.json
|
||||
├── start.bat / start.sh # One-click launcher (venv + deps + wizard + run)
|
||||
├── config.example.json # Copy to config.json and fill in your values
|
||||
├── requirements.txt # Optional Python dependencies
|
||||
├── requirements.txt # Python dependencies
|
||||
├── apps_script/
|
||||
│ └── Code.gs # The relay script you deploy to Google Apps Script
|
||||
├── ca/ # Generated MITM CA (do NOT share)
|
||||
|
||||
Reference in New Issue
Block a user