S5 - Dashboards + Analysis, Single Machine (Windows)

Install CAST Imaging with Dashboards and Analysis capability on a single Microsoft Windows machine

Overview

This guide covers installing CAST Imaging with Dashboards and Analysis capability on a single Microsoft Windows machine. Users can run analysis and view aggregated results through CAST Dashboards.

What is installed:

Component	Description
`imaging-services`	Front-end services: gateway, console, auth, SSO, control panel
`dashboards`	CAST Dashboards: Management, Engineering and Security
`analysis-node`	Analysis engine (requires CAST Imaging Core ≥ 8.4 - separate install)

When to use: Production environments that require analysis and Dashboards access but do not need the CAST Imaging Viewer.

The database instance is not included in the Windows installer. A PostgreSQL database must be installed separately (on the same or another machine) before proceeding. See Database server install.

Requirements

Read and understand the following before starting:

CAST recommends disabling Quick Edit mode in your CMD window before running the install script. If Quick Edit is enabled, a mouse click will pause the script until a key is pressed.

Before you start

Install the database: Install PostgreSQL on this machine or another machine accessible on the network before starting. See Database server install for instructions.
Install CAST Imaging Core: CAST Imaging Core ≥ 8.4 is required on this machine (for the analysis-node component). Download and install it before running the global CAST Imaging installer:
- Download: com.castsoftware.imaging.core
- Installation instructions: Installing CAST Imaging Core
Extend Local Server: If your environment does not permit access to CAST Extend over the internet, you will need to install the Extend Local Server separately before completing this guide.

Step 1 - Download the installation media

Download the latest release of com.castsoftware.imaging.console from CAST Extend and unzip it anywhere on your local disk.

The folder path for the unzipped files must not contain any of the following characters: (, ), or !. The installer will fail if the path contains these characters.

The following files and folders will be created:

tools/ (folder)
cast-imaging-install.bat
cast-imaging-remove.bat
cast-imaging-update.bat
components-installers.zip
config-all.conf
config-imaging-services.conf
config-analysis-node.conf
config-imaging-viewer.conf
config-dashboards.conf

Step 2 - Configure the installation

Open config-imaging-services.conf, config-dashboards.conf, and config-analysis-node.conf (at the root of the installation media) in a text editor and update the installation variables.

Note

The same shared variable values must be identical across all *.conf files.

LICENSE_KEY and EXTEND_API_KEY (optional)

To avoid being prompted for the global license key and CAST Extend API key on first login, you can pre-configure these variables in config-imaging-services.conf:

LICENSE_KEY=<your-license-key>
EXTEND_API_KEY=<your-extend-api-key>

See Installation variables for details.

CAST_INSTALLATION_CONF (optional)

By default, the installer stores installation properties in:

%PROGRAMDATA%\CAST\CAST\.install

To use a different location, set the CAST_INSTALLATION_CONF Windows system environment variable to your preferred folder path before running the installer.

Firewall

For a single-machine deployment, open only port 8090 (TCP) inbound if you or your users need to access CAST Imaging from another machine on the network.

Step 3 - Run the installation

Open a CMD window with elevated permissions (right-click, Run as administrator) and run the following commands (one after the other) from the root of the unzipped files:

cast-imaging-install.bat package=imaging-services
cast-imaging-install.bat package=dashboards
cast-imaging-install.bat package=analysis-node

Step 4 - Verify the installation

Check that the following Windows Services are running (7 total):

Component	Service name	Port(s)
`imaging-services`	CAST Imaging Authentication	8092
`imaging-services`	CAST Imaging Console Service	8091
`imaging-services`	CAST Imaging Control Panel	2381, 8098
`imaging-services`	CAST Imaging Gateway Service	8090
`imaging-services`	CAST Imaging SSO Service	8096, 9002
`analysis-node`	CAST Imaging Analysis Node instance	8099
`dashboards`	CAST Imaging Dashboards	8097

All services are set to Automatic start. After a reboot, some services may fail to start because a dependent service has not started quickly enough. See Services startup checker for a tool that ensures all services are running.
All services run as LocalSystem unless you have configured a dedicated user via the START_AS_USER / START_AS_PASSWORD variables. See Installation variables and Software requirements.

Step 5 - Initial startup configuration

If you pre-configured LICENSE_KEY and EXTEND_API_KEY, this initialization screen will not be shown.

Browse to:

http://<IMAGING_SERVICES_HOSTNAME>:8090

Configure the Licensing strategy. Choose one of:

Named Application - each onboarded application requires its own dedicated license key
Contributing Developers - a global license key based on the number of contributing developers

License key

You can switch license key strategy after onboarding applications. See Manage your license keys.

Configure CAST Extend settings and Proxy settings:

CAST Extend settings

Verify that all components are available:

http://<IMAGING_SERVICES_HOSTNAME>:8090/admin/services

Services

Step 6 - Configure authentication

Out-of-the-box, CAST Imaging uses Local Authentication (admin/admin) managed by Keycloak.

CAST recommends switching to your enterprise authentication system (LDAP or SAML) before onboarding applications. Access the Keycloak UI using the kcadmin account (or the value of KEYCLOAK_LOGIN_ADMIN_USER if customized during installation). See Authentication for full instructions.