mirror of
https://github.com/masterking32/MasterHttpRelayVPN.git
synced 2026-05-17 21:24:37 +03:00
Enhance README and documentation with Telegram channel and acknowledgments, improve formatting and clarity
This commit is contained in:
@@ -4,6 +4,10 @@
|
||||
|
||||
**Language:** English | [Persian / فارسی](README_FA.md)
|
||||
|
||||
**Telegram Channel 📣:** [https://t.me/masterdnsvpn](https://t.me/masterdnsvpn)
|
||||
|
||||
**Special Thanks ❤️:** [Abolix](https://github.com/abolix)
|
||||
|
||||
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.
|
||||
|
||||
```text
|
||||
@@ -11,17 +15,17 @@ Browser -> Local proxy -> Google front -> Your Apps Script relay -> Target site
|
||||
network filter sees a Google-facing connection
|
||||
```
|
||||
|
||||
## Quick Menu
|
||||
## Quick Menu 🧭
|
||||
|
||||
[Getting Started](docs/GETTING_STARTED.md) | [Docker](docs/DOCKER.md) | [LAN Sharing](docs/LAN_SHARING.md) | [Exit Node](docs/exit-node/EXIT_NODE_DEPLOYMENT.md)
|
||||
|
||||
[Configuration](docs/CONFIGURATION.md) | [Troubleshooting](docs/TROUBLESHOOTING.md) | [Security](docs/SECURITY.md) | [Architecture](docs/ARCHITECTURE.md)
|
||||
|
||||
## Fast Start
|
||||
## Fast Start ⚡
|
||||
|
||||
Before running the local proxy, deploy the Google relay once. You only need a Google account and about two minutes.
|
||||
|
||||
## Deploy The Google Relay
|
||||
## Deploy The Google Relay ☁️
|
||||
|
||||
1. Open [Google Apps Script](https://script.google.com/) and sign in.
|
||||
2. Click **New project**.
|
||||
@@ -89,20 +93,20 @@ After it starts, configure your browser to use:
|
||||
|
||||
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](docs/GETTING_STARTED.md).
|
||||
|
||||
## Common Next Steps
|
||||
## Common Next Steps 🛠️
|
||||
|
||||
- If the browser shows certificate warnings, open [Troubleshooting](docs/TROUBLESHOOTING.md#certificate-errors).
|
||||
- If you see `unauthorized`, make sure `AUTH_KEY` in [apps_script/Code.gs](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](docs/CONFIGURATION.md#diagnostic-commands).
|
||||
- If ChatGPT, Turnstile, or similar sites block the Google exit IP, use [Exit Node Guide](docs/exit-node/EXIT_NODE_DEPLOYMENT.md).
|
||||
|
||||
## Support And Updates
|
||||
## Support And Updates 📣
|
||||
|
||||
- Telegram channel: [https://t.me/masterdnsvpn](https://t.me/masterdnsvpn)
|
||||
- Windows client: [MHRWindowsApp](https://github.com/AriPath/MHRWindowsApp)
|
||||
- Ad blocker filter source: [PersianBlocker](https://github.com/MasterKia/PersianBlocker/)
|
||||
|
||||
## Safety
|
||||
## 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](docs/SECURITY.md) before sharing the proxy with other devices.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user