mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-10-30 17:55:00 +03:00
MHSanaei
9b91f0f42e
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.
74 lines
4.7 KiB
Plaintext
74 lines
4.7 KiB
Plaintext
---
|
|
title: آشنایی با 3x-ui
|
|
description: یک پنل تحت وب برای Xray-core — ورودی‌ها، پروتکل‌ها، کلاینت‌ها و اشتراک‌ها را به‌جای ویرایش دستی JSON، از مرورگر خود مدیریت کنید.
|
|
icon: Info
|
|
---
|
|
|
|
**3x-ui** یک پنل کنترل تحت وب است که روی
|
|
[Xray-core](https://github.com/XTLS/Xray-core)، همان موتور پروکسی که در واقع
|
|
ترافیک شما را جابه‌جا می‌کند، قرار می‌گیرد. به‌جای نوشتن و بارگذاری مجدد پیکربندی
|
|
JSON Xray به‌صورت دستی، همه‌چیز — ورودی‌ها، پروتکل‌ها، کلاینت‌ها، گواهی‌ها،
|
|
اشتراک‌ها — را از یک داشبورد مرورگری مدیریت می‌کنید.
|
|
|
|
## اجزا چگونه کنار هم کار می‌کنند
|
|
|
|
<Mermaid
|
|
chart={`
|
|
flowchart LR
|
|
Admin["Admin browser"] -->|HTTPS panel| Panel["3x-ui panel"]
|
|
Panel -->|writes config, reloads| Xray["Xray-core"]
|
|
Panel --- DB[("SQLite or PostgreSQL")]
|
|
Clients["Client apps"] -->|VLESS / VMess / Trojan / ...| Xray
|
|
Xray -->|proxied traffic| Internet["Internet"]
|
|
`}
|
|
/>
|
|
|
|
- **پنل** لایهٔ مدیریت است: پیکربندی شما را در یک پایگاه‌داده ذخیره می‌کند،
|
|
داشبورد را رندر می‌کند، یک REST API ارائه می‌دهد و پیکربندی زندهٔ Xray را
|
|
می‌نویسد.
|
|
- **Xray-core** لایهٔ داده است: اتصالات کلاینت را روی **ورودی‌های** شما
|
|
پایان می‌دهد و ترافیک را به مقصدش هدایت می‌کند.
|
|
- **اپلیکیشن‌های کلاینت** (مانند v2rayNG، Clash/Mihomo، Hiddify و دیگران) با
|
|
استفاده از یک لینک اشتراک‌گذاری یا اشتراکی که پنل برای هر کلاینت تولید می‌کند
|
|
متصل می‌شوند.
|
|
|
|
## چه چیزی در اختیار شما می‌گذارد
|
|
|
|
- داشبوردی برای **ورودی‌ها** در تمام پروتکل‌های اصلی — VLESS، VMess،
|
|
Trojan، Shadowsocks، WireGuard، Hysteria2، SOCKS، HTTP و Dokodemo-door.
|
|
- پشتیبانی درجه‌یک از **REALITY** و **XTLS-Vision** برای ترانسپورت‌های مخفی
|
|
و سریع.
|
|
- سهمیه‌های ترافیک **به‌ازای هر کلاینت**، تاریخ‌های انقضا، محدودیت‌های IP،
|
|
وضعیت آنلاین و لینک‌های اشتراک‌گذاری / کدهای QR با یک کلیک.
|
|
- **اشتراک‌ها** در قالب‌های VLESS، Clash/Mihomo و JSON.
|
|
- ابزارهای عملیاتی: مدیریت **چندنودی**، یک **ربات Telegram**، پشتیبان‌گیری،
|
|
محدودسازی IP مبتنی بر Fail2ban و یک REST API مستندشده.
|
|
|
|
## پشت صحنه
|
|
|
|
| لایه | فناوری |
|
|
| ------------ | -------------------------------------------- |
|
|
| بک‌اند | Go با فریم‌ورک وب Gin |
|
|
| فرانت‌اند | TypeScript / React |
|
|
| پایگاه‌داده | SQLite (پیش‌فرض) یا PostgreSQL |
|
|
| موتور پروکسی | Xray-core (همراه و مدیریت‌شده توسط پنل) |
|
|
|
|
پایگاه‌دادهٔ پیش‌فرض SQLite در مسیر `/etc/x-ui/x-ui.db` قرار دارد و پنل به‌صورت
|
|
پیش‌فرض روی پورت **2053** گوش می‌دهد. هر دو قابل پیکربندی هستند — به
|
|
[نخستین ورود](/docs/guide/first-login) و مرجع متغیرهای محیطی مراجعه کنید.
|
|
|
|
## برای چه کسانی است
|
|
|
|
3x-ui برای هر کسی که سرور Xray خودش را اجرا می‌کند طراحی شده است: از یک
|
|
VPS شخصی منفرد تا اپراتورهایی که نودها و کلاینت‌های فراوانی را مدیریت می‌کنند. اگر
|
|
قدرت Xray-core را می‌خواهید بدون اینکه در فایل‌های پیکربندی JSON زندگی کنید، این
|
|
برای شماست.
|
|
|
|
<Callout type="info">
|
|
3x-ui یک فورک ارتقایافته از پروژهٔ اصلی X-UI است که پشتیبانی گسترده‌تری از
|
|
پروتکل‌ها، پایداری بهبودیافته، حسابداری ترافیک به‌ازای هر کلاینت، مدیریت
|
|
چندنودی و بسیاری از قابلیت‌های راحتی‌بخش را اضافه می‌کند.
|
|
</Callout>
|
|
|
|
آماده‌اید نصب کنید؟ به [نصب](/docs/guide/installation) ادامه دهید.
|