Summary: information about how to update to a newer release of CAST Imaging.


(tick)CAST Imaging installed

The target server must already have an existing installation of CAST Imaging installed on it.

How to update

Step 1 - Stop the instance and perform a backup

  • Stop CAST Imaging using the following command run from the existing Docker Installer path:
Linux: ./imaging -s stop
Microsoft Windows: imaging.exe -s stop
  • Perform a backup of the existing neo4j data folder. This process is detailed in CAST Imaging backup strategy.
  • Perform a backup of the existing Docker Installer files - simply copy the files to a different location.

Step 2 - Run the upgrade

Using the imagingsetup tool provided in Docker Installer ≥ 1.2.11-funcrel

  • This method will allow you to upgrade to the specific release of CAST Imaging provided by the installer, i.e. the 2.15.0-funcrel Docker Installer will allow upgrades to CAST Imaging 2.15.0-funcrel only.
  • This method is supported for those using Docker Installer ≥ 1.2.9-funcrel.

Docker Installer ≥ 1.2.11-funcrel has been changed and supports upgrading of the Docker Installer files themselves via a tool called imagingsetup (introduced in 1.2.11), meaning that any customizations that have been made to any of these Docker Installer configuration files will now be preserved during the upgrade process (this was not the case in the past). To proceed:

  • Download and unzip the required release of Docker Installer (≥ 1.2.11-funcrel) anywhere on the server and move into the unzipped folder.
  • Run the following command to install the Docker Installer files to the same path where the Docker Installer ≥ 1.2.9 files already exist - the installer will merge the existing and new files, preserving any customization that has been made. At the same time, brand new CAST Imaging images will be pulled (corresponding the the release of CAST Imaging supported by the Docker Installer) , the existing neo4j data will be re-used and the containers will be started:
Linux: ./imagingsetup -d [custom_path] -i update
Windows: imagingsetup.exe -d [custom_path] -i update

Using the imaging tool provided in any release of the Docker Installer

This method will allow you to upgrade to any release and must be used in the following situations:

  • When running Docker Installer ≤ 1.2.8
  • When running Docker Installer ≥ 1.2.9 and you want to upgrade to a release other than the release automatically pulled by the chosen Docker Installer.
  • Download and unzip the most recent release of Docker Installer anywhere on the server.
  • You now need to perform a manual comparison and merge of the Docker Installer files provided in the new download of Docker Installer and those in the existing release of Docker Installer that you are currently using. CAST recommends using a tool such as "diff" on Linux or "windiff" on Microsoft Windows to achieve this. Any files that have been changed or updated in the newer Docker Installer will need to be copied to the existing Docker Installer path and replaced. Note that any customizations that you may have made to any of the files will be lost and will need to be manually added back in.
  • Now run the following command from the existing Docker Installer path to tell CAST Imaging to pull new Docker images where version_number takes the following format:
    • most recent fully supported "funcrel" releases (examples only): X.X.X (e.g. 2.2.0-funcrel)
    • alpha/beta releases (examples only): X.X.X-alphaX or X.X.X-betaX (e.g.: 2.2.0-beta1)
Linux: ./imaging --update v=version_number
Windows: imaging.exe --update v=version_number
  • Brand new CAST Imaging images will be pulled for the release you have specified, the existing neo4j data will be re-used and the containers will be started. The merged configuration files will be used.

Step 2 - Test access

Browse to the following URL to check if users can access CAST Imaging. You may wish to check that access is possible from an unrelated machine on the internal network. Ensure you specify the correct server (change "localhost"):


Step 3 - Generate and import the Application data (optional)

With regard to Application data - all data that has already been imported into CAST Imaging will be retained after running the upgrade and can be viewed in the newly updated CAST Imaging installation without any further action. However, if you would like to use some new features introduced in specific releases you MAY need to generate and import the Application data again using the tools provided with the current release.

In ≥ 2.0.0, if you open an Application that requires updating, the following messages will be displayed: