Installation on Microsoft Windows

Overview

This install option combines the following for direct installation on a single Microsoft Windows machine, or on two separate machines:

The CAST Imaging Core and CAST Storage Service/PostgreSQL instance components are not included but are required to complete the deployment. Additional CAST Storage Services/PostgreSQL instances can also be declared post install.

Please ensure that no existing installations of CAST Imaging Console/nodes (v1 or v2) or CAST Imaging Viewer (v1 or v2) are present.

Prerequisites

  • Physical or virtual machine(s)
  • 64bit Windows 10/11, Windows Server 2016/2019/2022
  • 16GB RAM minimum (32GB RAM recommended)
  • 256GB SSD
  • Java JDK (≥ 17 LTS and ≤ 20 64bit), with appropriate %JAVA_HOME% system environment variable
  • Machines with fixed IP address / hostname recommended
  • CAST Imaging Core installed on the machine where CAST Imaging Console will reside (latest release)
  • Access to a local or remote CAST Storage Service/PostgreSQL instance
    • A database called keycloak_v3 will be created on the target CAST Storage Service/PostgreSQL instance - if this database already exists it will be re-used and this may cause unexpected behaviour
    • Schemas called admin_center and aip_node will be created in the database of your choice on the target CAST Storage Service/PostgreSQL instance - if these schemas already exist they will be re-used and this may cause unexpected behaviour
  • Local administrator privileges (ability to Run as administrator)
  • A valid global license key
  • A valid CAST Extend API key
  • Unused TCP ports as defined here

Install CAST Imaging Console and node service components

Download the latest release of the installer and unzip it anywhere on your local disk. Locate the config_installer.conf file at the root of the unzipped files and open with a text editor. Modify this according to your installation requirements:

  • HOST_HOSTNAME: used for internal communication between components:
    • Enterprise mode (distributed deployment): configure the machine’s FQDN (fully qualified domain name) or its static IP address, e.g. imaging.corp.domain.com (you can obtain the current machine’s hostname by entering “hostname” in a terminal window (CMD or similar)).
    • Standalone mode (all components on one machine): use localhost.
  • PUBLIC_URL: an optional “public” hostname for the current machine to configure access to any of the components from other machines on your internal network
  • DELETE_ADDITIONAL_DATA_FOLDERS: leave this option set to blank (it is ignored during an installation).
  • SHARED_FOLDER, DELIVERY_FOLDER and DEPLOY_FOLDER: details of the folder paths for data storage for each node (each path must be distinct). CAST highly recommends using a mapped network share drive or use a UNC path of the network share, for example: \\server\console\shared etc., so that all nodes can access common data. If you are installing all components on one single machine, these paths can point to local paths on the machine itself. If no value is assigned, the paths will default to C:\aip-node-data\common-data, C:\aip-node-data\delivery and c:\aip-node-data\deploy.
  • CSS_INFOS: details of your local or remote CAST Storage Service/PostgreSQL instance in the format HOST_NAME:PORT, e.g. css.corp.domain.com:2284.
  • CSS_USER and CSS_PASSWORD: credentials for your CAST Storage Service/PostgreSQL instance (username/password).
  • V3_DB_NAME: the database you would like to use for the admin-center and aip-node schemas (postgres or other custom database).
  • INSTALL_DIR: root installation location for this installer, e.g. C:\Program Files\CAST\Imaging. If the chosen path is anything other thanC:\Program Files, it must not contain any white space.
  • DATA_DIR: Set the installation data folder (avoid using a network drive (even mapped)). A default data folder will be assigned if you do not provide a value here, as follows:
    • With INSTALL_DIR set to the default (or any folder in %PROGRAMFILES%), DATA_DIR will be automatically set to %PROGRAMDATA%\CAST\Imaging.
    • With INSTALL_DIR set to a custom location, then a folder called Data will be created in the root of INSTALL_DIR.
  • AIP_INSTALLDIR: CAST Imaging Core component installation location (i.e. where CAST Imaging Core is installed) e.g: C:\Program Files\CAST\8.3.

To run the installer, open a CMD window with elevated permissions (right click, Run as administrator) and execute the following command from the root of the unzipped files:

cast-imaging-console-install.bat configFile=config_installer.conf

The install process will then proceed: a successful installation will result in a functioning CAST Imaging Console and a CAST Node declared in CAST Imaging Console.

Install CAST Imaging Viewer component

The CAST Imaging Viewer component can be installed on the same machine as the CAST Imaging Console/node components (standalone mode) or on a separate dedicated machine (enterprise mode). Download the latest release of the installer and unzip it anywhere on your local disk. To run the installer, double click the ImagingSystemSetup.exe file at the root of the unzipped files. The installer is UI based and is straightforward.

