explaingit

mhsanaei/3x-ui

📈 Trending★ 37,566HTMLAudience · ops devopsComplexity · 3/5ActiveLicenseSetup · hard

TLDR

Web dashboard for managing an Xray-core proxy server. Create user accounts, set traffic limits, monitor usage, and configure multiple tunneling protocols, all from your browser instead of editing config files.

Mindmap

mindmap
  root((repo))
    What it does
      Proxy server dashboard
      User account management
      Traffic monitoring
      Protocol configuration
    Key features
      Multiple proxy protocols
      Traffic quotas and limits
      User expiry dates
      Security integration
    Use cases
      Self-hosted VPN setup
      Proxy server management
      Multi-user access control
    Tech stack
      Go backend
      HTML frontend
      Xray-core
    Deployment
      Single script install
      Linux server based
      Browser access

Things people build with this

USE CASE 1

Set up a self-hosted VPN or proxy server with a graphical interface instead of manually editing configuration files.

USE CASE 2

Manage multiple user accounts on a single proxy server, each with custom traffic limits and expiration dates.

USE CASE 3

Monitor real-time traffic usage and enforce bandwidth quotas across different users and protocols.

USE CASE 4

Deploy a secure proxy infrastructure with automatic IP blocking and post-quantum cryptography support.

Tech stack

GoHTMLXray-coreFail2Ban

Getting it running

Difficulty · hard Time to first run · 1day+

Requires Xray-core installation, Fail2Ban integration, and database setup; multiple moving parts to coordinate.

Use it freely, but any project you distribute that includes this code must also be GPL-licensed and open source.

In plain English

3X-UI is a web-based control panel for managing an Xray-core server. Xray-core is a network proxy tool that lets you route internet traffic through different protocols to bypass restrictions or add privacy to your connection. Instead of configuring Xray through complex text files, 3X-UI gives you a graphical dashboard in your browser where you can create and manage user accounts, set traffic limits, configure expiry dates, and monitor usage. The panel supports a wide variety of proxy and tunneling protocols including Vmess, Vless, Trojan, ShadowSocks, WireGuard, Hysteria, and others. Each of these is a different method of disguising or routing internet traffic, chosen depending on the network environment and what restrictions need to be bypassed. You can manage multiple users on a single server, each with their own connection settings, traffic quotas, and expiration times. Installation is done via a single shell script that you run on a Linux server. Once installed, you access the control panel through a web browser. The project also integrates with Fail2Ban (a tool that automatically blocks IP addresses that make too many failed login attempts) for added security, and it includes support for post-quantum cryptography, a newer approach to encryption designed to resist future quantum computers. Someone would use 3X-UI when they are self-hosting a VPN or proxy server and want a friendly interface to manage it rather than editing configuration files manually. The backend is written in Go, and the frontend uses HTML along with the Go-based web server.

Copy-paste prompts

Prompt 1
How do I install 3X-UI on my Linux server and access the control panel for the first time?
Prompt 2
Show me how to create a new user account in 3X-UI with a traffic limit and expiry date.
Prompt 3
What proxy protocols does 3X-UI support, and how do I choose which one to use for my setup?
Prompt 4
How can I integrate Fail2Ban with 3X-UI to automatically block IPs with failed login attempts?
Prompt 5
Walk me through monitoring user traffic and enforcing bandwidth quotas in the 3X-UI dashboard.
Open on GitHub → Explain another repo

Generated 2026-05-18 · Model: sonnet-4-6 · Verify against the repo before relying on details.