mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-08-27 21:47:14 +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.
72 lines
3.0 KiB
Plaintext
72 lines
3.0 KiB
Plaintext
---
|
|
title: Meet 3x-ui
|
|
description: A web panel for Xray-core — manage inbounds, protocols, clients, and subscriptions from your browser instead of editing JSON by hand.
|
|
icon: Info
|
|
---
|
|
|
|
**3x-ui** is a web control panel that sits on top of
|
|
[Xray-core](https://github.com/XTLS/Xray-core), the proxy engine that actually
|
|
moves your traffic. Instead of writing and reloading Xray's JSON configuration
|
|
by hand, you manage everything — inbounds, protocols, clients, certificates,
|
|
subscriptions — from a browser dashboard.
|
|
|
|
## How the pieces fit together
|
|
|
|
<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"]
|
|
`}
|
|
/>
|
|
|
|
- **The panel** is the management layer: it stores your configuration in a
|
|
database, renders the dashboard, exposes a REST API, and writes the live Xray
|
|
configuration.
|
|
- **Xray-core** is the data plane: it terminates client connections on your
|
|
**inbounds** and forwards traffic to its destination.
|
|
- **Client apps** (such as v2rayNG, Clash/Mihomo, Hiddify, and others) connect
|
|
using a share link or a subscription that the panel generates for each client.
|
|
|
|
## What it gives you
|
|
|
|
- A dashboard for **inbounds** across every major protocol — VLESS, VMess,
|
|
Trojan, Shadowsocks, WireGuard, Hysteria2, SOCKS, HTTP, and Dokodemo-door.
|
|
- First-class **REALITY** and **XTLS-Vision** support for stealthy, fast
|
|
transports.
|
|
- **Per-client** traffic quotas, expiry dates, IP limits, online status, and
|
|
one-click share links / QR codes.
|
|
- **Subscriptions** in VLESS, Clash/Mihomo, and JSON formats.
|
|
- Operational tooling: **multi-node** management, a **Telegram bot**, backups,
|
|
Fail2ban-based IP limiting, and a documented REST API.
|
|
|
|
## Under the hood
|
|
|
|
| Layer | Technology |
|
|
| ------------ | -------------------------------------------- |
|
|
| Backend | Go with the Gin web framework |
|
|
| Frontend | TypeScript / React |
|
|
| Database | SQLite (default) or PostgreSQL |
|
|
| Proxy engine | Xray-core (bundled and managed by the panel) |
|
|
|
|
The default SQLite database lives at `/etc/x-ui/x-ui.db`, and the panel listens
|
|
on port **2053** by default. Both are configurable — see
|
|
[First login](/docs/guide/first-login) and the environment variable reference.
|
|
|
|
## Who it's for
|
|
|
|
3x-ui is aimed at anyone running their own Xray server: from a single personal
|
|
VPS to operators managing many nodes and clients. If you want the power of
|
|
Xray-core without living in JSON config files, this is for you.
|
|
|
|
<Callout type="info">
|
|
3x-ui is an enhanced fork of the original X-UI project, adding broader protocol
|
|
support, improved stability, per-client traffic accounting, multi-node
|
|
management, and many quality-of-life features.
|
|
</Callout>
|
|
|
|
Ready to install? Continue to [Installation](/docs/guide/installation).
|