Updates

Updates are delivered via new Docker images. Backend, frontend, and all workers share a common repository and are updated together.

Before every update

Create a backup of all databases before performing an update. See Backups & Restore.

Procedure

1. Create a backup — see Backups & Restore
2. Pull new images:

   docker compose pull

3. Restart containers:

   docker compose down && docker compose up -d

4. Check status:

   docker ps -a

   All containers should show the status Running (healthy).
5. Check logs — see Logging

Database Migrations

The backend automatically runs pending database migrations on startup. Which container executes the migration (backend or worker) is controlled via a lock mechanism — see Databases — Initialization.

Check the logs after startup for successful migrations:

docker logs openvle-backend 2>&1 | head -50

Apache Guacamole

Apache Guacamole runs as a separate Docker stack and is updated independently from OpenVLE.

Database Schema

For major version updates of Guacamole, a manual update of the database schema may be required. Check the Apache Guacamole release notes for schema changes and run the provided upgrade scripts if necessary.

Frontend Cache

Browser Cache

After an update, it may be necessary to clear the browser cache so that the new frontend files are loaded.