核心概念
This page is not available in English yet. Showing Simplified Chinese.
Master
Section titled “Master”控制平台主服务,提供控制台、Admin API 与配置下发调度。运维观测(在线状态、主机资源、告警)经 WebSocket 推送,无需轮询。
运行 3x-ui + Client 的 VPS 或物理机。文档中统一称 Host,不用「节点」简称,以免与逻辑节点、面板节点混淆。
可通过 SSH 一键装机 自动部署并注册到 Master,也可 手动安装 Client 后接入。
Client
Section titled “Client”部署在每台 Host 上的 xctl-client 代理:接收 Master 指令,对本机 3x-ui 执行 inbound / 用户同步,并上报心跳与流量。产品文案与文档均称 Client(不写 Node Client)。
逻辑节点与协议目录
Section titled “逻辑节点与协议目录”逻辑节点代表业务上的一条「线路」(订阅里出现的入口);协议目录提供可复用的入站模板(Xray / sing-box),点选即可创建,不用手写 JSON。
协议能力可简单理解为:
- VLESS / VMess / Trojan / Shadowsocks:通常走 Xray 入站能力
- Hysteria2 / WireGuard:通常走 sing-box
其中 WireGuard 单独使用 peers[] 模型与 .conf 交付,不同于通用订阅协议的 clients[] 模型。
TLS 类协议与 Hysteria2 需要服务端证书。XCTL 在 Master 提供 证书中心:ACME 申请、手动录入、自签生成;绑定逻辑节点后由 Client 自动落盘到各 Host,支持自动续签与 Telegram 临期提醒。
与 面板节点(Xboard 等后台的展示项)不同:面板节点是业务 UI 概念,逻辑节点是 Master 侧的编排单元。
租户(Tenant) = 一套独立业务面板在 Master 上的接入身份:例如你的 WHMCS、一个 Xboard 站、或自研商城各建一个租户。每个租户有自己的用户列表、biz_ref 前缀、Adapter Token 与 Webhook;Xboard 上的用户不会和 WHMCS 上的用户混在一起。
终端用户(订阅、流量、设备限制)由 Master 统一管理,但归属在某个租户之下。详见 租户与多面板。
实时配置下发
Section titled “实时配置下发”你在控制台配好「谁该用哪条逻辑节点、落在哪些 Host」后,Master 自动对账并通过各 Host 上的 Client 推送到 3x-ui。变更进入配置同步队列,可追踪每一次下发;Client 离线时任务挂起,恢复后自动补推。