metapi/docs/deployment.md

🚢 部署指南

返回文档中心

---

支持的运行方式

场景	推荐方式	对外访问方式	数据位置
云服务器 / NAS / 家用主机长期运行	Docker / Docker Compose / Zeabur	固定服务地址，例如 http://your-host:4000 或反向代理域名	你挂载的 DATA_DIR / 持久化卷
个人电脑本地使用	桌面版安装包	桌面窗口；如需本机客户端直连，使用日志中打印的 http://127.0.0.1:<port>	Electron app.getPath('userData')/data
二次开发 / 调试	本地开发	前端 http://localhost:5173，后端默认 http://localhost:4000	仓库内 ./data 或自定义 DATA_DIR

Note

• 当前不再提供 Release 压缩包 + Node.js 运行时的独立部署路径。
• 生产/长期运行请用 Docker 系列方案；桌面版面向单机本地使用；源码运行请走本地开发流程。

Zeabur 一键部署

点击按钮即可一键部署到 Zeabur，无需手动配置 Docker 或服务器。

模板会自动完成：

• 拉取 1467078763/metapi:latest 镜像
• 配置 HTTP 端口（4000）
• 挂载持久化存储（/app/data）
• 分配域名

部署时需要填写以下变量：

变量	说明
AUTH_TOKEN	后台管理员登录令牌（请设置强密码）
PROXY_TOKEN	下游客户端调用 /v1/* 时使用的 Bearer Token
TZ	服务时区，影响定时任务和日志（如 Asia/Shanghai）
PORT	内部监听端口（默认 4000，一般无需修改）

部署完成后，通过 Zeabur 分配的域名访问后台管理面板即可。

---

Docker Compose 部署（推荐）

标准步骤

mkdir metapi && cd metapi

# 创建 docker-compose.yml（参见快速上手）
# 设置环境变量
export AUTH_TOKEN=your-admin-token
export PROXY_TOKEN=your-proxy-sk-token

# 启动
docker compose up -d

使用 .env 文件

如果不想每次 export，可以创建 .env 文件：

# .env
AUTH_TOKEN=your-admin-token
PROXY_TOKEN=your-proxy-sk-token
TZ=Asia/Shanghai
PORT=4000

docker compose --env-file .env up -d

⚠️ .env 文件包含敏感信息，请勿提交到 Git 仓库。

Docker 命令部署

docker run -d --name metapi \
  -p 4000:4000 \
  -e AUTH_TOKEN=your-admin-token \
  -e PROXY_TOKEN=your-proxy-sk-token \
  -e TZ=Asia/Shanghai \
  -v ./data:/app/data \
  --restart unless-stopped \
  1467078763/metapi:latest

路径说明：

• ./data:/app/data — 相对路径，数据存到当前目录下的 data 文件夹
• 也可以使用绝对路径：/your/custom/path:/app/data

桌面版部署（Windows / macOS / Linux）

桌面版面向个人电脑本地使用，基本安装与配置流程见 快速上手 → 桌面版启动。

以下是部署相关的补充说明。

桌面版特性

• 内置本地 Metapi 服务，无需手动准备 Node.js 运行环境
• 托盘菜单支持重新打开窗口、重启后端、开机自启
• 支持基于 GitHub Releases 的应用内更新检查

Note

服务器部署不再提供裸 Node.js Release 压缩包，统一推荐 Docker / Docker Compose。

桌面版升级

1. 通过应用内更新提示安装新版本，或从 Releases 下载最新安装包覆盖安装
2. 用户数据目录会保留，升级后自动继续使用原有数据
3. 如需排查启动问题，优先查看 app.getPath('userData')/logs 下的最新日志

本地开发运行（源码调试）

开发、调试或提交 PR 的完整流程见 快速上手 → 本地开发启动 和 CONTRIBUTING.md。

Note

这条路径是开发流程，不是下载 Release 包后再手动跑 Node.js 的替代说法。

---

反向代理

以下反向代理配置面向 Docker / 服务器模式。桌面版内置后端默认只绑定本机 127.0.0.1，通常不作为公网服务直接暴露。

Nginx

流式请求（SSE）需要关闭缓冲，否则流式输出会异常：

server {
    listen 443 ssl;
    server_name your-domain.com;

    ssl_certificate     /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;

    location / {
        proxy_pass http://127.0.0.1:4000;

        # SSE 关键配置
        proxy_buffering off;
        proxy_cache off;
        proxy_set_header Connection '';
        proxy_http_version 1.1;
        chunked_transfer_encoding off;

        # 标准代理头
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # 超时设置（长对话场景）
        proxy_read_timeout 300s;
        proxy_send_timeout 300s;
    }
}

Caddy

your-domain.com {
    reverse_proxy localhost:4000 {
        flush_interval -1
    }
}

升级

# 拉取最新镜像
docker compose pull

# 重新启动（数据不受影响）
docker compose up -d

# 清理旧镜像
docker image prune -f

回滚

如果升级后出现问题，请参考 运维手册 → 数据备份与恢复 进行回滚。

核心思路：升级前备份数据目录（或数据库），出问题时停止服务、还原数据、指定旧版镜像重启。

数据持久化

不同运行方式的数据目录不同：

运行方式	数据目录	说明
Docker / Docker Compose / Zeabur	容器内 DATA_DIR（常见为 /app/data）	需要映射到宿主机目录或平台持久化卷
本地开发	DATA_DIR，默认 ./data	位于当前仓库工作目录
桌面版	app.getPath('userData')/data	不在仓库目录里，升级桌面应用时会保留

桌面版日志位于 app.getPath('userData')/logs；Docker / 本地开发模式的日志则跟随各自进程输出或你配置的日志目录。

只要备份了对应的数据目录，升级、重启通常都不会丢失现有配置和 SQLite 数据。

完整备份策略见 运维手册 → 数据备份。

---

下一步

• 配置说明 — 详细环境变量
• 运维手册 — 日志排查、健康检查