部署到 Docker

我们提供了开箱即用的 Docker 部署方式，你可以通过 Docker Compose 快速部署 Univer 的后端服务。

配置要求

CPU: 1 核
内存: 2G
磁盘: 10G

技术架构

PostgreSQL + RabbitMQ

快速部署

系统环境：Linux、Mac、Windows/WSL

bash -c "$(curl -fsSL https://get.univer.ai)"

⚠️

如果在安装或使用过程中遇到问题，请查看常见问题。

打开浏览器输入 http://localhost:3010 后会自动创建空白文档并跳转到新文档链接（不支持IE浏览器）。

验证协同服务是否启动成功。

请尝试在不同类型浏览器或无痕模式下访问，以全面体验协同功能。

服务介绍

collaboration-server：协同引擎服务，采用 OT 算法处理编辑冲突。
lb：nginx 负载均衡组件。
universer：univer 后端接口服务，为 sheet、document、slide 提供 http 接口服务。
univer-minio：S3 组件，用于存储文件。
univer-postgres：数据库组件。
univer-rabbitmq：消息队列组件，用在协同编辑场景。
univer-redis：缓存组件。
univer-temporal：工作流组件，用在导入导出场景。
univer-worker-exchange：导入导出功能组件。

端口

检查端口是否被占用，若占用请结束其他进程后再尝试启动。

Univer 服务默认端口如下：

service	port	description
universer	8000	api http server
univer-minio	19000	s3 server
univer-client	3010	frontend

离线部署

如果你恰好需要在无互联网环境下部署，我们也提供了离线安装包，条件允许我们建议你在有网络环境使用一键安装脚本进行部署，这样便于后续升级。

下载离线安装包

点击链接下载离线安装包，将安装包解压到服务器。

tar -xvf 安装包.tar # 解压命令，将文件名替换为实际文件名

启动服务

进入解压目录，执行 bash install.sh 启动服务

验证服务是否可用

方式 1： 启动内置的演示程序，访问 http://localhost:3010 即可查看效果。

bash run.sh start-demo-ui

方式 2： 自行建立前端工程，了解更多。

卸载

bash uninstall.sh       # 卸载，保留数据下次使用
bash uninstall.sh clean # 卸载，删除数据

常见问题

服务的运行目录在哪里？

在docker-compose文件夹下，包含 .env 配置文件、 run.sh 启动脚本。

Windows 系统下启动失败？

运行脚本 run.sh 需要 bash 环境支持，请使用 Git Bash/MinGW 或 WSL 环境启动。

导入导出功能异常

首先，请通过浏览器开发工具检查下导入导出过程中响应体中是否存在 univer-minio 等字样，如果有，可能是 S3 配置不当导致的导入导出功能异常，请根据以下步骤检查和配置为正确的 S3 配置。

假设你使用安装时预置的 Minio 服务，打开 .env 文件，按下述说明将 S3_ENDPOINT_PUBLIC 配置项修改为 Docker 服务所在的公网或局域网 IP。

- S3_ENDPOINT_PUBLIC=http://univer-minio:9000
+ S3_ENDPOINT_PUBLIC=http://<Docker服务所在的公网或局域网IP>:19000

修改配置后请重启服务验证。

注意： 不应该配置成 localhost 和 127.0.0.1，这样会导致前端无法访问到 S3 服务。

如果你使用自己的 S3 服务，可以参考完整的S3 配置。

除了 S3 配置问题，你还应该检查前端工程中的 Univer Server 的导入导出API的配置是否正确。

如果依然还是有问题，可以使用 docker compose logs univer-worker-exchange --since 30m 导出日志，带上日志在社区寻找帮助。

拉取 docker hub 镜像失败？

编辑 docker-compose.yaml 文件，替换对应的镜像地址：

- image: nginx:alpine-slim
+ image: univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/release/nginx:alpine-slim
 
- image: postgres:${POSTGRES_VERSION}
+ image: univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/release/postgres:${POSTGRES_VERSION}
 
- image: rabbitmq:${RABBITMQ_VERSION}
+ image: univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/release/rabbitmq:${RABBITMQ_VERSION}
 
- image: bitnami/redis:${REDIS_VERSION}
+ image: univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/release/redis:${REDIS_VERSION}
 
- image: temporalio/auto-setup:${TEMPORAL_VERSION}
+ image: univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/release/temporal:${TEMPORAL_VERSION}
 
- image: bitnami/minio:${MINIO_VERSION}
+ image: univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/release/minio:${MINIO_VERSION}

如何排查服务启动报错？

你可以用 docker compose logs 命令查看服务日志，例如：

# 查看 universer 最近20分钟内的日志
docker compose logs -f universer --since 20m

如何重启、停止、卸载服务？

# 重启
bash run.sh
 
# 停止
docker compose stop
 
# 卸载
docker compose down
 
# 卸载并删除数据
docker compose down --volumes

怎样修改服务端口？

可以更新 .env 文件，然后执行 bash run.sh 重启。

# host ports
HOST_NGINX_PORT=8000
HOST_MINIO_PORT=19000
HOST_GRAFANA_PORT=13000

怎样修改成使用 MySQL 数据库？

MySQL 需要 >= 8.0 版本。
更新 .env 文件，设置 MySQL 相关配置并把 PostgreSQL 配置去掉。

