Skip to content

Commit 146eb88

Browse files
yyoyoian-pixelclaude
authored andcommitted
docs(readme): add Full Tunnel mode section
The main README had no mention of Full Tunnel mode beyond passing references in the FAQ. Add a dedicated section between "How it works" and "Quick Start" that explains what Full Tunnel is, why you'd use it (YouTube, UDP, quota), the architecture diagram, and what you need to set it up. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent d53399d commit 146eb88

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,49 @@
4545

4646
ISPs can't read inside encrypted HTTPS. They only see the address — `www.google.com`. The actual page lookup happens inside Google's network, hidden in the encrypted tunnel.
4747

48+
### Full Tunnel mode
49+
50+
The default **apps_script** mode relays each HTTP request through Google. This works great for browsing, but has limits: YouTube video chunks are blocked by Google internally, UDP protocols (Telegram voice, gaming) can't pass through, and every request counts against your daily Apps Script quota.
51+
52+
**Full Tunnel mode** removes those limits by adding a small relay server (tunnel-node) on a VPS you control:
53+
54+
```
55+
you → browser → mhrv-rs ──┐
56+
│ ISP only sees: www.google.com
57+
58+
Google's network
59+
60+
61+
Apps Script forwards to your VPS
62+
63+
64+
tunnel-node (your VPS)
65+
66+
67+
real TCP connection to any site
68+
```
69+
70+
Every TCP connection from your device is tunneled end-to-end: mhrv-rs multiplexes all your traffic into batched requests through Apps Script, your tunnel-node opens real TCP sockets to the destination. YouTube, Telegram, WebSockets, anything TCP — it all works.
71+
72+
**What you need:**
73+
- Everything from the Quick Start (Apps Script + auth key)
74+
- A VPS with a public IP (any cheap $5/mo provider works)
75+
- Deploy [`CodeFull.gs`](assets/apps_script/CodeFull.gs) instead of `Code.gs`
76+
- Deploy the [tunnel-node](tunnel-node/) on your VPS (Docker one-liner)
77+
78+
**In your config:**
79+
```json
80+
{
81+
"mode": "full",
82+
"script_ids": ["your-deployment-id"],
83+
"auth_key": "your-secret"
84+
}
85+
```
86+
87+
No certificate installation needed — Full Tunnel doesn't MITM your TLS. The tunnel-node handles real connections server-side.
88+
89+
For step-by-step setup, see the [tunnel-node README](tunnel-node/README.md).
90+
4891
## Quick Start
4992

5093
**About 5 minutes.** You need:

0 commit comments

Comments
 (0)