mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-08-10 05:10:58 +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.
52 lines
1.9 KiB
Plaintext
52 lines
1.9 KiB
Plaintext
---
|
||
title: 3x-ui 文档
|
||
description: 3x-ui 官方文档 —— 用于管理 Xray-core 服务器、代理、客户端与订阅的高级 Web 面板。
|
||
icon: House
|
||
---
|
||
|
||
**3x-ui** 是一个开源 Web 面板，用于部署和管理
|
||
[Xray-core](https://github.com/XTLS/Xray-core) 服务器。它为入站、协议、客户端、流量统计、订阅
|
||
等提供了现代化的控制台 —— 无需在命令行手动编辑 Xray JSON。
|
||
|
||
本站点是官方文档，同时提供一套**交互式、在浏览器内运行的工具**（配置生成器），它们完全运行在你的设备上 —— 任何数据都不会离开页面。
|
||
|
||
## 从这里开始
|
||
|
||
<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="搭配 XTLS-Vision 配置 VLESS + REALITY。"
|
||
/>
|
||
</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>
|