前置条件
开始之前,请确保已安装以下内容:Docker
版本 20.10 或更高
Docker Compose
版本 1.29 或更高
你可以通过运行
docker --version 和 docker-compose --version 来验证 Docker 是否安装成功。安装步骤
1
克隆仓库
将 Mirobody Health 仓库克隆到本地:
2
配置文件初始化
根据示例文件创建你的配置文件:
3
添加 API keys
编辑
config.yaml 填写你的 API keys。OPENROUTER_API_KEY 和 GOOGLE_API_KEY 都是必填:config.yaml
4
使用 Docker 部署
运行部署脚本启动所有服务:这会启动三个服务:
- Backend API:端口 18080
- PostgreSQL:端口 5432
- Redis:端口 6379
等待所有服务启动完成;你会看到日志提示启动成功。
5
验证安装
打开浏览器访问:你应该能看到 Mirobody Health 的欢迎页面。
6
登录
使用默认 demo 账号或 登录后你可以:
config.yaml 中配置的账号登录:- 上传文件:检验报告、医疗记录与健康文档(参见文件处理)
- 与 AI 对话:基于你的健康数据提问
- 连接 providers:链接 Garmin、Whoop 等设备(参见使用 Providers)
测试 API
服务运行后,你可以测试以下 API endpoints:- Health Check
- List Providers
- MCP Interface
验证服务是否在运行:
可用 Endpoints
部署完成后,可用 endpoints 如下:Web Interface
主 Web 界面与文档
MCP Protocol
面向 AI agents 的 JSON-RPC 2.0 接口
Chat API
AI 对话接口 endpoint
History
会话历史 endpoint
Docker 服务
部署包含三个容器化服务:| Service | Port | Description |
|---|---|---|
| backend | 18080 | FastAPI application server |
| postgres | 5432 | PostgreSQL database |
| redis | 6379 | Redis cache and session store |
常用命令
停止所有服务
停止所有服务
重启服务
重启服务
查看日志
查看日志
重建容器
重建容器
进入数据库
进入数据库
进入 Redis CLI
进入 Redis CLI
故障排查
端口被占用
端口被占用
如果 18080 端口已被占用,请编辑 然后重启服务即可。
config.yaml:数据库连接失败
数据库连接失败
确保 PostgreSQL 容器在运行:查看数据库日志:
Redis 连接失败
Redis 连接失败
确认 Redis 在运行且可访问:正常情况下应返回
PONG。deploy.sh 权限不足
deploy.sh 权限不足
给脚本增加可执行权限:
下一步
现在你已经启动了 Mirobody Health:配置 Providers
为 Garmin、Whoop 等 providers 配置 OAuth 凭据
浏览 API
了解如何使用 Pulse API 链接用户并获取健康数据
理解架构
了解 Mirobody Health 如何处理并标准化健康数据
添加新 Providers
按照指南集成更多健康设备 Provider
生产环境部署请参考生产环境部署指南,包括安全加固与性能优化建议。