m-ui

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 2, 2026 License: GPL-3.0 Imports: 27 Imported by: 0

README

m-ui

m-ui

内嵌 sing-box 的多服务器代理面板 · 单二进制 · 一主多副 · 面板内完成全部运维

中文 · English


这是什么

m-ui 是一个自托管的代理服务面板:一个二进制、一个数据库文件,把 sing-box 内嵌进来,在网页里管理线路、用户、订阅、证书、备份、多台服务器和日常运维。

它和常见面板的主要不同:

  • 线路模型:一条"线路" = 入口协议 + 端口 → 上游落地。不用分别维护入站 / 出站 / 路由三张表。
  • 改配置不担心断线:保存前先把整份配置交给 sing-box 干跑校验,坏配置进不了库;改用户和上游都是热更新,只有改线路才重启数据面。
  • 一主多副:主服务器把线路 / 上游 / 用户推送到任意数量的副服务器,回收流量、集中判定配额;订阅里每条线路按服务器各出一个节点,客户端自动选延迟低的入口。
  • 运维都在面板里:Let's Encrypt 证书、Cloudflare WARP、内核调优、备份还原、换机向导、Telegram 通知、两步验证、外部 API。

适合自己用、小团队用,或者需要在多台服务器上统一管理用户的场景。

功能总览

模块 内容
线路 Hysteria2、AnyTLS、TUIC、Trojan、VLESS(Reality / Vision)、VMess、Shadowsocks(含 2022)、SOCKS、HTTP、Mixed;传输层 WS / gRPC / HTTPUpgrade / HTTP;Hysteria2 端口跳跃;按服务器选择部署位置
上游 VLESS / VMess / Trojan / TUIC / Hysteria2 / Shadowsocks / SOCKS 落地,粘贴分享链接导入;一键测延迟、定时巡检、故障 / 恢复告警;WARP 一键接入
用户 配额、到期、周期重置、同时在线设备数(按源 IP,跨服务器并集)、上下行限速;超量 / 到期自动禁用并踢线;批量生成、批量操作、CSV 导出
套餐 配额 / 时长 / 设备 / 限速 / 线路的模板,建号、续费、延期一键套用
订阅 通用链接与 Clash 两种格式;浏览器打开是落地页(用量、到期、一键导入、二维码);外部节点 / 外部订阅聚合;自签证书自动带 insecure
多服务器 主机推送配置、回收流量、集中判定;每台服务器可设流量倍率;副机失联 / 恢复告警
证书 Let's Encrypt HTTP-01 / Cloudflare DNS-01 签发,到期前自动续期,热更新不重启;无域名时一键自签
备份 一个 zip 含数据库一致快照与证书;上传即整机还原;定时备份、轮转、推送 Telegram;换机向导
运维 WARP 安装 / 启用 / 停用 / 卸载并验证出口;swap、内核参数 + BBR、文件句柄、NTP
通知 Telegram:登录、用户到期 / 超量 / 禁用、上游故障、数据面停止、每日报告
观测 流量走势(按时段柱状,1h / 6h / 24h / 7d / 30d)、流量排行、在线用户与 IP、最近入站连接诊断、审计日志、订阅访问日志
安全 bcrypt 密码、CSRF 防护、登录失败告警、两步验证(TOTP)、外部 API 令牌
集成 外部 API(建号、套餐、启停、续费、订阅地址),见 docs/API.md

安装

系统要求

  • Linux amd64 或 arm64,systemd(Debian / Ubuntu / CentOS / Alpine 等均可,推荐 Debian 11+ / Ubuntu 20.04+)
  • root 权限
  • 放行端口:面板 2053/tcp、订阅 2056/tcp、以及你创建的线路端口(TCP 或 UDP 视协议而定)。签发证书用 HTTP-01 时还需要 80/tcp 可达

一键安装(推荐)

