Skip to main content

Updating Scriptix On-Prem

This guide covers how to update your Scriptix On-Prem installation to a new version.

Before You Update​

  1. Check the release notes — Scriptix will notify you of new versions with a changelog
  2. Back up your database (recommended):
docker exec api-scriptix-db-1 pg_dump -U scriptix scriptix | gzip > backup-$(date +%Y%m%d).sql.gz
  1. Note your current version in case you need to roll back:
grep IMAGE_TAG .env.onprem

Update Steps​

1. Get the New Version​

From Scriptix Container Registry:

Log in to the registry using the credentials provided by Scriptix, then update the version tag in your .env.onprem file (Scriptix provides the new tag in the release notes) and pull the new images:

docker compose -f docker-compose.onprem.yml --env-file .env.onprem --profile batch pull

Once pulled, the images are stored locally and do not require registry access to run.

From tarball (air-gapped):

docker load < scriptix-api-v1.1.0.tar.gz
docker load < scriptix-ui-v1.1.0.tar.gz
docker load < scriptix-asr-v1.1.0.tar.gz

# Update IMAGE_TAG in .env.onprem to match

2. Restart Services​

docker compose -f docker-compose.onprem.yml --env-file .env.onprem up -d

Docker Compose detects the new image tags and recreates only the containers that changed. Database migrations run automatically when the API starts.

3. Verify​

# Check all services are running
docker compose -f docker-compose.onprem.yml --env-file .env.onprem ps

# Check API health
curl http://localhost:8000/health

Rollback​

If something goes wrong after updating:

1. Revert the Image Tag​

Edit .env.onprem and set IMAGE_TAG back to the previous version (e.g., v1.0.0).

2. Restart​

docker compose -f docker-compose.onprem.yml --env-file .env.onprem up -d

3. Restore Database (if needed)​

Only necessary if the new version's migration caused issues (rare — migrations are designed to be additive):

# Stop the API first
docker compose -f docker-compose.onprem.yml --env-file .env.onprem stop api

# Restore from backup
gunzip -c backup-20260403.sql.gz | docker exec -i api-scriptix-db-1 psql -U scriptix scriptix

# Restart
docker compose -f docker-compose.onprem.yml --env-file .env.onprem up -d

Update Checklist​

  • Read the release notes
  • Back up the database
  • Load or pull new images
  • Restart services with docker compose up -d (migrations run automatically)
  • Verify health endpoint returns OK
  • Log in to the UI and confirm it loads
  • Run a test transcription

Automatic Updates​

Scriptix On-Prem does not auto-update. All updates are manual and initiated by you. This is by design — you control when and how updates are applied to your infrastructure.

Scriptix will notify you of new versions via email or your support channel.