mirror of https://github.com/masterking32/MasterHttpRelayVPN.git synced 2026-05-18 06:24:35 +03:00

Files

T

Abolfazl 70bbcf217f Add comprehensive documentation for MasterHttpRelayVPN

- Introduced ARCHITECTURE.md to outline the system architecture and flow.
- Created CONFIGURATION.md detailing configuration options and their meanings.
- Added DOCKER.md for Docker setup instructions and usage.
- Developed GETTING_STARTED.md to guide users through initial setup and usage.
- Included LAN_SHARING.md to explain how to enable LAN sharing for the proxy.
- Established SECURITY.md to highlight security practices and responsibilities.
- Compiled TROUBLESHOOTING.md to assist users in resolving common issues.
- Translated documentation into Persian, including ARCHITECTURE.md and CONFIGURATION.md.

2026-05-09 05:01:08 +03:30

4.2 KiB

Raw Blame History

MasterHttpRelayVPN

Language: English | Persian / فارسی

MasterHttpRelayVPN is a local proxy that routes browser traffic through a Google Apps Script relay using domain fronting. The simple path needs only this project and a free Google account. For sites that block Google egress, you can optionally add an exit node later.

Browser -> Local proxy -> Google front -> Your Apps Script relay -> Target site
                         network filter sees a Google-facing connection

Choose Your Path

I want to...	Go here
Set it up for the first time	Getting Started
Run with Docker	Docker Guide
Share the proxy on my LAN	LAN Sharing
Use an exit node for blocked destinations	Exit Node Guide
Understand every config option	Configuration Reference
Fix a problem	Troubleshooting
Review safety notes	Security Notes
Understand the internals	Architecture

Fast Start

Before running the local proxy, deploy the Google relay from apps_script/Code.gs and keep two values ready:

Deployment ID from Google Apps Script
AUTH_KEY, a long secret that must match auth_key in your local config

Download the project with either Git or ZIP, then run the one-click launcher.

Option A: Git

git clone https://github.com/masterking32/MasterHttpRelayVPN.git
cd MasterHttpRelayVPN

Option B: ZIP

Open the GitHub repository.
Click Code -> Download ZIP.
Extract the ZIP file.
Open a terminal inside the extracted MasterHttpRelayVPN folder.

Then start the app:

Windows

start.bat

Linux / macOS

chmod +x start.sh
./start.sh

The launcher creates a virtual environment, installs dependencies, opens the setup wizard if config.json is missing, and starts the proxy.

After it starts, configure your browser to use:

Field	Value
Proxy type	HTTP
Address	`127.0.0.1`
Port	`8085`
SOCKS5 port, optional	`1080`

For HTTPS sites, install the generated certificate from ca/ca.crt if the app cannot install it automatically. The full setup is in Getting Started.

Common Next Steps

If the browser shows certificate warnings, open Troubleshooting.
If you see unauthorized, make sure AUTH_KEY in apps_script/Code.gs exactly matches auth_key in config.json.
If browsing is slow or connections time out, run python main.py --scan and see Configuration Reference.
If ChatGPT, Turnstile, or similar sites block the Google exit IP, use Exit Node Guide.

Support And Updates

Telegram channel: https://t.me/masterdnsvpn
Windows client: MHRWindowsApp
Ad blocker filter source: PersianBlocker

Safety

This project is provided for educational, testing, and research use. You are responsible for following applicable laws and service terms. Never share config.json, auth_key, ca/, or an exit-node URL together with a valid PSK. Read Security Notes before sharing the proxy with other devices.

License

MIT

4.2 KiB Raw Blame History