Update

Customers with PathcoreFlow deployed to an on-premise server or virtual machine (VM) will receive an email notification from Pathcore Support when a new version of the software is available.

It is recommended to perform a backup before making any changes.

It is recommended to keep the operating system of the server or VM hosting PathcoreFlow up to date. Instructions for maintaining your OS should be available from the vendor.

It is recommended to keep Docker Engine updated to the latest stable version. If you are running on one of their supported platforms, then these updates may be available in the same manner as other software updates.

Requirements

The operating system of the server or VM hosting PathcoreFlow should be up to date.
Docker Compose should have the latest stable updates.
The installer script (pathcoreflow-vX.Y.Z-installer.sh) provided by Pathcore Support for the target version.

Installing the Update

The message announcing the new version of PathcoreFlow should include an installer script which performs the update process. If you have not received this script with the announcement, please contact Pathcore Support.

The installer script will ensure that all of the base files for your PathcoreFlow installation are updated. Updating these files should be safe as any customizations to your Docker Configuration should be in a separate docker-compose.override.yml file, which is untouched.

It is recommended that you review the update process as well as any additional files and instructions provided with the announcement before proceeding.

These steps assume you have installed PathcoreFlow in the default directory: /opt/pathcore.

To update PathcoreFlow

This will cause the PathcoreFlow services to be temporarily unavailable.

Ensure you have a recent backup.
Transfer the installer script to the server or VM hosting PathcoreFlow. This is typically done via SSH File Transfer Protocol (SFTP) (e.g., the scp command) to somewhere temporary (e.g., /tmp)
Log in to the server or VM hosting PathcoreFlow and run the installer script, e.g.:
```
bash /tmp/pathcoreflow-v4.2.0-installer.sh
```
The script should be executed by a user with sudo access. Your password may be requested to perform some tasks.
You may be asked to provide the UID (User ID) and GID (Group ID) of the user that should own the database files. The suggested value should work for most deployments, but check with your system administrator if unsure
The installer script will do some initial checks, and display a summary of the changes to be performed. You will be prompted to confirm before any changes are made
You will be given the option to (re)install the systemd service. This is recommended if your operating system uses the systemd service manager
A summary is displayed after updating, and your PathcoreFlow service should be available with the new version

If you encounter a problem when updating, please contact Pathcore Support for assistance.

To rollback an update to PathcoreFlow

This action is potentially dangerous. Please ensure you have a recent backup before proceeding.

If you encounter a problem when updating or believe there is a need to revert to an earlier version of PathcoreFlow, it is recommended that you contact Pathcore Support for assistance.

When using the installer script to perform an update, another script to rollback to the previously installed version will be placed in the compose/scripts/ directory. This script will be named pathcoreflow-vX.Y.Z-rollback.sh, where "vX.Y.Z" is the previously installed version. For example, after updating from PathcoreFlow v4.1.3 to v4.2, the file would be pathcoreflow-v4.1.3-rollback.sh.

Support

Pathcore also offers specialized technical support services designed for on-premise deployments. These services are designed to support customer IT teams with installation and maintenance of Pathcore software.

These services can accommodate non-standard deployments and provide custom solutions when required. Ask your account manager for more information about support services we offer.