Upgrade On Prem Instances

Minor and Hotfix / Patch Upgrades

For Minor and Hotfix / Patch Upgrades (https://semver.org/lang/de/) it is enough to replace the docker container with the newer version. Be sure to check out the Release Notesfor whats new.

Procedure

1. Please make a backup of your entire configuration this may include the following files. You can download the entire folder directly via <yourInstance.com>/config by rightclick on a folder and select download.

2. Shut down the portrait instance via docker-compose down. (stop is not enough)

3. Update the .env file to use the latest version:
   Example: (use the latest Minor version that is available) see https://install.portrait.app/ for all versions

   BACKEND_TAG=7.0.0 FRONTEND_TAG=7.0.0 PYTHON_RUNTIME_TAG=7.0.0

4. Startup the instance via docker-compose up -d

A general rule for how releases are handled can be found here: Release Strategy | Version Pattern.

Major Version Upgrade Matrix

Major Upgrades have breaking changes that could require you to manually update your configuration (application-prod.yml) and docker compose (docker-compose.yml). Check the Migration Guides and Release Notes for more details.