How itsnotkubrick/3x-ui_kit works
3X-UI KIT is a set of server-installation and administration scripts plus browser-based VPN configuration tools. The primary workflow installs 3X-UI on a VPS, then exposes protocol subscriptions tailored to client applications. A separate router workflow builds Xray or Mihomo configurations and an SSH command for XKeen or Nikki. The README also documents Hysteria2-only installation and server administration features. Relationships between the browser pages and generator modules are not shown in the excerpts, so those links are marked unverified; documented product workflows are retained.
Main entry points: index.html Router generator · router.js Router command builder · 3x-ui.sh 3X-UI installer · kit-sub.py Client subscription
Components 22
Server setup
- 3X-UI installer
scripts/3x-ui.sh - Hysteria2 installer
scripts/hysteria2.sh
Server administration
- Kit commands
scripts/kit.sh - Kit shared logic
scripts/kit-sub.py
Client subscriptions
- Client subscription
scripts/kit-sub.py
Router configuration
- Router generator
tools/index.html - Xray generator
tools/xray/index.html - Mihomo generator
tools/mihomo/index.html - Link parser
tools/lib/links.js - Xray config builder
tools/lib/xray.js - Mihomo config builder
tools/lib/mihomo.js - sing-box builder
tools/lib/singbox.js - Router command builder
tools/lib/router.js - Generator UI helpers
tools/lib/ui.js
Other components
- Server operator
- Linux VPS
- 3X-UI panel
- VPN client app
- Keenetic router
- OpenWrt router
- XKeen
- Nikki
Connections 22
- Server operator → 3X-UI installer: runs installer
README.md - 3X-UI installer → Linux VPS: sets up
README.md - 3X-UI installer → 3X-UI panel: installs
README.md - Server operator → Hysteria2 installer: runs installer
README.md - Server operator → Kit commands: runs commands
README.md - Kit commands → 3X-UI panel: manages
README.md - 3X-UI panel → Client subscription: provides upstream
scripts/kit-sub.py - VPN client app → Client subscription: requests link
scripts/kit-sub.py - Client subscription → VPN client app: formats response
scripts/kit-sub.py - Server operator → Router generator: opens generator
README.md - Router generator → Link parser: uses parser
- Router generator → Xray config builder: builds config
- Router generator → Mihomo config builder: builds config
- Router generator → sing-box builder: builds config
- Router generator → Router command builder: builds command
- Router generator → Generator UI helpers: uses helpers
- Server operator → Xray generator: opens generator
README.md - Server operator → Mihomo generator: opens generator
README.md - Router command builder → Keenetic router: writes config
tools/lib/router.js - Router command builder → OpenWrt router: writes profile
tools/lib/router.js - Router command builder → XKeen: restarts
tools/lib/router.js - Router command builder → Nikki: restarts
tools/lib/router.js