mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-08-28 14:07:13 +00: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.
55 lines
3.0 KiB
Plaintext
55 lines
3.0 KiB
Plaintext
---
|
||
title: Документация 3x-ui
|
||
description: Официальная документация по 3x-ui — продвинутой веб-панели для управления серверами Xray-core, прокси, клиентами и подписками.
|
||
icon: House
|
||
---
|
||
|
||
**3x-ui** — это веб-панель с открытым исходным кодом для развёртывания и управления
|
||
серверами [Xray-core](https://github.com/XTLS/Xray-core). Она предоставляет современную
|
||
панель управления для входящих подключений, протоколов, клиентов, учёта трафика, подписок
|
||
и многого другого — без ручного редактирования JSON-конфигурации Xray в командной строке.
|
||
|
||
Этот сайт — официальная документация и набор **интерактивных инструментов, работающих
|
||
прямо в браузере** (генераторов конфигураций), которые выполняются полностью на вашем устройстве — никакие данные
|
||
не покидают страницу.
|
||
|
||
## Начните отсюда
|
||
|
||
<Cards>
|
||
<Card
|
||
title="Что такое 3x-ui?"
|
||
href="/docs/guide"
|
||
description="Общая картина: Xray-core, панель и для кого она предназначена."
|
||
/>
|
||
<Card
|
||
title="Установка"
|
||
href="/docs/guide/installation"
|
||
description="Установка через скрипт, Docker или вручную."
|
||
/>
|
||
<Card
|
||
title="Первый вход"
|
||
href="/docs/guide/first-login"
|
||
description="Откройте панель и защитите её, прежде чем делать что-либо ещё."
|
||
/>
|
||
<Card
|
||
title="REALITY"
|
||
href="/docs/config/reality"
|
||
description="Настройте VLESS + REALITY с XTLS-Vision."
|
||
/>
|
||
</Cards>
|
||
|
||
## Ключевые возможности
|
||
|
||
- **Все основные протоколы** — VLESS, VMess, Trojan, Shadowsocks, WireGuard,
|
||
Hysteria2, SOCKS, HTTP и Dokodemo-door.
|
||
- **REALITY и XTLS-Vision** — современные транспорты, устойчивые к цензуре.
|
||
- **Управление каждым клиентом** — квоты трафика, даты истечения, ограничения по IP, ссылки
|
||
для подключения и QR-коды.
|
||
- **Подписки** — форматы VLESS, Clash/Mihomo и JSON.
|
||
- **Эксплуатация** — управление несколькими узлами, Telegram-бот, резервные копии и REST API.
|
||
|
||
<Callout type="info">
|
||
Впервые работаете с Xray? Сначала прочитайте [Что такое 3x-ui?](/docs/guide) — там объясняется, как панель, Xray-core и
|
||
ваши клиентские приложения связаны между собой.
|
||
</Callout>
|