mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-16 15:17:14 +00:00
Egor
a09e136001
* docs: add Discord bot to READMEs, architecture, operations guides, and locales * docs: address review feedback on Discord bot formatting, backup commands, and architecture * docs(discord): fix Persian typo and literal arrows on fa/zh bot pages Senior review of #6513, two LOW findings in the two new pages: - fa/operations/discord-bot.mdx:30 spelled "developers" with Cyrillic "де" in place of Persian "ده", rendering a mixed-script word. - Both pages copied `$\rightarrow$` from the en page. The docs site has no math plugin (nothing in source.config.ts, no remark-math installed), so the built HTML shows the literal string "$\rightarrow$" in every menu path. Replaced with a Unicode arrow on fa and zh; en and ru have carried the same since #6486 and are left for a separate change. --------- Co-authored-by: Sanaei <ho3ein.sanaei@gmail.com>
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,
|
|
AmneziaWG, TUIC v5, 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 and Discord bots, 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>
|