3x-ui/docs/content/docs/en/index.mdx

---
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>