Quick Start: Deploy the Server

If you want to quickly experience collaboration, import/export, and other server-backed capabilities, start here. For production, see Production Deployment.

When to Use

• Local evaluation or PoC
• Small internal testing
• No identity/permission integration yet

Environment Requirements

Compatibility:

• Linux kernel >= 3.10.0 (older kernels may have issues)
• Docker Compose >= 2.21
• Database: MySQL 8+, PostgreSQL 13+, compatible domestic databases (Dameng V8 included)
• Redis: 5.0+

One-Click Deploy to Docker Compose

Install

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

Install a specific version:

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

Offline install:

1. Download the offline package: https://univer.ai/releases/univer-server/download
2. Upload and extract on the server
3. Run bash load-images.sh to load images into Docker

The script creates a univer-server directory and starts the services automatically.

Start the Demo UI

cd univer-server && bash run.sh start-demo-ui

Visit http://localhost:3010. A blank document is created automatically. For collaboration, open the same link in another browser or incognito window.

Start the USIP Demo

USIP_ENABLED=true

Visit http://localhost:8080 to try it.

Common Commands

• Stop: cd univer-server && bash run.sh stop
• Start: cd univer-server && bash run.sh start
• Restart: cd univer-server && bash run.sh restart
• Uninstall: cd univer-server && bash run.sh uninstall

Update the Server

Run the installer again in the parent directory to upgrade while keeping config and data:

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

One-Click Deploy to K8s

If you already have a K8s cluster, you can use Helm:

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

Open http://univer.example.com/sheet/ to try it.

Uninstall:

helm uninstall univer-stack -n univer

Next Steps