Troubleshooting

GitHubEdit on GitHub

This guide covers common issues during install, startup, access, USIP, import/export, and upgrades.

Scope

  • Docker Compose or K8s deployments
  • USIP and Event Sync integrations
  • Import/export issues

Quick Triage

SymptomImmediate ActionNext Step
One-click script stuckcurl -I https://get.univer.aiUse offline package
Demo UI not accessiblecd univer-server && bash run.sh startdocker compose ps
USIP demo 8080 returns 404Check USIP_ENABLED=true in .env.custombash run.sh restart
Helm pods Pendingkubectl describe podCheck image/resources/PVC
Import/export PendingCheck temporal/exchange/universer logsSee Import/Export section

Docker Compose Issues

Install Failed

  1. Check network:
curl -I https://get.univer.ai
dig get.univer.ai
  1. Docker installation conflicts:
systemctl status docker
ps -ef | grep dockerd

Services Not Running / Restarting

cd univer-server
bash run.sh start
docker compose ps
docker compose logs --tail=200 <service>

Common causes: port conflicts, .env.custom not loaded, insufficient resources.

Demo UI Issues

  • Port conflict: lsof -i :3010
  • WebSocket disconnect: check reverse proxy/CORS
  • Auto-create doc failure: check universer logs

K8s Issues

Pod Pending

kubectl describe pod <pod> -n univer

Check: image pull, PVC, node resources.

CrashLoopBackOff

kubectl logs <pod> -n univer --previous

Ingress / Domain Access Failure

dig univer.example.com
kubectl get ingress -n univer
kubectl get endpoints -n univer

USIP Issues

SymptomCause
8080 not respondingEnsure bash run.sh start-demo-usip is executed
401/403 after enabling USIPCheck token pass-through and user response
Config not appliedRestart after editing .env.custom

Import/Export Pending

Investigation Path

  1. Disable VPN/proxy → bash run.sh restart
  2. Service status → docker compose ps
  3. Temporal logs → docker compose logs -f temporal
  4. Exchange logs → docker compose logs -f univer-worker-exchange
  5. Universer logs → docker compose logs -f universer

Common Errors

  • Temporal startup failure: port conflict or database issues
  • Exchange timeout: check Temporal address

Example: update exchange/config.yaml.template and restart:

addr: no-txt:///${TEMPORAL_HOST}:${TEMPORAL_PORT}

Upgrade & Uninstall

  • Docker Compose upgrade: rerun installer in parent directory
  • K8s upgrade: helm upgrade --install ... -n univer
  • Data still exists after uninstall: check PVC reclaim policy or volumes

Logs & Collection

ServiceCommand
temporaldocker compose logs -f temporal
exchangedocker compose logs -f univer-worker-exchange
universerdocker compose logs -f universer

Package logs:

mkdir -p logs_collect && \
docker compose logs temporal > logs_collect/temporal.log 2>&1 && \
docker compose logs universer > logs_collect/universer.log 2>&1 && \
tar czf univer-troubleshoot-logs.tar.gz logs_collect

Checklist

  • Services are Up / Pods Ready
  • No errors in temporal/exchange
  • Ports and domains are accessible
  • Config changes applied after restart
  • Import/export tasks can complete

How is this guide?