diff --git a/README.md b/README.md index 400e0f0..c676142 100644 --- a/README.md +++ b/README.md @@ -11,26 +11,40 @@ Browser -> Local proxy -> Google front -> Your Apps Script relay -> Target site network filter sees a Google-facing connection ``` -## Choose Your Path +## Quick Menu -| I want to... | Go here | -|-------------|---------| -| Set it up for the first time | [Getting Started](docs/GETTING_STARTED.md) | -| Run with Docker | [Docker Guide](docs/DOCKER.md) | -| Share the proxy on my LAN | [LAN Sharing](docs/LAN_SHARING.md) | -| Use an exit node for blocked destinations | [Exit Node Guide](docs/exit-node/EXIT_NODE_DEPLOYMENT.md) | -| Understand every config option | [Configuration Reference](docs/CONFIGURATION.md) | -| Fix a problem | [Troubleshooting](docs/TROUBLESHOOTING.md) | -| Review safety notes | [Security Notes](docs/SECURITY.md) | -| Understand the internals | [Architecture](docs/ARCHITECTURE.md) | +[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 -Before running the local proxy, deploy the Google relay from [apps_script/Code.gs](apps_script/Code.gs) and keep two values ready: +Before running the local proxy, deploy the Google relay once. You only need a Google account and about two minutes. + +## Deploy The Google Relay + +1. Open [Google Apps Script](https://script.google.com/) and sign in. +2. Click **New project**. +3. Delete the default editor content. +4. Open [apps_script/Code.gs](apps_script/Code.gs), copy everything, and paste it into Apps Script. +5. Find this line and replace it with your own long secret: + + ```javascript + const AUTH_KEY = "your-secret-password-here"; + ``` + +6. Click **Deploy** -> **New deployment** -> **Web app**. +7. Set **Execute as** to **Me**. +8. Set **Who has access** to **Anyone**. +9. Click **Deploy**, approve the permission screen, and copy the **Deployment ID**. + +Keep these two values ready for the setup wizard: - `Deployment ID` from Google Apps Script - `AUTH_KEY`, a long secret that must match `auth_key` in your local config +If you want screenshots and more detail, use [Getting Started](docs/GETTING_STARTED.md#2-deploy-the-google-relay). + Download the project with either Git or ZIP, then run the one-click launcher. **Option A: Git** diff --git a/README_FA.md b/README_FA.md index 8e07703..e5ca626 100644 --- a/README_FA.md +++ b/README_FA.md @@ -9,26 +9,40 @@ MasterHttpRelayVPN یک پراکسی محلی است که ترافیک مرور فیلتر فقط اتصال شبیه Google را می‌بیند ``` -## مسیر موردنیازتان را انتخاب کنید +## منوی سریع -| می‌خواهید... | اینجا را بخوانید | -|-------------|------------------| -| برای اولین بار راه‌اندازی کنید | [شروع سریع](docs/fa/GETTING_STARTED.md) | -| با Docker اجرا کنید | [راهنمای Docker](docs/fa/DOCKER.md) | -| پراکسی را در شبکه محلی به اشتراک بگذارید | [اشتراک‌گذاری LAN](docs/fa/LAN_SHARING.md) | -| برای سایت‌های حساس Exit Node بگذارید | [راهنمای Exit Node](docs/exit-node/EXIT_NODE_DEPLOYMENT_FA.md) | -| همه تنظیمات را بفهمید | [مرجع تنظیمات](docs/fa/CONFIGURATION.md) | -| مشکلی را رفع کنید | [رفع مشکل](docs/fa/TROUBLESHOOTING.md) | -| نکات امنیتی را ببینید | [نکات امنیتی](docs/fa/SECURITY.md) | -| معماری و فایل‌ها را بشناسید | [معماری](docs/fa/ARCHITECTURE.md) | +[شروع سریع](docs/fa/GETTING_STARTED.md) | [Docker](docs/fa/DOCKER.md) | [اشتراک گذاری LAN](docs/fa/LAN_SHARING.md) | [راهنمای Exit Node](docs/exit-node/EXIT_NODE_DEPLOYMENT_FA.md) + +[مرجع تنظیمات](docs/fa/CONFIGURATION.md) | [رفع مشکل](docs/fa/TROUBLESHOOTING.md) | [نکات امنیتی](docs/fa/SECURITY.md) | [معماری](docs/fa/ARCHITECTURE.md) ## شروع خیلی سریع -قبل از اجرای پراکسی، رله Google را از فایل [apps_script/Code.gs](apps_script/Code.gs) در Google Apps Script deploy کنید و این دو مقدار را آماده داشته باشید: +قبل از اجرای پراکسی، باید یک بار رله Google را deploy کنید. فقط یک اکانت Google لازم دارید و این کار حدود دو دقیقه زمان می‌برد. + +## ساخت رله Google + +1. وارد [Google Apps Script](https://script.google.com/) شوید. +2. روی **New project** کلیک کنید. +3. محتوای پیش‌فرض ادیتور را کامل پاک کنید. +4. فایل [apps_script/Code.gs](apps_script/Code.gs) را باز کنید، همه کد آن را کپی کنید، و داخل Apps Script قرار دهید. +5. این خط را پیدا کنید و با یک رمز طولانی و مخصوص خودتان عوض کنید: + + ```javascript + const AUTH_KEY = "your-secret-password-here"; + ``` + +6. از مسیر **Deploy** -> **New deployment** -> **Web app** بروید. +7. گزینه **Execute as** را روی **Me** بگذارید. +8. گزینه **Who has access** را روی **Anyone** بگذارید. +9. روی **Deploy** کلیک کنید، دسترسی‌ها را تایید کنید، و **Deployment ID** را کپی کنید. + +این دو مقدار را برای setup wizard نگه دارید: - `Deployment ID` از Google Apps Script - `AUTH_KEY`، یک رمز طولانی که باید دقیقا با `auth_key` در کانفیگ محلی یکی باشد +اگر توضیح کامل‌تر می‌خواهید، [شروع سریع](docs/fa/GETTING_STARTED.md#2-ساخت-رله-google) را ببینید. + پروژه را با Git یا ZIP دریافت کنید، سپس لانچر یک‌کلیکی را اجرا کنید. **گزینه A: Git**