Xray panel supporting multi-protocol multi-user expire day & traffic & ip limit (Vmess & Vless & Trojan & ShadowSocks & Wireguard)
Find a file
reza b0d9fe156b feat(socks): add IsSocksLike helper, info-modal display, and tests
Second-pass on the SOCKS5 inbound scaffold (PR #4452). This commit
ticks off two of the 'help wanted' items from the scaffold's TODO
list and tightens the existing dispatcher so that adding a new
protocol-without-link in the future is a one-line change instead
of an audit through every switch.

Backend (Go)
------------
* database/model/model.go: new IsSocksLike(p) helper that returns
  true for both 'socks' and 'mixed'. Mirrors the existing IsHysteria
  pattern (one helper, two underlying constants) so call sites
  don't have to re-list both protocols every time they need to
  treat 'this inbound speaks SOCKS5' uniformly.

* database/model/model_test.go:
  - TestSocksProtocolConstant pins the wire value 'socks' so a
    future refactor can't silently rename it (which would orphan
    every stored inbound row).
  - TestIsSocksLike covers Socks, Mixed, every other declared
    protocol, the empty Protocol, and a wrong-case input.

* sub/subService.go GetLink:
  - Replace bare string literals ('vmess', 'vless', …) with the
    typed model.* constants so a typo can't silently fall through.
  - Add an explicit link-less case for
    Socks/Mixed/HTTP/Tunnel/WireGuard with a comment explaining
    why we don't emit 'socks://…' URLs (follow-up #1 in the
    scaffold PR description).

Frontend (JS/Vue)
-----------------
* frontend/src/models/dbinbound.js: add 'isSocks' getter (pure
  SOCKS5 inbound) and 'isSocksLike' getter (Socks OR Mixed), matching
  the pattern used by isMixed/isHTTP/isWireguard above.

* frontend/src/pages/inbounds/InboundInfoModal.vue: the existing
  'Mixed' info block (auth/UDP/IP/accounts) now also renders for
  the new SOCKS protocol via isSocksLike, since Xray's mixed and
  socks inbounds accept the exact same settings keys. Without
  this, opening the info modal for a SOCKS inbound would show an
  empty body. Header comment updated to list SOCKS alongside
  Mixed/HTTP/Tunnel.

Still outstanding from the scaffold's TODO list:
  - Xray runtime AddUser hooks (web/service/inbound.go)
  - Translations for the 'socks' label across all 13 locales
  - Routing UI protocol == socks helper
2026-05-18 14:56:41 +00:00
.github build(deps): bump actions/setup-node from 5 to 6 (#4368) 2026-05-14 11:11:12 +02:00
.vscode DevTools 2025-10-02 01:47:12 +02:00
config v3.0.2 2026-05-14 10:27:33 +02:00
database feat(socks): add IsSocksLike helper, info-modal display, and tests 2026-05-18 14:56:41 +00:00
frontend feat(socks): add IsSocksLike helper, info-modal display, and tests 2026-05-18 14:56:41 +00:00
logger add log rotate to 3xui.log file to avoid disk space consumption (#4277) 2026-05-13 17:03:56 +02:00
media donate: nowpayments 2025-09-18 20:14:10 +02:00
sub feat(socks): add IsSocksLike helper, info-modal display, and tests 2026-05-18 14:56:41 +00:00
util fix(auth): invalidate sessions when 2FA is enabled, fix dev 401 loop 2026-05-13 14:08:16 +02:00
web fix(translation): correct typos and improve phrasing in English localization (#4430) 2026-05-16 10:24:04 +02:00
windows_files Update OpenSSL installer to version 3.6.0 2026-01-05 18:49:30 +01:00
xray Remove streamSettings for protocols that don't support it 2026-05-14 23:18:23 +02:00
.env.example fix: display of outbound traffic (#3604) 2025-12-23 15:43:25 +01:00
.gitignore feat(nodes): traffic-writer queue, full-mirror sync, WS event fixes 2026-05-10 16:25:23 +02:00
.nvmrc Security hardening: sessions, SSRF, CSP nonce, CSRF logout, trusted proxies (#4275) 2026-05-13 12:52:52 +02:00
CONTRIBUTING.md fix: display of outbound traffic (#3604) 2025-12-23 15:43:25 +01:00
docker-compose.yml fix(docker): update port mapping for 3xui service in docker-compose (#4362) 2026-05-14 10:00:09 +02:00
DockerEntrypoint.sh fix(fail2ban): escape percent signs in 3x-ipl datepattern (#4328) 2026-05-13 01:49:09 +02:00
Dockerfile fix(docker): pin frontend stage to BUILDPLATFORM and drop removed buildx input 2026-05-10 17:22:15 +02:00
DockerInit.sh Revert "Xray Core v26.5.3" buggy version(vless reverse doesn't work) 2026-05-06 08:52:36 +02:00
go.mod add log rotate to 3xui.log file to avoid disk space consumption (#4277) 2026-05-13 17:03:56 +02:00
go.sum add log rotate to 3xui.log file to avoid disk space consumption (#4277) 2026-05-13 17:03:56 +02:00
install.sh feat: add API token to install output (#4322) 2026-05-14 10:24:23 +02:00
LICENSE 3x-ui 2023-02-09 22:48:06 +03:30
main.go feat: add API token to install output (#4322) 2026-05-14 10:24:23 +02:00
README.ar_EG.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.es_ES.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.fa_IR.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.ru_RU.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.zh_CN.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
update.sh fix(scripts): harden server-IP detection with multi-provider + manual fallback 2026-05-08 00:51:28 +02:00
x-ui.rc fix(alpine): restart_xray uses rc-service; OpenRC reload reads pidfile contents 2026-05-11 09:05:36 +02:00
x-ui.service.arch fix(arch): correct x-ui service path (#4213) 2026-05-10 17:17:33 +02:00
x-ui.service.debian [feat] restart xray-core from cli #3825 2026-02-20 00:03:16 +01:00
x-ui.service.rhel [feat] restart xray-core from cli #3825 2026-02-20 00:03:16 +01:00
x-ui.sh fix(fail2ban): escape percent signs in 3x-ipl datepattern (#4328) 2026-05-13 01:49:09 +02:00

English | فارسی | العربية | 中文 | Español | Русский

3x-ui

Release Build GO Version Downloads License Go Reference Go Report Card

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/mhsanaei/3x-ui/master/install.sh)

For full documentation, please visit the project Wiki.

A Special Thanks to

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.

Community Tools

Tools and integrations built by the community around 3x-ui.

  • terraform-provider-3x-ui (License: MIT): Manage inbounds, clients, panel settings, and Xray configuration as code with Terraform / OpenTofu.

Support project

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

Buy Me A Coffee
Crypto donation button by NOWPayments

Stargazers over Time

Stargazers over time