How to carry out updates for censhare components and tools.


Updating your censhare system involves different steps depending on your current version. This section mainly focuses on upgrading from 2022.1.x to 2022.2.x. If you are still on a version below this one, select a corresponding tabs for related instructions.

Select your current censhare version:

The adapted censhare WP architecture diagram shows which components are mentioned in this section. (Based on the diagram from here).



RPM (Linux servers)

The RPM package can be used for Linux-based server installations, mainly, on a CentOS server. With the RPM package, you can update the majority of censhare WP components that are also listed here. Below you will find the instructions for performing the updates.

Keycloak

You need to upgrade your Keycloak version to 20. Follow instructions on this page.

censhare Server, Static Resource Server, Cloud Gateway, Service Client, and additional services

The following commands will update core components. They can also be applied to optional services, including Mail Service, Google Cloud AI, and social media service. 

Package managers

Package managers are your installation helpers that execute the actual CLI commands.

We support Red Hat Linux distributions (see this section for more information). RHEL distributions use yum or dnf as package managers. For SuSE Linux the package manager is called zypper. The package managers are installed on the operating system by default. 

Run the commands below from the server where you want to install the RPM package, e.g. the server with a master role. 

  • Check for updates

yum check-update --enablerepo="censhare*"
CODE
  • Update packages. The following options are possible:
    • Update all packages including also anything else not censhare-related on the OS level: recommended
yum update --enablerepo="censhare*"
CODE
  • Limit your update to only censhare-related packages

    This will always update to all latest available censhare-Server bugfix releases and for CGW, SRS to the latest available release which might potentially not fit with the censhare-Server version. There could also be other issues with other censhare 3rd party packages like the censhare-Common or censhare-ImageTools updates.

yum update --enablerepo="censhare*" censhare*  
CODE
    • Update selected packages; a SRS example:
 yum update --enablerepo="censhare*" censhare-static-resource-server
CODE

Webpack bundles: uncustomized bundles

If you did not perform any customization on your censhare system, you can update your webpack bundles in a few easy steps.

  • Put the webpack-2022.x.x.tar.gz into the /opt/webpack repo on the SRS server.
  • Delete the existing censhare folder. 
  • Unpack the .tar.gz . This will create a new censhare folder. 

If you have customized your censhare system, the update needs to be performed differently. See censhare Web customizations section below.

censhare DB

The RPM includes a script that updates your database: DatabaseUpdate.sh . If you run the update commands from above on the server with a master role, that will also trigger the database update automatically. If not, you need to run the script manually under the corpus user.

Always back up your DB before updating

Regardless of the chosen method, please always backup your database before updating censhare. 

However, this backup should happen right before the update and a consequent dry run of the updated system. This prevents you from loosing any database records that could have been created by your users.

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 Release frontend bundles (partner login required to access instructions).

Render Client (Windows server)

censhare Render Client runs on a Windows server and is therefore not included in the RPM package. You can get it from the Download Portal. 

What‘s included in the archive

In the archive, you will find the Client itself as an executable as well as the automatic (re)start service, located in the service folder of the unzipped directory. 

For more information on starting the Render Client automatically, see censhare Render Client and InDesign Server as Windows service_SysAdmin and Automate InDesign Server start, stop, and restart.

In a nutshell, Render Client will be stopped on every server restart and won‘t start automatically. For this, you will need to activate the aforementioned service. 

Update Autostart Service

You need an admin user to perform this update. 

The instructions below are based on the assumption that you already have the autostart service. If no, please ignore the first step.

  1. In the service folder, run the RenderClient-UninstallService.bat script to uninstall your existing service version
    1. right-click
    2. Run as an administrator
  2. In the same folder, run the RenderClient-InstallService.bat script to install the new service version
    1. right-click
    2. Run as an administrator
  3. Configure the Logon as described here.



Desktop Clients: macOS and Windows

The desktop clients  – censhare Client and Admin Client – do not require any update procedure. You only need to get the new executables and run them on your PC or Mac.

Clients or their installers can be downloaded from the Download Portal. Both Windows and macOS versions are available for any censhare update. 

If you are already on censhare WP, still have version 2021.2 or higher , you can follow the instructions for updating from the version 2022.x (first tab from the left).

Starting from 2022.1.0, 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:

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

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

    yum install --enablerepo="censhare*" censhare-core-cloud-gateway
    CODE
  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:

    systemctl restart censhare.core-cloud-gateway
    CODE


When you upgrade from censhare below 2021.2, 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.

The main difference is between the webpack (WP) and non-WP versions. censhare WP starts from 2021.2.x.