GET STARTED · THREE PATHS

从适合你的起点开始

MIAO 是开源、可自托管的工作台。先选择你要验证的事情：在本地了解产品、把单个实例交给团队，或参与源码和公开 Issue。页面只引用仓库已有的安装与运维事实。

先说清楚边界这里没有 SaaS 套餐、云 SLA、自动扩容或企业支持承诺。生产域名、模型、邮件、备份恢复和反向代理都需要目标环境单独验收。

01 · LOCAL EVALUATION

本地评估

适合想先创建 workspace、查看示意和 API 入口的使用者。源码安装需要 Go 工具链；本地运行不会自动变成生产服务。

前置条件: 仓库源码、Go 1.27.1 工具链；Node.js/npm 只在构建浏览器 bundle 时需要。
实际产物: 本地 MIAO 进程、嵌入的 UI/PocketBase 和本地数据目录。
升级与支持: 跟随源码和 Release 记录；没有云端托管或生产 SLA。

查看源码安装阅读用户指南 →

源码路径已记录

02 · SINGLE-SERVER PRODUCTION

单机生产

适合把一个版本部署到自己的 Linux 或 macOS 主机。Go binary、嵌入式 UI、PocketBase migration 和数据目录一起管理。

前置条件: 支持的 x64/ARM64 主机、PM2、curl、openssl，以及由部署者维护的 HTTPS 反向代理。
实际产物: 版本化 binary、PM2 进程、配置文件和由部署者保管的数据目录。
升级与回滚: 升级前备份；PM2 管理进程切换。数据库不会自动回滚，恢复需按运维手册演练。

查看 Releases 查看自托管边界 →

需要目标环境验收

03 · CONTRIBUTE

参与开发

适合想修复问题、补充文档或讨论下一步能力的贡献者。公开 Issue 是事实入口，计划内容不会自动变成当前产品能力。

前置条件: GitHub 账号、源码仓库和一条清楚的问题或改动说明。
实际产物: Issue、Pull Request、文档修订或可复现的源码变更。
维护边界: 先对齐产品边界和验收证据；未公开的内部验证环境不作为访客前置条件。

打开公开 Issues 阅读贡献约定 →

公开协作入口

NEXT CHECK

选好路径之后

运维手册安装、配置、健康检查、升级、备份和恢复的事实来源 ↗更新日志区分 GitHub Release、源码记录和现场验收状态 ↗社区入口公开 Issue、Discussion、Release 和支持边界 ↗