You are reading the documentation for an outdated Corteza release. 2024.9 is the latest stable Corteza release.

Upgrade Guide

This guide will help you upgrade your Corteza to the newest version in no time!

While there are internal safeguards in place that can prevent data loss or other kinds of disasters, make sure you backup your database before you do an upgrade. Refer to devops guide on backup procedure for details.

If you are upgrading multiple versions at the same time; for example from 2019.12 to 2020.9; you should follow all the upgrade guides between the two versions.

Recommended steps for Corteza upgrade

Especially before any major version upgrade we recommend that before upgrading your production you either:

  • upgrade your staging environment, or

  • deploy a temporary environment with a copy of the production database and do a test upgrade there

Steps to upgrade Corteza when deployed with docker-compose

  1. changing image versions in your docker-compose.yaml (or .env) file,

  2. pull new images from docker hub with docker-compose pull,

  3. recreate containers with docker-compose up -d.

Upgrading to 2021.3

After upgrade

Corteza Workflow

Corteza introduces workflows as an alternative to automation scripts. Workflows allow you perform the vast majority of automation script tasks while keeping them visual.

We highly recommend you migrate your automation scripts to workflows. Refer to the integrator guide for details.

Make sure you run partial provision for importing workflows and associated permissions:
docker-compose exec server corteza-server import /corteza/provision/300_automation

Templates

Corteza introduces templates as a standardized facility to handle and render documents based on generic templates. Prior to 2021.3 templates were handled either in Low Code modules or as .html files and rendered using our corteza-js/renderer package. As of 2021.3 you are able to define and render templates directly with the core system.

We highly recommend you move your templates to the new standardized facility. Refer to the integrator guide for details.

Authentication

Corteza reworks how the authentication system works. As of 2021.3 all of the authentication endpoints are removed and will no longer work.

If you were using the authentication endpoints to obtain a JWT token for API access you can use the JWT CLI command.

If you were using the authentication endpoints to authenticate users on your custom portals, you will need to register an auth client in the Corteza Auth panel and rework your authentication logic to use the OAuth 2 flow.