Skip to content
Documentation

Backup and Restore

Back up and restore Cherry Studio Enterprise PostgreSQL databases and application data, for both Docker and Kubernetes deployments.

Backup for Docker Deployment

PostgreSQL Database Backup

# Backup with docker-compose
docker-compose exec postgres \
  pg_dump -U cherry-studio-enterprise cherry-studio-enterprise > backup.sql

Application Data Directory Backup

# Stop container
docker stop cherry-studio-enterprise

# Backup data directory
tar -czf cherry-backup-$(date +%Y%m%d).tar.gz ./data

# Restart container
docker start cherry-studio-enterprise

PostgreSQL Restore

# Restore with docker-compose
docker-compose exec -T postgres \
  psql -U cherry-studio-enterprise cherry-studio-enterprise < backup.sql

Backup for Kubernetes (Helm) Deployment

PostgreSQL Database Backup

Method 1: Use pg_dump (recommended)

# Connect to PostgreSQL and dump database
kubectl exec -it deployment/cherry-studio-enterprise -- pg_dump -h $DB_HOST -U $DB_USERNAME $DB_NAME > backup.sql

Method 2: Backup via application data directory

If you need to back up other application data, it is stored in the PVC:

# Create a backup pod
kubectl run backup-pod --image=busybox --restart=Never \
  --overrides='{"spec":{"containers":[{"name":"backup","image":"busybox","command":["sleep","3600"],"volumeMounts":[{"name":"data","mountPath":"/backup"}]}],"volumes":[{"name":"data","persistentVolumeClaim":{"claimName":"cherry-studio-enterprise-data"}}]}}'

# Wait for pod to be ready
kubectl wait --for=condition=ready pod/backup-pod --timeout=60s

# Create archive inside the pod
kubectl exec backup-pod -- tar -czf /tmp/backup.tar.gz -C /backup .

# Copy backup file to local
kubectl cp backup-pod:/tmp/backup.tar.gz ./backup.tar.gz

# Delete backup pod
kubectl delete pod backup-pod

To simplify the process, use the script: helm/scripts/backup-database.sh

Backup Troubleshooting

If you see "timed out waiting for the condition":

1. Check PVC name

kubectl get pvc

2. Check pod status

kubectl get pod backup-pod
kubectl describe pod backup-pod

3. Manually clean up failed pods

kubectl delete pod backup-pod --force --grace-period=0

4. Use a step-by-step backup

# Create pod (without --rm)
kubectl run backup-pod --image=busybox --restart=Never \
  --overrides='{"spec":{"containers":[{"name":"backup","image":"busybox","command":["sleep","300"],"volumeMounts":[{"name":"data","mountPath":"/backup"}]}],"volumes":[{"name":"data","persistentVolumeClaim":{"claimName":"cherry-studio-enterprise-data"}}]}}'

# Wait for pod to be ready
kubectl wait --for=condition=ready pod/backup-pod --timeout=60s

# Run backup
kubectl exec backup-pod -- tar -czf /tmp/backup.tar.gz -C /backup .

# Copy file
kubectl cp backup-pod:/tmp/backup.tar.gz ./backup.tar.gz

# Delete pod
kubectl delete pod backup-pod