3x-ui

command module

v2.8.9 Latest Latest Go to latest Published: Feb 16, 2026 License: GPL-3.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/iprodev/3x-ui

Links

Open Source Insights

README ¶

3x-ui

3X-UI — advanced, open-source web-based control panel designed for managing Xray-core server. It offers a user-friendly interface for configuring and monitoring various VPN and proxy protocols.

[!IMPORTANT] This project is only for personal usage, please do not use it for illegal purposes, and please do not use it in a production environment.

As an enhanced fork of the original X-UI project, 3X-UI provides improved stability, broader protocol support, and additional features.

Quick Start

bash <(curl -Ls https://raw.githubusercontent.com/iprodev/3x-ui/master/install.sh)

For full documentation, please visit the project Wiki.

A Special Thanks to

alireza0

Acknowledgment

Iran v2ray rules (License: GPL-3.0): Enhanced v2ray/xray and v2ray/xray-clients routing rules with built-in Iranian domains and a focus on security and adblocking.
Russia v2ray rules (License: GPL-3.0): This repository contains automatically updated V2Ray routing rules based on data on blocked domains and addresses in Russia.

Support project

If this project is helpful to you, you may wish to give it a🌟

Stargazers over Time

Documentation ¶

Overview ¶

Package main is the entry point for the 3x-ui web panel application. It initializes the database, web server, and handles command-line operations for managing the panel.

Source Files ¶

View all Source files

main.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
config Package config provides configuration management utilities for the 3x-ui panel, including version information, logging levels, database paths, and environment variable handling.	Package config provides configuration management utilities for the 3x-ui panel, including version information, logging levels, database paths, and environment variable handling.
database Package database provides database initialization, migration, and management utilities for the 3x-ui panel using GORM with SQLite.	Package database provides database initialization, migration, and management utilities for the 3x-ui panel using GORM with SQLite.
model Package model defines the database models and data structures used by the 3x-ui panel.	Package model defines the database models and data structures used by the 3x-ui panel.
logger Package logger provides logging functionality for the 3x-ui panel with dual-backend logging (console/syslog and file) and buffered log storage for web UI.	Package logger provides logging functionality for the 3x-ui panel with dual-backend logging (console/syslog and file) and buffered log storage for web UI.
sub Package sub provides subscription server functionality for the 3x-ui panel, including HTTP/HTTPS servers for serving subscription links and JSON configurations.	Package sub provides subscription server functionality for the 3x-ui panel, including HTTP/HTTPS servers for serving subscription links and JSON configurations.
util
common Package common provides common utility functions for error handling, formatting, and multi-error management.	Package common provides common utility functions for error handling, formatting, and multi-error management.
crypto Package crypto provides cryptographic utilities for password hashing and verification.	Package crypto provides cryptographic utilities for password hashing and verification.
json_util Package json_util provides JSON utilities including a custom RawMessage type.	Package json_util provides JSON utilities including a custom RawMessage type.
ldap
random Package random provides utilities for generating random strings and numbers.	Package random provides utilities for generating random strings and numbers.
reflect_util Package reflect_util provides reflection utilities for working with struct fields and values.	Package reflect_util provides reflection utilities for working with struct fields and values.
sys Package sys provides system utilities for monitoring network connections and CPU usage.	Package sys provides system utilities for monitoring network connections and CPU usage.
web Package web provides the main web server implementation for the 3x-ui panel, including HTTP/HTTPS serving, routing, templates, and background job scheduling.	Package web provides the main web server implementation for the 3x-ui panel, including HTTP/HTTPS serving, routing, templates, and background job scheduling.
controller Package controller provides HTTP request handlers and controllers for the 3x-ui web management panel.	Package controller provides HTTP request handlers and controllers for the 3x-ui web management panel.
entity Package entity defines data structures and entities used by the web layer of the 3x-ui panel.	Package entity defines data structures and entities used by the web layer of the 3x-ui panel.
global Package global provides global variables and interfaces for accessing web and subscription servers.	Package global provides global variables and interfaces for accessing web and subscription servers.
job Package job provides background job implementations for the 3x-ui web panel, including traffic monitoring, system checks, and periodic maintenance tasks.	Package job provides background job implementations for the 3x-ui web panel, including traffic monitoring, system checks, and periodic maintenance tasks.
locale Package locale provides internationalization (i18n) support for the 3x-ui web panel, including translation loading, localization, and middleware for web and bot interfaces.	Package locale provides internationalization (i18n) support for the 3x-ui web panel, including translation loading, localization, and middleware for web and bot interfaces.
middleware Package middleware provides HTTP middleware functions for the 3x-ui web panel, including domain validation and URL redirection utilities.	Package middleware provides HTTP middleware functions for the 3x-ui web panel, including domain validation and URL redirection utilities.
network Package network provides network utilities for the 3x-ui web panel, including automatic HTTP to HTTPS redirection functionality.	Package network provides network utilities for the 3x-ui web panel, including automatic HTTP to HTTPS redirection functionality.
service Package service provides business logic services for the 3x-ui web panel, including inbound/outbound management, user administration, settings, and Xray integration.	Package service provides business logic services for the 3x-ui web panel, including inbound/outbound management, user administration, settings, and Xray integration.
session Package session provides session management utilities for the 3x-ui web panel.	Package session provides session management utilities for the 3x-ui web panel.
websocket Package websocket provides WebSocket hub for real-time updates and notifications.	Package websocket provides WebSocket hub for real-time updates and notifications.
xray Package xray provides integration with the Xray proxy core.	Package xray provides integration with the Xray proxy core.