mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-10-08 23:22:09 +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.
55 lines
1.8 KiB
Plaintext
55 lines
1.8 KiB
Plaintext
---
|
|
title: 3x-ui Documentation
|
|
description: Official documentation for 3x-ui — an advanced web panel for managing Xray-core servers, proxies, clients, and subscriptions.
|
|
icon: House
|
|
---
|
|
|
|
**3x-ui** is an open-source web panel for deploying and managing
|
|
[Xray-core](https://github.com/XTLS/Xray-core) servers. It gives you a modern
|
|
dashboard for inbounds, protocols, clients, traffic accounting, subscriptions,
|
|
and more — without hand-editing Xray JSON on the command line.
|
|
|
|
This site is the official documentation and a set of **interactive, in-browser
|
|
tools** (config generators) that run entirely on your device — no data ever
|
|
leaves the page.
|
|
|
|
## Start here
|
|
|
|
<Cards>
|
|
<Card
|
|
title="What is 3x-ui?"
|
|
href="/docs/guide"
|
|
description="The big picture: Xray-core, the panel, and who it's for."
|
|
/>
|
|
<Card
|
|
title="Installation"
|
|
href="/docs/guide/installation"
|
|
description="Install via script, Docker, or manually."
|
|
/>
|
|
<Card
|
|
title="First login"
|
|
href="/docs/guide/first-login"
|
|
description="Reach the panel and harden it before anything else."
|
|
/>
|
|
<Card
|
|
title="REALITY"
|
|
href="/docs/config/reality"
|
|
description="Set up VLESS + REALITY with XTLS-Vision."
|
|
/>
|
|
</Cards>
|
|
|
|
## Highlights
|
|
|
|
- **Every major protocol** — VLESS, VMess, Trojan, Shadowsocks, WireGuard,
|
|
Hysteria2, SOCKS, HTTP, and Dokodemo-door.
|
|
- **REALITY & XTLS-Vision** — modern, censorship-resistant transports.
|
|
- **Per-client controls** — traffic quotas, expiry dates, IP limits, share
|
|
links, and QR codes.
|
|
- **Subscriptions** — VLESS, Clash/Mihomo, and JSON formats.
|
|
- **Operations** — multi-node management, Telegram bot, backups, and a REST API.
|
|
|
|
<Callout type="info">
|
|
New to Xray? Read [What is 3x-ui?](/docs/guide) first — it explains how the panel, Xray-core, and
|
|
your client apps fit together.
|
|
</Callout>
|