improvement(setup): complete knowledge and update flows (#6521)

This commit is contained in:
Theodore Li
2026-08-10 23:38:47 -04:00
committed by GitHub
parent daac4f38d4
commit 5478a690cc
15 changed files with 219 additions and 25 deletions
@@ -149,8 +149,8 @@ docker compose -f docker-compose.prod.yml logs migrations
# Is the scheduler firing?
docker compose -f docker-compose.prod.yml logs -f cron
# Upgrade: bump SIM_VERSION in .env, then
docker compose -f docker-compose.prod.yml pull && docker compose -f docker-compose.prod.yml up -d
# Upgrade: bump SIM_VERSION in .env when pinned, then
bun run sim update
```
<FAQ items={[
@@ -159,4 +159,3 @@ docker compose -f docker-compose.prod.yml pull && docker compose -f docker-compo
{ question: "How do I back up and restore the database?", answer: "Back up with: docker compose -f docker-compose.prod.yml exec db pg_dump -U postgres simstudio > backup.sql. Restore with: docker compose -f docker-compose.prod.yml exec -T db psql -U postgres simstudio < backup.sql. The database data is persisted in a Docker volume named postgres_data."},
{ question: "Can I customize the PostgreSQL credentials?", answer: "Yes. The docker-compose.prod.yml uses environment variable defaults: POSTGRES_USER (default: postgres), POSTGRES_PASSWORD (default: postgres), POSTGRES_DB (default: simstudio), and POSTGRES_PORT (default: 5432). Set these in your .env file to override them." },
]} />
@@ -142,11 +142,14 @@ kubectl logs -n simstudio deploy/sim-app -c migrations --tail=100
<Tab value="Docker Compose">
```bash
docker compose -f docker-compose.prod.yml pull
docker compose -f docker-compose.prod.yml up -d
bun run sim update
docker compose -f docker-compose.prod.yml logs migrations
```
`bun run sim update` pulls the versions configured by `SIM_VERSION` (or `latest` when it is
unset), recreates the changed services, and keeps data volumes. It is equivalent to running
`docker compose pull` followed by `docker compose up -d`.
There is a short window where the app is unavailable while containers restart. Compose has no rolling-update mechanism — plan a maintenance window, or run Kubernetes if you need zero-downtime upgrades.
</Tab>