Updating censhare

How to carry out RPM-based updates for the censhare components and tools.

Update/upgrade from censhare 2021.x or below

When you upgrade from censhare 2021.1.1 or below, please note that there are significant changes! We highly recommend that you read the relevant guides carefully. Please plan more time and effort for your upgrade.

1. Check the upgrade notes in Release information.
2. Read the FAQs Technical FAQ censhare and Keycloak and Project FAQ censhare and Keycloak.
3. Install and configure Keycloak.
4. Migrate users to Keycloak. See Migrate users to Keycloak.
   This step is mandatory when you are upgrading from a non-Keycloak version. The step involves exporting the users in the censhare Admin Client first.  We recommend to carry out this task before the server is updated and down. 
5. Check for updates and follow the installation tutorial to install the relevant packages.
6. Follow the steps in censhare - Initial configuration to check if everything is in place
7. Migrate censhare Web customizations. You must build and deploy the customized frontend bundles to the censhare host. For more information, see the sections in Set up local Dev environment and (2022.1) Release frontend bundles.
8. Configure session handling
9. Check the Details section below for a short summary of mandatory steps. 

Details

In general, follow the steps above. The following steps just give a broad overview and list some important specifics.

Migrate users to Keycloak

Migrate users to Keycloak. See Migrate users to Keycloak.

This step is mandatory when you are upgrading from a non-Keycloak version. This step involves exporting the users in censhare-Admin first. therefore it is better to do this before the server is updated and down. 

Check for updates

yum check-update --enablerepo="censhare*"

Update packages

yum update --enablerepo="censhare*" PACKAGE_NAME  

# for example

yum update --enablerepo="censhare*" censhare-static-resource-server 

# or

yum update all --enablerepo="censhare*"

Update Cloud Gateway

The RPM package name for Cloud Gateway has changed from cloud-gateway to core-cloud-gateway.

On existing censhare installations that use the old package cloud-gateway with the default port, you must install the new package and release the port as follows: 

1. Backup the application.yml.

2. Remove the installed version of cloud-gateway:

   CODE

   yum remove --enablerepo="censhare* censhare-cloud-gateway  

3. Install the new package core-cloud-gateway:

   CODE

   yum install --enablerepo="censhare*" censhare-core-cloud-gateway

4. Copy the application.yml to the new installation directory core-cloud-gateway.

5. Make sure that the session handling is configured correctly in the Cloud Gateway. This is required not only for security reasons, but also to avoid broken UI and other issues. If the cg.censhareLogoutUrl parameter is missing in the application.yml, please add it. 

   See the respective section in the Configure session handling for more instructions. 

6. Restart the service:

   CODE

   systemctl restart censhare.core-cloud-gateway

Migrate censhare Web customizations

If you have customized the censhare Web frontend, you must build and deploy the customized frontend bundles to the censhare host.

For more information, see the sections in Set up local Dev environment and (2022.1) Release frontend bundles

Image storage location

For upgrade installations from a release censhare 2021.1.1 or below, you need to relocate your images to work with censhare.