Ensure that you configure the following options in the installer to point to your CAST Imaging Console installation (you can leave all other fields at their default):

  • Eureka host: the FQDN or IP address of the machine on which the CAST Imaging Console component has already been installed, e.g. imaging.corp.domain.com. If you are using standalone mode (all components on one machine) set localhost.
  • Eureka port: the CAST Imaging Control Panel service port number, 8098 by default.

CAST Imaging Viewer installer

The install process will then proceed: a successful installation will result in a functioning CAST Imaging Viewer component declared in CAST Imaging Console.

Initial start up configuration

The CAST Imaging Console component will be opened in your default browser on the machine it has been installed on (alternatively browse to http://localhost:8090 or http://PUBLIC_URL:8090). Login using the default admin/admin credentials. You will be prompted to configure:

  • your licensing strategy. Choose either a Named Application strategy (where each application you onboard requires a dedicated license key entered when you perform the onboarding), or a Contributing Developers strategy (a global license key based on the number of users):

License key

  • CAST Extend settings (API key/proxy):

CAST Extend settings

As a final check, browse to the URL below and ensure that you have at least one node and the CAST Imaging Viewer components listed:

http://localhost:8090/console/#/aic/manage/nodes
or
http://PUBLIC_URL:8090/console/#/aic/manage/nodes

Services

What is installed?

The following Microsoft Windows services, set to start automatically and running with LocalSystem:

CAST Imaging Console / node:

  • CAST Imaging Analysis Node
  • CAST Imaging Authentication
  • CAST Imaging Console Service
  • CAST Imaging Control Panel
  • CAST Imaging Gateway Service
  • CAST Imaging SSO Service

CAST Imaging Viewer:

  • CAST Imaging Viewer Frontend
  • CAST Imaging Viewer ETL
  • CAST Imaging Viewer Backend
  • CAST Imaging Neo4j Graph Database

All Microsoft Windows services will be set to “Automatic” start. This means that they will automatically start up whenever the host machine is started or rebooted. Note however that some services are dependent on other services and this means that it is possible that some services may fail to start if the dependent service has not yet completed its start up routine. Dependencies exist as follows:

  • CAST Imaging SSO Service and CAST Imaging Console Service require that the CAST Storage Service/PostgreSQL instance (on which the keycloak_v3 database and the admin-center / aip-node schemas are stored) is available
  • CAST Imaging Gateway Service and CAST Imaging Analysis Node services require that the CAST Imaging Console Service is available

CAST therefore recommends changing the “Automatic” start to “Automatic (Delayed Start)” for the CAST Imaging Gateway Service and CAST Imaging Analysis Node service. “Automatic (Delayed Start)” ensures that these services are only started 120 seconds following the start up of the marchine. This should give time for the SSO/Keycloak and CAST Storage Service/PostgreSQL instance to complete their start up routine:

Delayed start

What about data/logs storage?

CAST Imaging Console:

  • All analysis data will be stored by default in C:\aip-node-data on the machine running CAST Imaging Console.
  • CAST Imaging Console component: all data, logs andconfiguration files will be stored in DATA_DIR unless you did not provide a location in which case the default folders are used as described above.
  • CAST Imaging Viewer: all data, logs and configuration files will be stored in the folders you defined during the installation.

Uninstall process

CAST suggests performing the uninstall in the order listed below.

CAST Imaging Viewer and CAST Imaging Core components

Use the Microsoft Windows Add or remove programs feature to uninstall the components.

CAST Imaging Console and node service components

The installation media contains a dedicated uninstaller called cast-imaging-console-remove.bat. Before running it, ensure that the config_installer.conf file (also provided in the installation media) contains the details of your installation: the various options are described above.

To avoid a prompt during the uninstall process, ensure that the DELETE_ADDITIONAL_DATA_FOLDERS is explicitly set to either true to force the removal of existing analysis data storage folders c:\aip-node-data\delivery/c:\aip-node-data\deploy/c:\aip-node-data\common-data or false to retain these folders. If you intend to perform a clean install you should ensure that these items are backed up (if necessary) and removed before proceeding with a new installation.

To run the uninstaller, open a CMD window with elevated permissions (right click, Run as administrator) and execute the following command from the root of the unzipped files:

cast-imaging-console-remove.bat configFile=config_installer.conf

This will remove all components and related Microsoft Windows Services, including the following database items (the uninstaller will use the config_installer.conf file to obtain details of the target CAST Storage Service/PostgreSQL instance):

  • keycloak_v3 database
  • admin_center schema
  • aip_node schema

What is not removed?

  • Any schemas associated with applications stored on your CAST Storage Service/PostgreSQL instance(s).