docs: vendor the documentation site into the monorepo

Fold the standalone 3x-ui-docs project (Next.js 16 + Fumadocs, deployed to docs.sanaei.dev) into docs/ so the panel and its documentation share a single source of truth, the way sing-box keeps its docs in-tree. The old repo becomes redundant and can be retired. - Import the full site under docs/ (app, components, content, lib, public, scripts, config). The self-contained pnpm project sits alongside the existing engineering notes with no filename collisions. - Re-point "Edit on GitHub" links from MHSanaei/3x-ui-docs to this repo's docs/content/docs path (docs/lib/shared.ts, docs/app/.../page.tsx). - Add docs-ci.yml and docs-deploy.yml under .github/workflows/, scoped to docs/** and run with working-directory: docs, since GitHub only runs workflows from the repo-root .github/. deploy-static.yml's GitHub Pages publish (CNAME docs.sanaei.dev) carries over unchanged. Follow-up (outside this commit): attach the docs.sanaei.dev custom domain to this repository's Pages (or set the Vercel project's root directory to docs), confirm the site is live from the monorepo, then delete MHSanaei/3x-ui-docs.
2026-10-21 13:25:00 +03:00 · 2026-07-07 23:07:14 +02:00
parent 2c49dbf54e
commit 9b91f0f42e
283 changed files with 44179 additions and 0 deletions
@@ -0,0 +1,67 @@
+---
+title: کلاینت‌ها
+description: مدیریت کلاینت‌های 3x-ui — اعتبارنامه‌ها، محدودیت ترافیک و انقضا، محدودیت IP، گروه‌ها، اقدامات گروهی، لینک‌های خارجی و وضعیت آنلاین.
+icon: Users
+---
+
+یک **کلاینت** یک کاربر منفرد است که با یک **ایمیل** یکتا شناسایی می‌شود. در پنل
+فعلی، کلاینت‌ها رکوردهای درجه‌یک هستند که می‌توانند هم‌زمان به **چندین ورودی**
+متصل شوند و حساب‌داری ترافیک به‌صورت جداگانه برای هر کلاینت انجام می‌شود.
+
+## فیلدهای کلاینت
+
+| فیلد           | اعمال بر               | معنی                                                               |
+| -------------- | --------------------- | ------------------------------------------------------------------ |
+| **Email**      | همه                   | شناسه‌ی یکتا که برای حساب‌داری و جست‌وجوها استفاده می‌شود.          |
+| **ID (UUID)**  | VLESS, VMess          | اعتبارنامه‌ی کلاینت.                                                |
+| **Password**   | Trojan, Shadowsocks   | اعتبارنامه‌ی کلاینت.                                                |
+| **Auth**       | Hysteria2             | اعتبارنامه‌ی کلاینت.                                                |
+| **Flow**       | VLESS                 | جریان XTLS، برای مثال `xtls-rprx-vision`.                          |
+| **Limit IP**   | همه                   | بیشینه‌ی تعداد IPهای مبدأ هم‌زمان (با Fail2ban اعمال می‌شود).       |
+| **Total (GB)** | همه                   | سهمیه‌ی ترافیک؛ هنگام اتمام، کلاینت غیرفعال می‌شود.                |
+| **Expiry**     | همه                   | تاریخی که پس از آن کلاینت از کار می‌افتد.                          |
+| **Reset**      | همه                   | دوره‌ی تمدید خودکار به **روز** (سهمیه را از نو می‌چرخاند).          |
+| **Telegram ID**| همه                   | کلاینت را به یک کاربر Telegram برای سلف‌سرویس/اعلان‌ها پیوند می‌دهد.|
+| **Sub ID**     | همه                   | شناسه‌ی اشتراک که لینک‌های این کلاینت را گروه‌بندی می‌کند.          |
+| **Group**      | همه                   | گروه اختیاری کلاینت برای سازمان‌دهی و فیلترکردن گروهی.             |
+| **Comment**    | همه                   | یادداشت متنی آزاد.                                                 |
+
+<Callout type="info">
+  رسیدن به محدودیت **ترافیک** یا **انقضا** کلاینت را غیرفعال می‌کند؛ پنل می‌تواند
+  هنگام غیرفعال‌شدن خودکار کلاینت‌ها، Xray را به‌صورت خودکار راه‌اندازی مجدد کند
+  (`restartXrayOnClientDisable`، به‌صورت پیش‌فرض فعال).
+</Callout>
+
+## محدودیت‌ها و کنترل IP
+
+- سقف‌های **ترافیک / انقضا** هنگام رسیدن، کلاینت را غیرفعال می‌کنند؛ یک دوره‌ی
+  **Reset** سهمیه را به‌صورت خودکار تمدید می‌کند.
+- **Limit IP** تعداد IPهای مبدأ هم‌زمان را محدود می‌کند. اعمال آن به Fail2ban متکی
+  است — به [امنیت](/docs/operations/security) مراجعه کنید. می‌توانید IPهای اخیر یک
+  کلاینت را مشاهده کرده و آن‌ها را از بخش اقدامات کلاینت پاک کنید.
+- **وضعیت آنلاین** و زمان‌های **آخرین‌بار آنلاین** برای هر کلاینت (و در پیکربندی‌های
+  چندنودی برای هر نود) ثبت می‌شوند.
+
+## لینک‌های اشتراک‌گذاری و لینک‌های خارجی
+
+هر کلاینت برای ورودی‌هایش لینک‌های اشتراک‌گذاری و یک کد QR دارد، به‌علاوه‌ی یک
+[اشتراک](/docs/config/subscription) ترکیبی. همچنین می‌توانید **لینک‌های خارجی** به
+یک کلاینت متصل کنید — لینک‌های اضافی `vless://`، `vmess://`، `trojan://`، `ss://`،
+`hysteria2://` یا `wireguard://`، یا یک URL اشتراک از راه دور — تا در کنار
+لینک‌های تولیدشده توسط پنل، در اشتراک کلاینت نمایش داده شوند.
+
+برای بررسی دقیق محتویات یک لینک، آن را در
+[بازرس لینک اشتراک‌گذاری](/docs/config/share-links) جای‌گذاری کنید.
+
+## اقدامات گروهی
+
+برای مدیریت هم‌زمان تعداد زیادی کلاینت، پنل از اقدامات گروهی **ساخت، فعال‌سازی،
+غیرفعال‌سازی، حذف، اتصال/قطع اتصال** (به ورودی‌ها)، **بازنشانی ترافیک** و
+**تنظیم** (افزودن روز / افزودن بایت / تعیین flow) پشتیبانی می‌کند. اقدامات
+نگه‌داری همچنین به شما امکان می‌دهند کلاینت‌های **تمام‌شده** (سهمیه/انقضای پایان‌یافته)
+و کلاینت‌های **یتیم** (متصل‌نشده به هیچ ورودی) را حذف کنید.
+
+<Callout type="warn">
+  لینک اشتراک‌گذاری یک کلاینت حاوی اعتبارنامه‌ی آن است. با لینک‌ها و کدهای QR مانند
+  رمز عبور رفتار کنید و در صورت نشت یکی از آن‌ها، اعتبارنامه را تعویض کنید.
+</Callout>