Upgrading

Consoletium uses semantic versioning. The version you are running is in https://<your-host>/api/health.

Release	Means	Before upgrading
Patch (1.4.2)	Fixes only.	Nothing; upgrade when convenient. Security fixes are marked as such: apply those promptly.
Minor (1.5.0)	New capability. Nothing you rely on changes.	Read the changelog.
Major (2.0.0)	Something you must act on: a setting renamed, an API field changed.	Read the upgrade notes in the changelog. Announced at least 14 days ahead.

Steps

1. Back up the database and the data volume (Backups). An upgrade may change the database structure, and the backup is the way back.
2. Set ERP_IMAGE in .env to the new version, e.g. ghcr.io/consoletium/consoletium-erp:1.5.0 (or check out the new tag if you build from source).

3. Pull or build, update the database, restart:

   docker compose pull                 # or: docker compose build
   docker compose run --rm backend python -m app.seed.db_migrate upgrade
   docker compose up -d
   

4. Check /api/health shows the new version, then sign in and open a few screens.

Database updates only ever move forward and are tested against the previous release's database before each release. Your licence is not affected by upgrading.

If something goes wrong

Stop the containers, set ERP_IMAGE back to the version you came from, restore the backup you took in step 1, and start again. Then write to support with the output of the db_migrate upgrade step.

Skipping versions is fine: db_migrate upgrade applies every change in between, in order.