Skip to content

docs(README): update community helper section with details about mhrv… #1146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ardalan-ab wants to merge 2 commits into
base: main
Choose a base branch
from
+21 −0
Open

docs(README): update community helper section with details about mhrv… #1146

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30dea2b
docs(README): update community helper section with details about mhrv…
itsardalan007-afk May 13, 2026
0ecc414
change the Persian doc for better view
ardalan-ab May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
🇬🇧 [English Quick Start](#quick-start) · [Full Guide (advanced topics)](docs/guide.md)
🇮🇷 [راه‌اندازی سریع فارسی](#راه‌اندازی-سریع) · [راهنمای کامل (مباحث پیشرفته)](docs/guide.fa.md)

**Community helper (Chrome, optional):** [`github.com/ardalan-ab/mhrv-helper-extension`](https://github.com/ardalan-ab/mhrv-helper-extension) — maintained by [@ardalan-ab](https://github.com/ardalan-ab). Extension docs: [README (English)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/README.md) · [README (فارسی)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/README.fa.md). Usage: [HOW_TO_USE.md](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.md) · [HOW_TO_USE.fa.md](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.fa.md).

<p align="center" dir="rtl">
۱. <a href="https://www.youtube.com/watch?v=voCwxgvWR5U" target="_blank" rel="noopener noreferrer">راهنمای تصویری راه اندازی به زبان فارسی</a> (YouTube)
<br>
Expand All @@ -28,6 +30,12 @@
- 🖥️ **Works on** Mac, Windows, Linux, Android, OpenWRT routers
- 🦊 **Any browser or app** that supports HTTP proxy or SOCKS5

## Community helpers

Third-party tools are not required to run mhrv-rs; they are listed here for convenience.

- **[mhrv-helper-extension](https://github.com/ardalan-ab/mhrv-helper-extension)** — Chrome extension (Manifest V3) maintained by **[ardalan-ab](https://github.com/ardalan-ab)**. It helps with Apps Script setup: generate an `AUTH_KEY`, fetch or fall back to canonical `Code.gs`, and copy a `config.json` snippet. **Repository:** `https://github.com/ardalan-ab/mhrv-helper-extension` — [README (English)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/README.md) · [README (فارسی)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/README.fa.md) — [How to use (English)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.md) · [راهنمای استفاده (فارسی)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.fa.md).

## How it works (the simple picture)

```
Expand Down Expand Up @@ -74,6 +82,8 @@ ISPs can't read inside encrypted HTTPS. They only see the address — `www.googl
11. Google shows a **Deployment ID** (a long random string). **Copy it** — you'll need it in Step 3.

> **Tip:** if you ever update `Code.gs` later, don't make a new deployment. Edit the code, then go to **Deploy → Manage deployments → ✏️ → Version: New version → Deploy**. The Deployment ID stays the same.
>
> **Optional:** use the community [Chrome extension](https://github.com/ardalan-ab/mhrv-helper-extension) — see [How to use](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.md) (English) or [راهنمای فارسی](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.fa.md).

### Step 2 — Download mhrv-rs

Expand Down Expand Up @@ -190,6 +200,8 @@ Most of the Rust code in this port was written with [Anthropic's Claude](https:/
🇬🇧 [English Quick Start](#quick-start) · [Full Guide (advanced)](docs/guide.md)
🇮🇷 [راه‌اندازی سریع](#راه‌اندازی-سریع) · [راهنمای کامل (پیشرفته)](docs/guide.fa.md)

**ابزار جامعه (افزونهٔ کروم، اختیاری):** [`github.com/ardalan-ab/mhrv-helper-extension`](https://github.com/ardalan-ab/mhrv-helper-extension) — نگهداری [@ardalan-ab](https://github.com/ardalan-ab). مستندات افزونه: [README (فارسی)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/README.fa.md) · [README (English)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/README.md). راهنمای گام‌به‌گام: [HOW_TO_USE.fa.md](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.fa.md) · [HOW_TO_USE.md](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.md).

## چی به دست می‌آوری

- 🌐 **عبور از DPI / مسدودسازی SNI** با لبهٔ گوگل به‌عنوان رله
Expand All @@ -198,6 +210,13 @@ Most of the Rust code in this port was written with [Anthropic's Claude](https:/
- 🖥️ **روی** مک، ویندوز، لینوکس، اندروید، روتر OpenWRT کار می‌کند
- 🦊 **هر مرورگر یا برنامه‌ای** که از HTTP proxy یا SOCKS5 پشتیبانی کند

## ابزارهای جامعه

برای اجرای mhrv-rs به این ابزارها نیاز نیست؛ فقط برای راحتی اینجا آمده‌اند.
- افزونهٔ [mhrv-helper-extension](https://github.com/ardalan-ab/mhrv-helper-extension) — کروم (Manifest V3) با نگهداری [ardalan-ab](https://github.com/ardalan-ab) برای کمک در راه‌اندازی Apps Script: تولید AUTH_KEY، گرفتن یا fallback به Code.gs رسمی، و کپی قطعهٔ config.json.
- مخزن: https://github.com/ardalan-ab/mhrv-helper-extension
- خواندن [README (فارسی)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/README.fa.md) · [README (English)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/README.md)
- راهنمای [استفاده (فارسی)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.fa.md) · [How to use (English)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.md)
## چطور کار می‌کند (تصویر ساده)

```
Expand Down Expand Up @@ -244,6 +263,8 @@ ISP داخل HTTPS رمزشده را نمی‌تواند بخواند. فقط آ
۱۱. گوگل یک **Deployment ID** نشانت می‌دهد (یک رشتهٔ تصادفی طولانی). **کپی‌اش کن** — در مرحلهٔ ۳ لازم داری.

> **نکته:** اگر بعداً `Code.gs` را به‌روزرسانی کنی، Deployment جدید نساز. کد را ویرایش کن، بعد **Deploy → Manage deployments → ✏️ → Version: New version → Deploy**. Deployment ID همان قبلی می‌ماند.
>
> **اختیاری:** افزونهٔ اختیاری کروم [mhrv-helper-extension](https://github.com/ardalan-ab/mhrv-helper-extension) — [راهنمای فارسی](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.fa.md) · [How to use (English)](https://github.com/ardalan-ab/mhrv-helper-extension/blob/main/HOW_TO_USE.md).

### مرحلهٔ ۲ — دانلود mhrv-rs

Expand Down
Loading