术语表
读者:阅读文档时遇到陌生名词可在此查阅。概念说明详见 核心概念。
命名约定(必读)
Section titled “命名约定(必读)”文档与官网文案中 Client 专指部署在 VPS 上的 xctl-client 代理程序,不写「Node Client」。
系统中另有多种「节点」含义,写作时须区分:
| 用词 | 含义 | 避免混称为 |
|---|---|---|
| Client | VPS 上的同步代理(xctl-client) | Node、节点 |
| Host | 一台接入 Master 的 VPS / 物理机 | 节点(单独使用时) |
| 租户(Tenant) | 一套业务面板实例(WHMCS / Xboard / 自研等) | 权限组、面板节点 |
| 逻辑节点 | 业务线路(订阅里的一条入口) | Host、面板节点 |
| 面板节点 | Xboard / WHMCS 等产品里的「节点」展示项 | Host、逻辑节点 |
授权配额里的 节点数 = 已注册 Host 数量,不是逻辑节点数,也不是面板节点数。
| 术语 | 说明 |
|---|---|
| Master | 控制平台主服务:控制台、Admin API、配置下发调度 |
| Client | 部署在 Host 上的同步代理,执行配置同步并上报状态 |
| Host | 一台运行 3x-ui + Client 的服务器实例 |
| License | 官网购买的授权,约束租户数、Host 数(节点数)与有效期 |
| 术语 | 说明 |
|---|---|
| 推荐库 | MariaDB 10.6+ 或 MySQL 8.0+(生产默认) |
| 最低兼容库 | MySQL 5.7+、MariaDB 10.3+;事件 worker 无 SKIP LOCKED,单 Master 可跑 |
| SKIP LOCKED 降级 | 旧库上流量事件抢队列用普通 FOR UPDATE;多 Master HA 需 10.6+ / 8.0.1+ |
详见 环境要求 · 数据库版本。
| 术语 | 说明 |
|---|---|
| 租户(Tenant) | 对应一套独立业务面板(如一套 WHMCS、一个 Xboard 站);Master 为其单独建用户空间、Adapter Token 与 Webhook,与别的面板用户互不干扰 |
| 逻辑节点 | 业务上的一条「线路」,关联协议模板与准入规则 |
| 主机组 | 多台 Host 的集群编组,用于多区域 / 多运营商管理 |
| 节点映射 | 逻辑节点与 Host 的绑定关系 |
| 协议目录 | 数据驱动的入站模板库(Xray / sing-box) |
| 证书中心 | Master 侧 TLS 证书资产:ACME / 手动 / 自签,绑定逻辑节点后下发到 Host |
| 配置同步队列 | 下发任务队列;Client 离线时任务挂起,恢复后补推 |
| 术语 | 说明 |
|---|---|
| Adapter | 业务面板或插件对接 Master 的集成路径 |
| 全 Adapter API 自研 | 业务系统直接 POST /api/v1/users;用户与协议均由 Master 编排 |
| 面板插件 Adapter | 面板只同步用户;协议走 Master 目录,订阅由面板插件 + export API 生成 |
| 面板全继承 | 类似 XrayR/SOGA:Master 拉面板 /user + /config,无协议目录能力 |
| 面板节点 | 面板后台配置的展示用「节点」,通常映射到逻辑节点或 UniProxy |
| 权限组 | 自研面板/Adapter 场景下的用户线路档位(group_id) |
| 设备限制 | 按源 IP 统计在线设备数,用于防滥用 |
| UniProxy | Xboard 系面板与 Master 的兼容接口路径(user / config / alivelist);存量 V2board 协议兼容 |
| Webhook | Master 向租户对应业务面板推送流量等事件的 HTTP 回调 |
| biz_ref | 用户在业务侧的唯一键:{tenant_id}:{biz_type}:{biz_id} |
| 术语 | 说明 |
|---|---|
| 节点实时预警观测 | Host 离线、资源超限、同步失败等实时检测与控制台展示,详见 节点观测与告警 |
| PROXY 透传 | 入口反代经 PROXY protocol 把真实客户端 IP 传给 Xray,便于 设备限制 与日志,详见 流量与 PROXY |
| 审计日志 | 控制台与 Admin API 关键写操作(用户变更、Token 签发、逻辑节点修改、装机发起等)的追溯记录,详见 审计日志 |
| Telegram 通知 | 将预警与关键事件推送到 Telegram Bot,详见 Telegram 通知 |
操作细节以各专题页为准;术语表只作速查,不重复正文步骤。