Skip to content

Commit 33b0966

Browse files
abolixabolix
committed
Enhance README and Persian documentation with additional details on legal disclaimers, user responsibilities, and security warnings
1 parent 7739acc commit 33b0966

2 files changed

Lines changed: 54 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,48 @@
22

33
[![GitHub](https://img.shields.io/badge/GitHub-MasterHttpRelayVPN-blue?logo=github)](https://github.com/masterking32/MasterHttpRelayVPN) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/masterking32/MasterHttpRelayVPN) [![oosmetrics](https://api.oosmetrics.com/api/v1/badge/achievement/85a1f608-5c6d-4fcd-9b7f-b1ff8b680852.svg)](https://oosmetrics.com/repo/masterking32/MasterHttpRelayVPN) [![oosmetrics](https://api.oosmetrics.com/api/v1/badge/achievement/de9bee73-bc68-4f98-ba83-6957007046b1.svg)](https://oosmetrics.com/repo/masterking32/MasterHttpRelayVPN)
44

5+
>**Youtube safe search** and **live streaming** are now **Bypassed & Working** by default. so you don't need `youtube_via_relay` or Cloudflare / VPS `exit_node` for it.
6+
7+
58
**Language:** English | [Persian / فارسی](README_FA.md)
69

7-
**Telegram Channel 📣:** [https://t.me/masterdnsvpn](https://t.me/masterdnsvpn)
10+
> نسخه فارسی با AI ایجاد شده. ترجیحا از نسخه انگلیسی استفاده کنید.
11+
12+
**Telegram Channel 📣:** [https://t.me/MasterDnsVPN](https://t.me/MasterDnsVPN) | @MasterDnsVPN
13+
14+
**Telegram Group 📣:** [https://t.me/MasterDnsVPNGroup](https://t.me/MasterDnsVPNGroup) | @MasterDnsVPNGroup
815

9-
**Special Thanks ❤️:** [Abolix](https://github.com/abolix)
16+
17+
**❤️ Special Thanks to** [Abolix](https://github.com/abolix) for making this project possible and maintaining it.
1018

1119
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.
1220

21+
We mainly use MITM (Man in the Middle) and Domain Fronting techniques.
22+
1323
```text
1424
Browser -> Local proxy -> Google front -> Your Apps Script relay -> Target site
1525
network filter sees a Google-facing connection
1626
```
1727

1828
## Quick Menu 🧭
1929

20-
[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)
30+
Click the links below for guides on common topics.
31+
32+
[Getting Started](docs/GETTING_STARTED.md) : How to set up the proxy and deploy the Google relay.
33+
34+
[Exit Node](docs/exit-node/EXIT_NODE_DEPLOYMENT.md) : Connect to Cloudflare Workers or a VPS for destinations to fix ChatGPT, Turnstile, and similar sites blocking Google IPs.
2135

22-
[Configuration](docs/CONFIGURATION.md) | [Troubleshooting](docs/TROUBLESHOOTING.md) | [Security](docs/SECURITY.md) | [Architecture](docs/ARCHITECTURE.md)
36+
[LAN Sharing](docs/LAN_SHARING.md) : Share the proxy with other devices on your local network.
37+
38+
[Configuration](docs/CONFIGURATION.md) : Reference for all config options, plus diagnostic commands.
39+
40+
[Security](docs/SECURITY.md) : Important notes on safely using and sharing the proxy.
41+
42+
[Troubleshooting](docs/TROUBLESHOOTING.md) : Common issues and how to resolve them.
43+
44+
[Docker](docs/DOCKER.md) : Instructions for running the proxy in a Docker container.
45+
46+
[Architecture](docs/ARCHITECTURE.md) : Overview of the system design and components.
2347

2448
## Fast Start ⚡
2549

@@ -47,7 +71,7 @@ Keep these two values ready for the setup wizard:
4771
- `Deployment ID` from Google Apps Script
4872
- `AUTH_KEY`, a long secret that must match `auth_key` in your local config
4973

50-
If you want screenshots and more detail, use [Getting Started](docs/GETTING_STARTED.md#2-deploy-the-google-relay).
74+
If you want more detail, use [Getting Started](docs/GETTING_STARTED.md#2-deploy-the-google-relay).
5175

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

@@ -89,27 +113,36 @@ After it starts, configure your browser to use:
89113
| Proxy type | HTTP |
90114
| Address | `127.0.0.1` |
91115
| Port | `8085` |
92-
| SOCKS5 port, optional | `1080` |
116+
| SOCKS5 port | `1080` |
117+
118+
After starting, CA will be installed automatically.
93119

94-
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).
120+
You can use telegram as : https://t.me/socks?server=127.0.0.1&port=1080 or if you are using PC client, you can add HTTP proxy with manually.
95121

96122
## Common Next Steps 🛠️
97123

98124
- If the browser shows certificate warnings, open [Troubleshooting](docs/TROUBLESHOOTING.md#certificate-errors).
99125
- If you see `unauthorized`, make sure `AUTH_KEY` in [apps_script/Code.gs](apps_script/Code.gs) exactly matches `auth_key` in `config.json`.
100-
- If browsing is slow or connections time out, run `python main.py --scan` and see [Configuration Reference](docs/CONFIGURATION.md#diagnostic-commands).
101126
- If ChatGPT, Turnstile, or similar sites block the Google exit IP, use [Exit Node Guide](docs/exit-node/EXIT_NODE_DEPLOYMENT.md).
102127

103128
## Support And Updates 📣
104129

105-
- Telegram channel: [https://t.me/masterdnsvpn](https://t.me/masterdnsvpn)
106-
- Windows client: [MHRWindowsApp](https://github.com/AriPath/MHRWindowsApp)
130+
- Telegram channel: [https://t.me/MasterDnsVPN](https://t.me/MasterDnsVPN)
131+
- Telegram group: [https://t.me/MasterDnsVPNGroup](https://t.me/MasterDnsVPNGroup)
132+
- Windows client (3rd party): [MHRWindowsApp](https://github.com/AriPath/MHRWindowsApp)
107133
- Ad blocker filter source: [PersianBlocker](https://github.com/MasterKia/PersianBlocker/)
108134

109135
## Safety 🔒
110136

111137
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.
112138

139+
## Legal Disclaimer ⚠️
140+
141+
- **Limitation of liability:** Developers and contributors are not responsible for direct, indirect, incidental, consequential, or other damages resulting from use of this project or inability to use it.
142+
- **User responsibility:** Running this project outside controlled environments may affect networks, accounts, proxies, certificates, or connected systems. You are solely responsible for installation, configuration, and usage.
143+
- **Legal compliance:** You are responsible for complying with all applicable local, national, and international laws and regulations before using this software.
144+
- **Google services compliance:** If you use Google Apps Script or other Google services, you are responsible for complying with Google's Terms of Service, acceptable use rules, quotas, and platform policies. Misuse can lead to suspension or termination of accounts or deployments.
145+
113146
## License
114147
115148
MIT

‎README_FA.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,17 @@ chmod +x start.sh
107107

108108
این پروژه برای آموزش، تست و پژوهش ارائه شده است. مسئولیت رعایت قوانین و شرایط سرویس‌ها با کاربر است. فایل `config.json`، مقدار `auth_key`، پوشه `ca/`، و آدرس Exit Node همراه با PSK معتبر را با کسی به اشتراک نگذارید. قبل از فعال کردن استفاده در شبکه محلی، [نکات امنیتی](docs/fa/SECURITY.md) را بخوانید.
109109

110+
## سلب مسئولیت قانونی ⚠️
111+
112+
MasterHttpRelayVPN فقط برای آموزش، تست و پژوهش ارائه شده است.
113+
114+
- **محدودیت مسئولیت:** توسعه‌دهنده‌ها و مشارکت‌کننده‌ها در قبال هرگونه خسارت مستقیم، غیرمستقیم، اتفاقی، تبعی، یا هر نوع خسارت دیگر ناشی از استفاده یا عدم امکان استفاده از این پروژه مسئول نیستند.
115+
- **مسئولیت کاربر:** اجرای این پروژه خارج از محیط کنترل‌شده ممکن است روی شبکه، اکانت‌ها، پراکسی‌ها، گواهی‌ها، یا سیستم‌های متصل اثر بگذارد. مسئولیت کامل نصب، پیکربندی، و استفاده با خود کاربر است.
116+
- **رعایت قوانین:** قبل از استفاده از این نرم‌افزار، رعایت همه قوانین و مقررات محلی، ملی، و بین‌المللی بر عهده کاربر است.
117+
- **رعایت قوانین Google:** اگر از Google Apps Script یا دیگر سرویس‌های Google استفاده می‌کنید، رعایت Terms of Service، قوانین استفاده، سهمیه‌ها (quota)، و سیاست‌های پلتفرم Google بر عهده شماست. استفاده نادرست ممکن است باعث تعلیق یا مسدود شدن اکانت یا deployment شود.
118+
- **هشدار TLS/CA:** در حالت Apps Script، ترافیک HTTPS به‌صورت محلی decrypt و دوباره encrypt می‌شود. برای جلوگیری از خطاهای امنیتی مرورگر، باید گواهی CA تولیدشده را نصب کنید.
119+
- **هشدار LAN:** وقتی LAN sharing فعال است، دستگاه‌های شبکه محلی می‌توانند از پراکسی شما استفاده کنند. این قابلیت را فقط روی شبکه‌های قابل اعتماد فعال کنید و در صورت نیاز لایه‌های امنیتی اضافه بگذارید.
120+
110121
## License
111122

112123
MIT

0 commit comments

Comments
 (0)