Table of contents

Upgrade and rollback

Upgrading the on-premise version to a new immutable version with automatic rollback on failure.

Deployment methodThe commands on this page apply to the Docker Compose delivery. Open the matching Kubernetes and Helm procedure.

Upgrade

You do not need to re-download the package: upgrade.sh itself fetches the available version from the image registry and uses the saved access credentials.

bash
bash upgrade.sh

What the upgrade.sh script does

  • Checks .env, licensing keys and the Compose configuration.
  • Fetches the current version from the image registry.
  • Saves the old .env and Compose file to backups/pre-upgrade-<timestamp>-<pid>.
  • Pulls all images of the new version.
  • Recreates containers without deleting volumes and waits for all services to be healthy.
  • On failure automatically restores the old .env and previous images.
InformationPreviously pulled images are not removed during the upgrade — they remain in Docker and are used on rollback.

Version contract

The package version <X.Y> matches the image version in the registry and the VERSION variable in the delivered .env.

Rollback

On a failed healthcheck upgrade.sh rolls back automatically and prints the path to the rollback backup. Volumes and application data are not deleted during upgrade or rollback.

Verification after upgrade

After the upgrade, make sure the login page is available at https://<your-domain>/web/login and all platform services are healthy.