explaingit

vaxilu/x-ui

★ 18,992JavaScriptAudience · ops devopsComplexity · 3/5StaleLicenseSetup · moderate

TLDR

Web dashboard for managing xray proxy servers. Create and monitor multiple proxy connections for users without editing config files.

Mindmap

mindmap
  root((repo))
    What it does
      Visual proxy management
      Multi-user support
      Traffic monitoring
    Key features
      Multiple protocols
      SSL auto-renewal
      Telegram alerts
    Setup
      Linux servers
      Single command install
      Docker support
    Use cases
      Personal proxy hosting
      Small group tunnels
      Traffic tracking

Things people build with this

USE CASE 1

Self-host a private proxy server and manage multiple user accounts from a web browser dashboard.

USE CASE 2

Monitor real-time data usage and set traffic limits for each proxy connection without command-line configuration.

USE CASE 3

Set up automatic HTTPS with SSL certificate renewal for secure remote access to your proxy control panel.

USE CASE 4

Receive Telegram notifications when users log in or exceed traffic limits on their proxy connections.

Tech stack

JavaScriptNode.jsxrayDockerLinux

Getting it running

Difficulty · moderate Time to first run · 30min

Requires Docker and xray binary/service to be running; dashboard alone won't function without a working xray backend.

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

In plain English

X-UI is a web-based control panel for running xray, a proxy server tool commonly used to route internet traffic through privacy-focused tunnels. The problem it solves is making xray easy to manage: without a panel like this, you'd have to edit complex configuration files by hand. X-UI gives you a visual dashboard to create and manage multiple proxy connections for multiple users at once. Through its web interface, you can set up connections using a range of proxy protocols, vmess, vless, trojan, shadowsocks, socks, and http. You can track how much data each connection uses, set traffic limits, and configure automatic HTTPS access to the panel itself with automatic SSL certificate renewal. There's also optional Telegram bot integration for notifications about traffic and logins. It runs on Linux servers (CentOS 7+, Ubuntu 16+, Debian 8+) and can be installed with a single shell command or via Docker. Someone self-hosting a private proxy server for personal use or for a small group of users would use this panel to configure and monitor everything from a browser instead of the command line.

Copy-paste prompts

Prompt 1
How do I install X-UI on my Ubuntu server and create my first proxy connection through the web dashboard?
Prompt 2
Show me how to set up traffic limits and monitoring for multiple users in X-UI so I can track their data usage.
Prompt 3
How do I enable automatic SSL certificate renewal in X-UI and access my proxy panel securely over HTTPS?
Prompt 4
What proxy protocols does X-UI support, and how do I choose between vmess, vless, trojan, and shadowsocks for my setup?
Prompt 5
How do I integrate Telegram bot notifications with X-UI to get alerts about user logins and traffic limits?
Open on GitHub → Explain another repo

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