README.md

[English](/README.md) | [فارسی](/README.fa_IR.md) | [العربية](/README.ar_EG.md) | [中文](/README.zh_CN.md) | [Español](/README.es_ES.md) | [Русский](/README.ru_RU.md)

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="./media/3x-ui-dark.png">
    <img alt="3x-ui" src="./media/3x-ui-light.png">
  </picture>
</p>

[![Release](https://img.shields.io/github/v/release/mhsanaei/3x-ui.svg)](https://github.com/MHSanaei/3x-ui/releases)
[![Build](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg)](https://github.com/MHSanaei/3x-ui/actions)
[![GO Version](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg)](#)
[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg)](https://github.com/MHSanaei/3x-ui/releases/latest)
[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![Go Reference](https://pkg.go.dev/badge/github.com/mhsanaei/3x-ui/v3.svg)](https://pkg.go.dev/github.com/mhsanaei/3x-ui/v3)
[![Go Report Card](https://goreportcard.com/badge/github.com/mhsanaei/3x-ui/v3)](https://goreportcard.com/report/github.com/mhsanaei/3x-ui/v3)

**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
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)
```

For full documentation, please visit the [project Wiki](https://github.com/MHSanaei/3x-ui/wiki).

## A Special Thanks to

- [alireza0](https://github.com/alireza0/)

## Acknowledgment

- [Iran v2ray rules](https://github.com/chocolate4u/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](https://github.com/runetfreedom/russia-v2ray-rules-dat) (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**:star2:

<a href="https://www.buymeacoffee.com/MHSanaei" target="_blank">
<img src="./media/default-yellow.png" alt="Buy Me A Coffee" style="height: 70px !important;width: 277px !important;" >
</a>

</br>
<a href="https://nowpayments.io/donation/hsanaei" target="_blank" rel="noreferrer noopener">
   <img src="./media/donation-button-black.svg" alt="Crypto donation button by NOWPayments">
</a>

## Stargazers over Time

[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui)
Readme: Remove custom GeoSite/GeoIP DAT section Remove the "Custom GeoSite / GeoIP DAT" section from the main README and all localized READMEs (ar_EG, es_ES, fa_IR, ru_RU, zh_CN). Also apply minor formatting cleanups: normalize language header spacing and remove trailing spaces from the Stargazers badge lines. 2026-04-21 20:20:43 +02:00			`[English](/README.md) \| [فارسی](/README.fa_IR.md) \| [العربية](/README.ar_EG.md) \| [中文](/README.zh_CN.md) \| [Español](/README.es_ES.md) \| [Русский](/README.ru_RU.md)`
add Chinese README.zh (#2032) * add readme-zh * Update README.md * Update README.zh.md 2024-03-12 19:40:24 +08:00
readme update (#2604) 2024-11-21 11:18:30 -06:00			`<p align="center">`
			`<picture>`
			`<source media="(prefers-color-scheme: dark)" srcset="./media/3x-ui-dark.png">`
			`<img alt="3x-ui" src="./media/3x-ui-light.png">`
			`</picture>`
			`</p>`
Optimize Dark Theme & Ultra Dark (#1889) --------- Co-authored-by: MHSanaei <ho3ein.sanaei@gmail.com> Co-authored-by: Alireza Ahmadi <alireza7@gmail.com> 2024-02-28 14:35:01 +03:30
readme: Go Report Card,Go Reference 2025-09-19 10:29:34 +02:00			`[![Release](https://img.shields.io/github/v/release/mhsanaei/3x-ui.svg)](https://github.com/MHSanaei/3x-ui/releases)`
			`[![Build](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg)](https://github.com/MHSanaei/3x-ui/actions)`
			`[![GO Version](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg)](#)`
			`[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg)](https://github.com/MHSanaei/3x-ui/releases/latest)`
			`[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true)](https://www.gnu.org/licenses/gpl-3.0.en.html)`
feat(nodes): traffic-writer queue, full-mirror sync, WS event fixes - Traffic-writer single-consumer queue (web/service/traffic_writer.go) serialises every DB write that touches up/down/all_time/last_online (AddTraffic, SetRemoteTraffic, Reset*, UpdateClientTrafficByEmail) so overlapping goroutines can no longer clobber each other's column-scoped Updates with a stale tx.Save. - DB pool: WAL + busy_timeout=10s + synchronous=NORMAL + _txlock= immediate, MaxOpenConns=8 / MaxIdleConns=4. The immediate-tx PRAGMA fixes residual "database is locked [0ms]" cases where deferred-tx writer-upgrade conflicts bypass busy_timeout. - SetRemoteTraffic full-mirrors node-authoritative state into central: settings JSON, remark, listen, port, total, expiry, all_time, enable, plus per-client total/expiry/reset/all_time. Inbounds and client_traffics rows present on node but missing from central are created; rows missing from snap are deleted (with cascading client_traffics removal). - NodeTrafficSyncJob detects structural changes from the mirror and broadcasts invalidate(inbounds) so open central UIs re-fetch via REST on node-side add/del/edit without manual refresh. - XrayTrafficJob broadcasts invalidate(inbounds) when auto-disable flips client_traffics.enable so the per-client toggle reflects depletion without manual refresh. - Frontend: inbounds page now subscribes to the BroadcastInbounds 'inbounds' WS event (full-list pushes from add/del/update controllers were silently dropped). Fixes invalidate payload field (dataType -> type). Restart- panel modal switched from Promise-wrap to onOk-only so Cancel actually cancels. - Node files trimmed of stale prose-comments; cron cadence dropped 10s -> 5s to match the inbounds page UX. - README badges and Go module path bumped v2 -> v3 to match module rename. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> 2026-05-10 16:25:23 +02:00			`[![Go Reference](https://pkg.go.dev/badge/github.com/mhsanaei/3x-ui/v3.svg)](https://pkg.go.dev/github.com/mhsanaei/3x-ui/v3)`
			`[![Go Report Card](https://goreportcard.com/badge/github.com/mhsanaei/3x-ui/v3)](https://goreportcard.com/report/github.com/mhsanaei/3x-ui/v3)`
update README.md 2023-04-18 11:31:52 +04:30
chore: clean readme, add link to wiki (#3045) 2025-06-05 18:56:33 +07:00			`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.`
Update README.md 2023-02-23 14:10:56 +03:30
chore: clean readme, add link to wiki (#3045) 2025-06-05 18:56:33 +07:00			`> [!IMPORTANT]`
Improve English README (#3579) 2025-11-01 15:18:16 +03:30			`> 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.`
Update README.md (#1521) hello, Dear @MHSanaei I've made overall enhancements. 2024-01-06 08:36:59 +00:00
chore: clean readme, add link to wiki (#3045) 2025-06-05 18:56:33 +07:00			`As an enhanced fork of the original X-UI project, 3X-UI provides improved stability, broader protocol support, and additional features.`
host name for ws header req 2024-01-30 00:15:20 +03:30
chore: clean readme, add link to wiki (#3045) 2025-06-05 18:56:33 +07:00			`## Quick Start`
host name for ws header req 2024-01-30 00:15:20 +03:30
chore: clean readme, add link to wiki (#3045) 2025-06-05 18:56:33 +07:00			```bash
chore: update the installation command (#3069) * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line 2025-06-10 19:17:31 +03:30			`bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)`
Manual install & Upgrade , docker 2023-05-29 17:07:03 +03:30			```

chore: clean readme, add link to wiki (#3045) 2025-06-05 18:56:33 +07:00			`For full documentation, please visit the [project Wiki](https://github.com/MHSanaei/3x-ui/wiki).`
Update README.md 2023-02-10 20:57:11 +03:30
Update README.md (#1521) hello, Dear @MHSanaei I've made overall enhancements. 2024-01-06 08:36:59 +00:00			`## A Special Thanks to`

			`- [alireza0](https://github.com/alireza0/)`

			`## Acknowledgment`

			`- [Iran v2ray rules](https://github.com/chocolate4u/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._`
Add custom v2ray rules for Russia runetfreedom/russia-v2ray-rules-dat 2025-01-05 14:45:25 +01:00			`- [Russia v2ray rules](https://github.com/runetfreedom/russia-v2ray-rules-dat) (License: GPL-3.0): _This repository contains automatically updated V2Ray routing rules based on data on blocked domains and addresses in Russia._`
Update README.md (#1521) hello, Dear @MHSanaei I've made overall enhancements. 2024-01-06 08:36:59 +00:00
chore: clean readme, add link to wiki (#3045) 2025-06-05 18:56:33 +07:00			`## Support project`

			`If this project is helpful to you, you may wish to give it a:star2:`

donate: nowpayments 2025-09-18 20:08:56 +02:00			`<a href="https://www.buymeacoffee.com/MHSanaei" target="_blank">`
			`<img src="./media/default-yellow.png" alt="Buy Me A Coffee" style="height: 70px !important;width: 277px !important;" >`
			`</a>`

			`</br>`
			`<a href="https://nowpayments.io/donation/hsanaei" target="_blank" rel="noreferrer noopener">`
			`<img src="./media/donation-button-black.svg" alt="Crypto donation button by NOWPayments">`
			`</a>`
chore: clean readme, add link to wiki (#3045) 2025-06-05 18:56:33 +07:00
Update README.md (#1521) hello, Dear @MHSanaei I've made overall enhancements. 2024-01-06 08:36:59 +00:00			`## Stargazers over Time`
3x-ui 2023-02-09 22:48:06 +03:30
chore: update the installation command (#3069) * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line * install command had an extra $ at the first of the line 2025-06-10 19:17:31 +03:30			`[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui)`