通过 Docker 部署

Umo Editor Server 提供了通过 Docker 镜像部署的能力（位于 docker/ 中），您可以通过 Docker 部署 Umo Editor Server，您可以根据实际需要修改项目根目录下的 Dockerfile。

通过 Docker 部署，可以简化部署过程，尤其适合 内网部署 的情况。

0. 准备工作

安装 Docker 并登录。

如果需要构建多架构镜像，请额外确认本机已启用 docker buildx。

注意

当前 arm64 架构镜像暂不支持 PDF 和图片导出功能。如果您的部署场景需要使用 /export/pdf、/export/image/:format 或 /export/thumbnail，请使用 amd64 镜像。

1. 本地构建 Docker 镜像

默认会根据当前机器架构自动构建对应的单架构镜像，并导出为 tar 文件：

npm run build:docker

pnpm run build:docker

yarn build:docker

bun run build:docker

构建完成后：

• 本地镜像名称默认为 umo-editor-server:latest
• 导出的镜像文件默认为 ./docker/umo-editor-server.tar

如果您需要检查当前本地镜像的实际架构，可以执行：

npm run docker:inspect

如果您需要显式构建某一种架构，也可以执行：

npm run docker:build:amd64
npm run docker:build:arm64

如果您希望构建并导出指定架构的 tar 包，可以执行：

npm run build:docker:amd64
npm run build:docker:arm64

其中：

• amd64 镜像支持 PDF 和图片导出
• arm64 镜像目前不支持 PDF 和图片导出

2. 构建并推送多架构镜像

如果需要同时兼容 x86_64 和 arm64，可以使用：

DOCKER_IMAGE=your-registry/umo-editor-server:latest npm run docker:build:multiarch

该命令会基于 docker buildx 构建 linux/amd64 和 linux/arm64 两种架构，并直接推送到镜像仓库。

请注意，多架构镜像中的 arm64 变体同样不支持 PDF 和图片导出功能。

3. 加载本地导出的 Docker 镜像

# 在项目根目录下执行
docker load -i ./docker/umo-editor-server.tar

4. 启动容器

# 在项目根目录下执行
docker run -d --name umo-editor-server -p 1235:1235 umo-editor-server:latest

如果您修改了端口映射，例如 -p 8080:1235，则宿主机访问地址也会变为 http://127.0.0.1:8080。

5. 验证容器运行状态

# 查看容器运行状态
docker ps | grep umo-editor-server

6. 访问 Umo Editor Server

容器内服务默认监听 0.0.0.0:1235。如果使用 -p 1235:1235 启动容器，则可以通过浏览器访问 http://127.0.0.1:1235 查看服务是否正常运行。