bash <(curl -fsSL https://raw.githubusercontent.com/Maoyangui/m-ui/main/deploy/install.sh)

不是 root 用户时用管道形式:

curl -fsSL https://raw.githubusercontent.com/Maoyangui/m-ui/main/deploy/install.sh | sudo bash

脚本会自动识别架构,从 GitHub Releases 下载最新版,装到 /usr/local/bin/m-ui,数据放在 /etc/m-ui/,并注册 m-ui.service 开机自启。安装结束会打印面板地址与默认账号。

指定版本或离线安装:

bash install.sh v0.2.0                          # 指定版本
bash install.sh ./m-ui-linux-amd64.tar.gz       # 本地文件(Releases 里的压缩包或裸二进制)
bash install.sh https://.../m-ui-linux-arm64.tar.gz   # 任意下载地址

首次登录

  • 面板地址:http://<服务器IP>:2053/app/
  • 默认账号:admin / admin

登录后顶部会一直提示修改默认密码,请到 管理员 页立即修改。改端口、路径、账号也可以在 SSH 里执行 m-ui 用菜单完成。

升级

m-ui            # 菜单选 10 "更新到最新版"

或重新执行一键安装脚本。升级只替换二进制并重启,数据库、证书、备份都不动。

卸载

m-ui 菜单选 14,可选择是否同时删除 /etc/m-ui 数据目录。

快速上手

登录后概览页有一份快速开始清单,按顺序做完就能用:

  1. 域名(可选):设置 → 面板 → 域名。把域名 A 记录解析到服务器 IP。
  2. 证书:证书页填域名,一键签发 Let's Encrypt;没有域名就点"生成自签证书"填服务器 IP。面板、订阅、数据面共用这张证书,以后自动续期。
  3. 线路:线路页新增,选协议(推荐 Hysteria2 或 AnyTLS)、端口、上游(默认直连),保存。
  4. 用户:用户页新增,勾选可用线路,或直接套用套餐。
  5. 分发订阅:用户列表复制订阅链接发给用户,或让用户在浏览器打开落地页扫码 / 一键导入。

没有域名也能用:自签证书 + IP 地址,订阅会自动带上"允许不安全证书",客户端无需额外设置;之后有了域名再签发正式证书,用户刷新一次订阅即可。

功能说明

线路

  • 一条线路对应一个入口端口。端口在所有服务器上一致,主机负责渲染并下发到每台副机。
  • 上游决定流量从哪出去:直连、WARP、或任意一个已添加的落地节点(中转)。
  • 部署到:默认所有服务器;也可以只部署到某几台,例如给某台副机建一条它专属的线路。
  • Hysteria2 可填端口跳跃范围(如 20000-30000),服务器用 nftables / iptables 把这段 UDP 转到线路端口,客户端在范围内随机换端口,规避运营商对单端口 UDP 的限速。
  • 保存时整份 sing-box 配置先干跑校验,失败的改动不会落库。

上游

  • 可视化编辑或直接粘贴 vless://、hy2://、ss:// 等分享链接导入。
  • 一键测试延迟(经上游访问测试地址),定时巡检;连续失败发 Telegram 告警,恢复时再通知。
  • 运维页启用 WARP 后会自动出现名为 warp 的上游,线路选它即可走 WARP 出口。

外部节点

把别处的节点并进你的订阅:一条分享链接,或一整个外部订阅(机场、中转)。主机定时抓取(间隔可设),分配给用户后出现在该用户订阅里本站节点之后,可加统一前缀便于区分。

用户与套餐

  • 每个用户:配额、到期、周期重置(如每 30 天清零)、设备数、限速、备注、可用线路、可用外部节点。
  • 超量或到期自动禁用并踢下线;重置流量后自动恢复。
  • 套餐是模板:建号时选套餐一键填好;续费 = 再套一次(用量清零、到期顺延);延期 = 保留用量只顺延到期。
  • 批量:按前缀批量生成、勾选后批量启停 / 延期 / 重置 / 删除,导出 CSV。
  • 用户抽屉:实时在线 IP、24h / 7d / 30d 流量图、订阅链接与二维码、踢线。

订阅

  • 通用链接:https://<域名或IP>:2056/sub/<用户名>,适用于 nextin、sing-box、Shadowrocket、Surge、Quantumult X、Loon、Karing 等。
  • Clash:在链接后加 ?format=clash,适用于 mihomo / Clash Verge / Stash 等;每条线路生成一个按延迟自动选择的入口组。
  • 浏览器打开链接显示落地页:用量、到期、各客户端一键导入、二维码、自定义公告与客服信息。
  • 节点地址默认用服务器 IP、域名只作 SNI,避免客户端本地 DNS 被污染导致连不上;可在设置里改为域名。
  • 多服务器时每条线路按服务器各出一个节点,名称后缀为服务器名;流量倍率不为 1 的服务器会带 x2 之类的标记。

多服务器

任意数量的副服务器,接入步骤:

  1. 副机同样安装 m-ui,登录后 设置 → 角色 勾选"作为副服务器运行"。
  2. 副机 设置 → 配对信息 复制 API 地址与令牌。
  3. 主机 服务器 页新增:名称(如"香港",作为订阅节点后缀)、域名、API 地址、令牌,可选跳过证书校验(副机自签时)。
  4. 几秒内主机完成推送并显示"已同步"。

工作方式:主机每几秒比对快照,有变化就推给副机;同时从副机拉回流量账本、在线 IP、运行状态与证书剩余天数。配额只在主机判定,禁用用户 5 秒内传到所有副机。副机失联超过 1 分钟告警一次,恢复再通知;离线期间副机继续用最后一份配置服务用户。

每台服务器可设流量倍率(含主机自己):经该服务器的流量按倍率计入用户用量,比如给贵的线路设 2 倍。

证书

  • Let's Encrypt:HTTP-01(需 80 端口可达)或 Cloudflare DNS-01(填 API Token,不用开 80)。签发前预检 DNS 解析与端口。
  • 到期前自动续期,续期后面板 / 订阅 / 数据面热更新,不重启。
  • 无域名:一键生成自签证书。
  • 副服务器各自签发自己的证书。

备份与换机

  • 备份页一键下载 zip(数据库一致快照 + 证书);定时备份并轮转,可推送到 Telegram。
  • 还原:在新机备份页上传 zip,m-ui 自动重启并整机还原;或安装时 bash install.sh --restore 备份.zip。
  • 换机向导:新机装好并还原 → 检查面板 → 把域名解析切到新机(页内可查各大解析器是否生效)→ 旧机下线。端口、凭据、订阅地址全部不变,用户无感。

运维

  • WARP:一键安装 / 启用(本地 SOCKS5,MASQUE)/ 停用 / 卸载,并验证出口 IP。
  • 系统优化:swap、内核参数 + BBR、文件句柄上限、NTP,参数可按机器调整。任务串行执行,输出实时显示。

日志

订阅访问日志、核心日志(数据面 + 面板)、操作审计。核心日志页可关闭记录(省资源),每类日志都可一键清空。

管理员

  • 修改用户名 / 密码。
  • 两步验证:生成密钥扫码,或手动输入一串密钥,填一次验证码即开启;兼容 Google / Microsoft Authenticator、Authy、1Password 等。手机丢失时 SSH 执行 m-ui 选"关闭两步验证",重置密码也会一并清除。
  • 外部 API:打开开关拿到令牌,商城 / 计费 / 机器人即可建号、套餐续费、启停、踢线、取订阅地址。页内有接口表与 curl 示例,完整说明见 docs/API.md。

设置

面板与订阅的监听地址 / 端口 / 路径 / 证书、订阅展示选项、落地页文案、Telegram 通知项、上游巡检参数、数据面统计粒度等。改端口、监听地址、证书路径需重启,页头有重启按钮。

命令行

m-ui                                         数字菜单(见下)
m-ui run -db /etc/m-ui/m-ui.db               启动(systemd 用这个)
m-ui info -db <db>                           打印面板地址、路径、账号状态
m-ui set -db <db> key=value ...              改设置,如 webPort=3053 nodeMode=true
m-ui passwd -db <db> [-password 新密码]      重置管理员密码(同时关闭两步验证)
m-ui backup -db <db> -out 备份.zip           生成备份
m-ui restore -db <db> -from 备份.zip         还原备份(服务停止时)
m-ui import -from 旧面板.db -to <db>          从旧面板数据库导入
m-ui selfsign -hosts 域名,IP                 生成自签证书
m-ui render -db <db>                         打印并校验 sing-box 配置
m-ui version

不带参数运行 m-ui 进入菜单:

 1. 查看面板地址 / 账号          8. 查看最近日志
 2. 重启 m-ui                    9. 立即备份
 3. 停止 m-ui                   10. 更新到最新版
 4. 启动 m-ui                   11. 生成自签证书(无域名时)
 5. 重置管理员密码              12. 切换 主机 / 副机 角色
 6. 修改面板端口 / 路径 / 订阅端口   13. 关闭两步验证
 7. 重置全部设置                14. 卸载 m-ui

从旧面板迁移

整机迁移(线路、上游、用户、设置全部带过来):

bash install.sh --import /path/to/旧面板.db

导入保留全部入站端口、用户凭据、面板路径与订阅地址,客户端不用改任何东西;导入报告会列出核对结果。

只搬用户(线路已在 m-ui 上重新建好,只想把老用户的名称、用量、配额、到期带过来):用户页 从旧面板导入 上传 .db,或

m-ui import -from /path/to/旧面板.db -to /etc/m-ui/m-ui.db -users-only && systemctl restart m-ui

同名用户只更新用量 / 配额 / 到期 / 启停,新用户创建并沿用旧凭据,默认分配全部现有线路。

常见问题

客户端连不上,但订阅能刷新? 多半是客户端本地 DNS 把域名解析错了。m-ui 默认在订阅里直接写服务器 IP(域名只作 SNI),让用户刷新一次订阅;概览页"最近入站连接"能看到有没有该用户的 IP 到达服务器。

没有域名能用吗? 可以。证书页生成自签证书填 IP,订阅自动带允许不安全;有域名后再签正式证书,用户刷新订阅即可。

改了端口 / 监听地址不生效? 这些改动需要重启 m-ui(设置页页头有重启按钮,或菜单 2)。证书续期不需要重启。

WARP 启用失败? 运维页任务输出会给出原因;常见是 40000 端口被占。WARP 只作为本地 SOCKS5 上游,线路选上游 warp 即走 WARP 出口。

副机显示离线? 服务器页会显示原因(令牌错误 / 连接超时 / 证书校验失败)。副机用自签证书时在主机勾选"跳过证书校验"。

忘记密码 / 手机丢了进不去? SSH 执行 m-ui,菜单 5 重置密码(会同时关闭两步验证),或菜单 13 只关闭两步验证。

数据在哪? /etc/m-ui/m-ui.db(数据库)、/etc/m-ui/cert/(证书)、/etc/m-ui/backups/(定时备份)。备份 zip 含用户凭据与证书私钥,请妥善保管。

开发

需要 Go 1.22+。Reality 依赖 with_utls 构建标签,所有构建与测试都要带上:

make build          # 本机
make linux          # CGO_ENABLED=0 GOOS=linux 静态二进制
make test           # go test -tags with_utls ./...

前端是零构建的 ES modules(web/assets/),直接编辑刷新即可;内嵌资源按内容哈希生成 ETag,升级后浏览器自动拿到新文件。架构说明见 docs/ARCHITECTURE.md。

core/      内嵌 sing-box 生命周期、流量统计、连接跟踪、限速与设备数
render/    线路 → sing-box 配置渲染与校验
sub/       订阅生成(链接 / clash)、落地页、订阅服务
hub/       多服务器同步(快照推送、流量回收、在线聚合)
jobs/      统计、配额判定、清理定时任务
monitor/   上游巡检、看门狗、用户预警、日报
acme/      Let's Encrypt 签发(HTTP-01 / Cloudflare DNS-01)
backup/    备份与还原
ops/       WARP 与系统优化脚本
hop/       Hysteria2 端口跳跃(nftables / iptables)
ext/       外部节点 / 外部订阅抓取与解析
totp/      两步验证(RFC 6238)
web/       面板 HTTP API 与前端
importer/  旧面板数据库导入(兼容)
brand/     logo 与联系方式

发布:打 v* 标签后 GitHub Actions 自动测试、构建 amd64 / arm64 并发布 Release。

反馈与支持

面板右上角"建议 / 支持"里有作者的 Telegram 与打赏地址;也欢迎提 Issue / PR。

许可证

GPL-3.0。内嵌 sing-box,第三方来源声明见 NOTICE。

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package acme 用 Let's Encrypt 签发证书:http-01(临时监听 :80)或 dns-01(Cloudflare API), 并提供证书信息读取与签发前的 DNS/端口预检。
Package acme 用 Let's Encrypt 签发证书:http-01(临时监听 :80)或 dns-01(Cloudflare API), 并提供证书信息读取与签发前的 DNS/端口预检。
Package backup 生成与还原 m-ui 备份:一个 zip 内含数据库一致快照、证书文件与 meta.json。
Package backup 生成与还原 m-ui 备份:一个 zip 内含数据库一致快照、证书文件与 meta.json。
Package brand 统一放置项目标识与联系方式:logo(轻量 SVG)、作者 Telegram、打赏地址。
Package brand 统一放置项目标识与联系方式:logo(轻量 SVG)、作者 Telegram、打赏地址。
Package certutil 提供证书工具。
Package certutil 提供证书工具。
Package creds 生成与补全用户的各协议凭据,并提供 Reality/UUID/短 ID 等密钥生成。
Package creds 生成与补全用户的各协议凭据,并提供 Reality/UUID/短 ID 等密钥生成。
Package ext 处理外部节点:抓取外部订阅、解析成分享链接与 clash 代理,聚合进用户订阅。
Package ext 处理外部节点:抓取外部订阅、解析成分享链接与 clash 代理,聚合进用户订阅。
Package hop 实现 Hysteria2 端口跳跃:在本机用 nftables(回落 iptables)把一段 UDP 端口 DNAT/REDIRECT 到线路真实端口。
Package hop 实现 Hysteria2 端口跳跃:在本机用 nftables(回落 iptables)把一段 UDP 端口 DNAT/REDIRECT 到线路真实端口。
Package hub 实现主机(Hub)与副机(Agent)之间的同步:
Package hub 实现主机(Hub)与副机(Agent)之间的同步:
Package importer 从旧面板(兼容格式)数据库一次性迁移到 m-ui 数据模型。
Package importer 从旧面板(兼容格式)数据库一次性迁移到 m-ui 数据模型。
Package jobs 是数据面的"收账与执法"定时任务:
Package jobs 是数据面的"收账与执法"定时任务:
Package monitor 巡检与预警:定时检测上游连通性(故障/恢复告警)、数据面看门狗、 用户到期/用量预警、每日报告。
Package monitor 巡检与预警:定时检测上游连通性(故障/恢复告警)、数据面看门狗、 用户到期/用量预警、每日报告。
Package notify 通过 Telegram Bot 推送事件通知,并做同类事件的去重节流。
Package notify 通过 Telegram Bot 推送事件通知,并做同类事件的去重节流。
Package ops 提供运维能力:系统信息、Cloudflare WARP 一键安装/启停、系统优化(swap/sysctl/limits/NTP)。
Package ops 提供运维能力:系统信息、Cloudflare WARP 一键安装/启停、系统优化(swap/sysctl/limits/NTP)。
Package render 把 m-ui 数据模型(线路/上游/用户)渲染成一份 sing-box 配置。
Package render 把 m-ui 数据模型(线路/上游/用户)渲染成一份 sing-box 配置。
Package runner 启动 m-ui 数据面:渲染配置 → 拉起内嵌 sing-box → 应用用户限速/设备数策略。
Package runner 启动 m-ui 数据面:渲染配置 → 拉起内嵌 sing-box → 应用用户限速/设备数策略。
Package sub 生成用户订阅:分享链接(link)与 clash 配置。
Package sub 生成用户订阅:分享链接(link)与 clash 配置。
Package totp 实现 RFC 6238 基于时间的一次性密码(6 位、30 秒、HMAC-SHA1), 与 Google Authenticator / Microsoft Authenticator / 1Password 等认证器 App 兼容,用于面板登录两步验证。
Package totp 实现 RFC 6238 基于时间的一次性密码(6 位、30 秒、HMAC-SHA1), 与 Google Authenticator / Microsoft Authenticator / 1Password 等认证器 App 兼容,用于面板登录两步验证。
Package upstream 解析代理分享链接为 m-ui 上游(类型 + sing-box 出站参数)。
Package upstream 解析代理分享链接为 m-ui 上游(类型 + sing-box 出站参数)。
util
Package web 提供 m-ui 管理面板:会话认证、REST API 与内嵌前端。
Package web 提供 m-ui 管理面板:会话认证、REST API 与内嵌前端。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL