# itsnotkubrick/3x-ui_kit architecture

> Architecture diagram of the GitHub repository itsnotkubrick/3x-ui_kit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/itsnotkubrick/3x-ui_kit
- Repository: https://github.com/itsnotkubrick/3x-ui_kit

## Overview

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: [`tools/index.html`](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/index.html) (Router generator), [`tools/lib/router.js`](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/router.js) (Router command builder), [`scripts/3x-ui.sh`](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/3x-ui.sh) (3X-UI installer), [`scripts/kit-sub.py`](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/kit-sub.py) (Client subscription)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_server["Server setup"]
  node_install["3X-UI installer<br/>[3x-ui.sh]"]
  node_hyinstall["Hysteria2 installer<br/>[hysteria2.sh]"]
end

subgraph group_admin["Server administration"]
  node_kit["Kit commands<br/>[kit.sh]"]
  node_kitlib["Kit shared logic<br/>[kit-sub.py]"]
end

subgraph group_subscriptions["Client subscriptions"]
  node_subscription["Client subscription<br/>[kit-sub.py]"]
end

subgraph group_router["Router configuration"]
  node_routerui["Router generator<br/>[index.html]"]
  node_xrayui["Xray generator<br/>[index.html]"]
  node_mihomoui["Mihomo generator<br/>[index.html]"]
  node_linkparser["Link parser<br/>[links.js]"]
  node_xraybuild["Xray config builder<br/>[xray.js]"]
  node_mihomobuild["Mihomo config builder<br/>[mihomo.js]"]
  node_singboxbuild["sing-box builder<br/>[singbox.js]"]
  node_routercommand["Router command builder<br/>[router.js]"]
  node_uihelpers["Generator UI helpers<br/>[ui.js]"]
end

node_owner(("Server operator"))
node_vps["Linux VPS"]
node_panel["3X-UI panel"]
node_client(("VPN client app"))
node_keenetic["Keenetic router"]
node_openwrt["OpenWrt router"]
node_xkeen["XKeen"]
node_nikki["Nikki"]

node_owner -->|"runs installer"| node_install
node_install -->|"sets up"| node_vps
node_install -->|"installs"| node_panel
node_owner -->|"runs installer"| node_hyinstall
node_owner -->|"runs commands"| node_kit
node_kit -->|"manages"| node_panel
node_panel -->|"provides upstream"| node_subscription
node_client -->|"requests link"| node_subscription
node_subscription -->|"formats response"| node_client
node_owner -->|"opens generator"| node_routerui
node_routerui -.->|"uses parser"| node_linkparser
node_routerui -.->|"builds config"| node_xraybuild
node_routerui -.->|"builds config"| node_mihomobuild
node_routerui -.->|"builds config"| node_singboxbuild
node_routerui -.->|"builds command"| node_routercommand
node_routerui -.->|"uses helpers"| node_uihelpers
node_owner -->|"opens generator"| node_xrayui
node_owner -->|"opens generator"| node_mihomoui
node_routercommand -->|"writes config"| node_keenetic
node_routercommand -->|"writes profile"| node_openwrt
node_routercommand -->|"restarts"| node_xkeen
node_routercommand -->|"restarts"| node_nikki

click node_install "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/3x-ui.sh"
click node_hyinstall "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/hysteria2.sh"
click node_kit "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/kit.sh"
click node_kitlib "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/kit-sub.py"
click node_subscription "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/kit-sub.py"
click node_routerui "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/index.html"
click node_xrayui "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/xray/index.html"
click node_mihomoui "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/mihomo/index.html"
click node_linkparser "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/links.js"
click node_xraybuild "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/xray.js"
click node_mihomobuild "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/mihomo.js"
click node_singboxbuild "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/singbox.js"
click node_routercommand "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/router.js"
click node_uihelpers "https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/ui.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_install,node_hyinstall,node_panel,node_client toneBlue
class node_kit,node_kitlib toneAmber
class node_subscription,node_owner,node_keenetic,node_openwrt toneMint
class node_routerui,node_xrayui,node_mihomoui,node_linkparser,node_xraybuild,node_mihomobuild,node_singboxbuild,node_routercommand,node_uihelpers toneRose
class node_vps,node_xkeen,node_nikki toneIndigo
```

## Components

### Server setup

- [3X-UI installer](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/3x-ui.sh): `scripts/3x-ui.sh`
- [Hysteria2 installer](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/hysteria2.sh): `scripts/hysteria2.sh`

### Server administration

- [Kit commands](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/kit.sh): `scripts/kit.sh`
- [Kit shared logic](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/kit-sub.py): `scripts/kit-sub.py`

### Client subscriptions

- [Client subscription](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/scripts/kit-sub.py): `scripts/kit-sub.py`

### Router configuration

- [Router generator](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/index.html): `tools/index.html`
- [Xray generator](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/xray/index.html): `tools/xray/index.html`
- [Mihomo generator](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/mihomo/index.html): `tools/mihomo/index.html`
- [Link parser](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/links.js): `tools/lib/links.js`
- [Xray config builder](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/xray.js): `tools/lib/xray.js`
- [Mihomo config builder](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/mihomo.js): `tools/lib/mihomo.js`
- [sing-box builder](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/singbox.js): `tools/lib/singbox.js`
- [Router command builder](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/router.js): `tools/lib/router.js`
- [Generator UI helpers](https://github.com/itsnotkubrick/3x-ui_kit/blob/main/tools/lib/ui.js): `tools/lib/ui.js`

### Other components

- **Server operator**
- **Linux VPS**
- **3X-UI panel**
- **VPN client app**
- **Keenetic router**
- **OpenWrt router**
- **XKeen**
- **Nikki**

## Connections

- Server operator → 3X-UI installer: runs installer (evidence: `README.md`)
- 3X-UI installer → Linux VPS: sets up (evidence: `README.md`)
- 3X-UI installer → 3X-UI panel: installs (evidence: `README.md`)
- Server operator → Hysteria2 installer: runs installer (evidence: `README.md`)
- Server operator → Kit commands: runs commands (evidence: `README.md`)
- Kit commands → 3X-UI panel: manages (evidence: `README.md`)
- 3X-UI panel → Client subscription: provides upstream (evidence: `scripts/kit-sub.py`)
- VPN client app → Client subscription: requests link (evidence: `scripts/kit-sub.py`)
- Client subscription → VPN client app: formats response (evidence: `scripts/kit-sub.py`)
- Server operator → Router generator: opens generator (evidence: `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 (evidence: `README.md`)
- Server operator → Mihomo generator: opens generator (evidence: `README.md`)
- Router command builder → Keenetic router: writes config (evidence: `tools/lib/router.js`)
- Router command builder → OpenWrt router: writes profile (evidence: `tools/lib/router.js`)
- Router command builder → XKeen: restarts (evidence: `tools/lib/router.js`)
- Router command builder → Nikki: restarts (evidence: `tools/lib/router.js`)
