MSM Wiki

MSM 项目官方文档

Mosdns Singbox Manager - 统一管理平台文档

官方文档 • 使用与合规

---

📖 关于

这是 MSM (Mosdns Singbox Manager) 项目的官方文档站点，提供完整的使用指南、API 文档和部署说明。

🌐 在线访问

• 官方文档: https://doc.msmbox.net/zh/
• 使用与合规: https://doc.msmbox.net/zh/legal/

⚖️ 产品与使用边界

MSM 是用于管理用户自有或已获授权设备的自托管网络与系统管理平台。项目不运营代理节点、不提供违法内容，也不授权将 DNS、代理、隧道、端口扫描或远程管理能力用于未授权访问、侵害他人权益或其他违法活动。

• 使用与合规中心
• 合规使用规范
• 隐私与数据安全
• 免责声明
• 知识产权说明

🚀 本地开发

安装依赖

npm install

启动开发服务器

npm run docs:dev

访问 http://localhost:5173

构建生产版本

npm run docs:build

预览构建结果

npm run docs:preview

📁 目录结构

msm-wiki/
├── docs/
│   ├── .vitepress/
│   │   └── config.mts          # VitePress 配置
│   ├── public/
│   │   └── logo/               # Logo 资源
│   └── zh/                     # 中文文档
│       ├── index.md            # 首页
│       ├── introduction/       # 介绍
│       ├── guide/              # 用户指南
│       ├── api/                # API 文档
│       ├── deployment/         # 部署指南
│       ├── development/        # 开发指南
│       ├── faq/                # 常见问题
│       └── legal/              # 使用、隐私、免责与知识产权
├── .github/
│   └── workflows/
│       └── deploy.yml          # GitHub Actions 部署配置
├── package.json
└── README.md

📝 文档内容

介绍

• 什么是 MSM
• 核心特性
• 架构设计
• 技术栈

快速开始

• 安装部署
• 基础配置
• 首次使用

用户指南

• 用户管理
• MosDNS 管理
• SingBox 管理
• Clash 管理
• 配置编辑
• 历史记录与回滚
• 日志查看

API 文档

• API 概览
• 认证接口
• 用户接口
• 服务管理接口
• 配置管理接口
• 历史记录接口
• WebSocket 接口

部署指南

• 单机部署
• Docker 部署
• Systemd 配置
• Nginx 配置
• HTTPS 配置

开发指南

• 开发环境搭建
• 项目结构
• 前端开发
• 后端开发
• 贡献指南

🤝 贡献文档

欢迎贡献文档内容！

1. Fork 本仓库
2. 创建你的特性分支 (git checkout -b feature/AmazingDoc)
3. 提交你的修改 (git commit -m '添加某某文档')
4. 推送到分支 (git push origin feature/AmazingDoc)
5. 创建一个 Pull Request

📋 文档规范

• 使用 Markdown 格式
• 中文文档放在 docs/zh/ 目录
• 图片资源放在 docs/public/ 目录
• 遵循现有的目录结构和命名规范
• 保持文档简洁清晰，易于理解

🛠️ 技术栈

• VitePress - 静态站点生成器
• Vue 3 - 前端框架
• GitHub Pages - 托管平台
• GitHub Actions - 自动部署

🤖 自动化工作流

本项目包含智能化的每日构建工作流，具有以下特性：

AI 智能总结

• 使用 ModelScope Qwen3-30B-A3B 自动分析提交、正文、文件和 diff
• 生成“本次亮点 / 新增 / 变更 / 修复 / 备注”结构化版本总结
• 余额、配额或模型不可用时自动切换 Qwen3-14B、Qwen3-8B
• AI 全部失败时由本地规则生成完整多分类摘要，不丢失功能项

Release UI 优化

• 徽章展示（构建状态、版本号、平台）
• 折叠区域组织内容，提升可读性
• 直接下载链接和安装指南
• Docker 安装说明

自动更新文档

• 新版本信息自动同步到文档站点
• 旧版本自动归档到历史版本
• 包含 AI 生成的更新总结

智能提交范围

• 自动检测上一个版本 tag
• 获取从上个版本到当前的所有提交
• 无上一版源提交时降级到最近 100 条提交

详细配置和使用说明请查看：

• ModelScope API 配置指南 - 模型、配额和降级策略
• Release 工作流优化指南
• AI 技术实现详解

🔗 相关链接

• 问题反馈 - 报告文档问题
• 讨论区 - 讨论交流

---

Made with ❤️ by MSM Team