快速开始
如果你想要快速体验需要Univer后端服务才能支持的功能,可以使用我们准备的一键部署版本:
一键部署到docker compose
环境要求:
- 操作系统:Linux、Mac、Windows(WSL)
- CPU: 至少1核
- 内存: 至少2G,如果想体验较大文件的导入导出,建议>4G
- 磁盘: 至少10G
- Docker23及以上版本,如果你已经安装了低版本的docker,请先升级;如果没有安装,安装脚本会为你安装docker官方版本
- 能够访问公共互联网
操作说明
执行以下命令,即可在当前目录自动下载安装并运行最新版本的Univer后端服务:
bash -c "$(curl -fsSL https://get.univer.ai)"
执行成功后,Univer后端服务已成功安装并启动。Univer后端服务会安装在当前工作目录下名为univer-server
的目录中。
接下来就可以启动我们准备好的前端demo来体验Univer服务端支持的功能了。
执行cd univer-server && bash run.sh start-demo-ui
,将启动前端demo,ctrl+c即可退出关闭。
成功启动后,即可浏览器打开:http://localhost:3010
体验。打开此链接后会自动创建一份新的空白文档并跳转到此文档的链接,如果想要体验协同编辑功能,可以在另一个浏览器或无痕窗口中再次打开此文档。
如果需要体验与自己的系统集成以对用户身份进行认证、权限管理,你可以按以下步骤操作:
- 在
univer-server
目录下创建名为.env.custom
的文件,在其中写入下述配置:
USIP_ENABLED=true
- 执行
bash run.sh restart
重启Univer后端服务 - 执行
bash run.sh start-demo-usip
启动demo服务 上述步骤都成功完成后,即可浏览器打开http://localhost:8080
体验。
另外,你可以通过univer-server
目录下的run.sh
来控制Univer后端服务的停止/启动/重启。
- 停止:
cd univer-server && bash run.sh stop
- 启动:
cd univer-server && bash run.sh start
- 重启:
cd univer-server && bash run.sh restart
- 卸载:
cd univer-server && bash run.sh uninstall
,注意,卸载操作将会删除你在体验过程中所创建的文档及其中包含的图片等所有数据,请谨慎操作。
更新以体验最新版本:
在Univer安装目录univer-server
的父目录下,再次执行安装命令 bash -c "$(curl -fsSL https://get.univer.ai)"
即可覆盖安装最新的版本。你之前的配置和数据都会保留。
一键部署到k8s
环境要求
Univer使用helm来完成在K8s上的部署,因此需要你先安装helm。请参照helm的官方安装指南完成安装。
helm需要访问你的K8s集群,你需要确保已经有了K8s集群,然后通过下列方式之一让helm能够访问:
- 确保在
~/.kube/config
配置了K8s集群的kubeconfig
文件 - 配置了
KUBECONFIG
环境变量,且值为你的kubeconfig
文件路径 - 在helm命令中使用参数
--kubeconfig
,参数值设置为你的kubeconfig
文件路径,如:helm install --kubeconfig your-kubeconfig-path
操作说明
现在就可开始安装了,执行以下命令安装Univer后端服务到你的K8s
helm install -n univer --create-namespace \
--set global.istioNamespace="univer" \
univer-stack oci://univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/helm-charts/univer-stack
kubectl rollout restart -n univer deployment/collaboration-server
kubectl rollout restart -n univer deployment/universer
安装完成即可打开http://univer.example.com/sheet/
开始体验。
你可以使用下述命令卸载:
helm uninstall univer-stack -n univer
执行下述命令,即可更新以体验最新版本:
helm upgrade --install univer-stack \
oci://univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/helm-charts/univer-stack \
-n univer
其他
体验版本功能受到了一些限制,比如文档同时协作编辑人数限制、导入文件大小限制等。如果你想要不受限制地体验,请前往章节许可证。