docker-compose.mysql.yaml 文件提供了一个 MySQL 数据库组件，如果你想使用已有的数据库，可以将 univer-mysql 从 docker-compose.mysql.yaml 文件中删除，然后再把其他服务 depends_on 属性中的 univer-mysql 依赖去掉。
启动/重启服务：bash run.sh。

怎样修改 S3 配置以使用自己的组件？

更新 .env 文件，修改 S3 对应的配置。

S3_USER=minio
S3_PASSWORD=minio123456
S3_REGION=us-east-1
S3_PATH_STYLE=true
S3_ENDPOINT=http://192.168.1.100:9000
S3_ENDPOINT_PUBLIC=http://192.168.1.100:9000
S3_DEFAULT_BUCKET=univer

S3_USER=${ACCESS_KEY_ID}
S3_PASSWORD=${ACCESS_KEY_SECRET}
S3_REGION=oss-cn-shenzhen
S3_PATH_STYLE=false
S3_ENDPOINT=https://oss-cn-shenzhen-internal.aliyuncs.com
S3_ENDPOINT_PUBLIC=https://oss-cn-shenzhen.aliyuncs.com
S3_DEFAULT_BUCKET=univer

S3_USER=${ACCESS_KEY_ID}
S3_PASSWORD=${ACCESS_KEY_SECRET}
S3_REGION=us-east-1
S3_PATH_STYLE=false
S3_ENDPOINT=https://s3.amazonaws.com
S3_ENDPOINT_PUBLIC=https://s3.amazonaws.com
S3_DEFAULT_BUCKET=univer

S3_PATH_STYLE：true 表示 bucket 在路由路径；false 表示 bucket 在域名上。
S3_REGION：地区，根据 s3 bucket 的位置配置。
S3_ENDPOINT：内网地址。
S3_ENDPOINT_PUBLIC：公网地址，用于下载文件。
S3_DEFAULT_BUCKET：s3 存储桶，需要在启动 univer 服务前先创建好。

在 docker-compose.yaml 文件中删除掉 univer-minio 服务，并删除掉其他服务中 depends_on 的依赖。
启动/重启服务：bash run.sh。

访问 8000 端口响应 `404 page not found`

8000 端口是 Univer Server 对外暴露的 API 端口，访问 / 返回 404 page not found 是正常现象，因为该路径下没有 API。

如果你在验证服务和功能是否正常，可以通过模板来快速建立前端工程进行验证。

如何配置允许跨域？

更新 configs/config.yaml.template 中的 http 配置，然后重启服务：

server:
  http:
    ...
    corsAllowOrigins:
    - "*"

corsAllowOrigins 是一个字符串数组，支持：

“*”：允许所有域名跨域，但不支持授权头信息比如 authorization、cookie。
“你自定义的源”：例如 http://localhost:3010，支持授权头信息。

如何修改 redis 配置以使用自己的组件？

更新 .env 文件，设置对应的配置：

REDIS_ADDR=univer-redis:6379
REDIS_USERNAME=
REDIS_PASSWORD=
REDIS_DB=0

REDIS_ADDR：redis 节点地址，如果使用 redis 集群，请使用逗号分开多个地址，例如 REDIS_ADDR=192.168.1.5:6001,192.168.1.5:6002,192.168.1.5:6003,192.168.1.5:6004
REDIS_DB: 如果使用了 redis 集群，该值只支持 0

在 docker-compose.yaml 文件中删除掉 univer-redis 服务，并删除掉其他服务中 depends_on 的依赖。
启动/重启服务：bash run.sh

如何修改 rabbitmq 配置以使用自己的组件？

更新 .env 文件，设置对应的配置：

# 单节点配置
RABBITMQ_HOST=univer-rabbitmq
RABBITMQ_PORT=5672
RABBITMQ_HTTPPORT=15672
RABBITMQ_USERNAME=guest
RABBITMQ_PASSWORD=guest
 
# 多节点配置
RABBITMQ_CLUSTER_ENABLED=false
RABBITMQ_CLUSTER_USERNAME=
RABBITMQ_CLUSTER_PASSWORD=
RABBITMQ_CLUSTER_ADDR=
RABBITMQ_CLUSTER_VHOST=/
RABBITMQ_CLUSTER_SCHEMA=amqp

RABBITMQ_CLUSTER_ADDR：使用逗号分开多个地址，例如：RABBITMQ_CLUSTER_ADDR=192.168.1.2:5672,192.168.1.5:5672,192.168.1.7:5672

在 docker-compose.yaml 文件中删除掉 univer-rabbitmq 服务，并删除掉其他服务中 depends_on 的依赖。
启动/重启服务：bash run.sh

升级版本出现“Error response from daemon: Conflict. The container name “/univer-postgres” is already in use by container”问题怎么处理？

新版修改了安装目录，需要先停止机器上旧版 univer 服务，再升级

docker compose ls
cd /xx/docker-compose
docker compose ps
docker compose down

如何部署其它版本服务？

利用 UNIVER_VERSION 环境变量控制要下载安装的版本，目前只支持从 0.5.0 版本开始。

UNIVER_VERSION=0.5.0 bash -c "$(curl -fsSL https://get.univer.ai)"

服务概述部署到 Kubernetes