S1 - All Components, Single Machine (Docker)

Overview

This guide covers installing the full CAST Imaging suite on a single machine using Docker. All components are deployed on one host.

What is installed:

When to use: POC, testing, demo, or small production environments. Ensure the host machine has sufficient resources to run all components - see Hardware requirements.

Requirements

Before you start

1. Air-gapped / offline environments: If your target machine does not have internet access, you must pre-download all required Docker images on an internet-connected machine and transfer them before running the installer. See the Air-gapped installation section below.

2. 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 installer using curl:

$ curl -# -O -J "https://extend.castsoftware.com/api/package/download/com.castsoftware.imaging.all.docker/<version>?platform=linux_x64" \
  -H "x-nuget-apikey: <api-key>" \
  -H "accept: application/octet-stream"

Where:

• <version>: use latest for the most recent release, or a specific version such as 3.6.0-funcrel
• <api-key>: your CAST Extend API key (obtain from https://extend.castsoftware.com/#/profile/settings )

Example for latest release:

$ curl -# -O -J "https://extend.castsoftware.com/api/package/download/com.castsoftware.imaging.all.docker/latest?platform=linux_x64" \
  -H "x-nuget-apikey: a9999a9a-c999-999d-999b" \
  -H "accept: application/octet-stream"

Unzip the resulting ZIP file anywhere on your local disk:

$ unzip /path/to/<installer>.zip -d /path/to/folder

Where:

• -d /path/to/folder: tells the unzip utility to unzip to a specific folder (omitting the option will unzip to the current folder)

The following files and folders will be created:

• cast-imaging-dashboards/ (folder)
• cast-imaging-node/ (folder)
• cast-imaging-services/ (folder)
• cast-imaging-viewer/ (folder)
• tools/ (folder)
• cast-imaging-install.sh
• cast-imaging-install-podman.sh
• cast-imaging-update.sh
• configuration.conf

Air-gapped installation

If the target machine(s) has no internet access, pull and export all required images on an internet-connected machine, then transfer and load them on the target machine(s) before running the installer.

On an internet-connected machine - pull and export each image:

$ docker pull <image>:<version>
$ docker save <image>:<version> -o <filename>.tar

Transfer all .tar archives to the target machine (secure copy or removable media).

On the target machine - load each image:

$ docker load -i <filename>.tar

Verify all images are available:

$ docker image ls

Required images:

After loading all images, open configuration.conf in a text editor and set:

OFFLINE_MODE=true

Step 2 - Configure the installation

Locate the configuration.conf file at the root of the unzipped files and open it in a text editor (nano or vi). See Installation variables for a full reference of all variables.

General rules:

• Use forward slashes for all paths
• Do not use localhost, 127.0.0.1, or simple hostnames for _HOSTNAME variables
• CAST recommends leaving port numbers at default values where possible

Note in particular:

IMAGING_SERVICES_HOSTNAME

Set this to the FQDN or static IP address of the host machine:

# Find your FQDN
$ hostname -f

# Or find your IP address
$ hostname -I

Then set in configuration.conf:

IMAGING_SERVICES_HOSTNAME=<your-fqdn-or-ip>

Leave all other xxx_HOSTNAME variables blank - they are not required for a single-machine deployment.

DB_MODE

Use DB_MODE (on the machine running imaging-services for multi-machine mode) to control whether the embedded PostgreSQL Docker container is used or an external PostgreSQL instance:

• DB_MODE=embedded (default) - deploys a postgres container as part of the installation
• DB_MODE=external - uses an existing external PostgreSQL instance (configure the relevant DB_* variables)

See Installation variables and Database requirements for details.

Neo4j memory settings (optional)

If you need to reduce Neo4j memory usage before installation (e.g. for a test deployment), edit the cast-imaging-viewer/.env file (on the imaging-viewer machine) and modify:

NEO4J_server_memory_heap_initial__size=<size>
NEO4J_server_memory_heap_max__size=<size>
NEO4J_dbms_memory_transaction_total_max=<size>

Default values are 12 GB each. See Customizing Neo4j for details.

Domain mapping (optional)

To isolate imaging-viewer results per domain in dedicated Neo4j databases, you can enable the domain/tenant mapping feature. CAST strongly recommends enabling this now, before any applications are onboarded - enabling it later in an existing installation causes irreversible loss of customizations (tags, saved views, post-it notes, custom objects).

Update the following variable in configuration.conf (on the imaging-services machine for multi-machine deployments):

IMAGING_DOMAIN_SYNCHRO_ENABLED=true

See Domain/tenant mapping feature for full details and prerequisites.

Firewall

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

Step 3 - Make the install script executable

Ensure the installation script is set to executable:

$ chmod +x cast-imaging-install.sh

Step 4 - Run the installation

Run the following command:

$ ./cast-imaging-install.sh all

Step 5 - Verify the installation

Check that all containers are running:

$ docker ps

You should see 13 containers (or 12 if using an external PostgreSQL instance):

Set permissions on the analysis-node data volume

Run the following command to ensure the root user has access to the persistent volumes shared with the analysis-node container:

$ chown -R 0:0 /opt/cast/shared

Replace /opt/cast/shared with the shared sub-folder of your INSTALL_DIR value if you changed the default.

Data storage

All analysis data is stored under the INSTALL_DIR path (/opt/cast by default).

Database data for the embedded PostgreSQL instance (DB_MODE=embedded) is stored in the Docker volume cast-imaging-db-data (view with docker volume ls). By default the data is stored under $INSTALL_DIR/cast-imaging-db-data/data (for example /opt/cast/cast-imaging-db-data/data). From 3.6.4-funcrel you can store it on a different host path by setting CAST_IMAGING_DB_DATA_VOLUME_PATH in configuration.conf (see Installation variables). If you reinstall imaging-services and this volume already exists, it will be reused and existing applications will remain visible.

Step 6 - Initial startup configuration

Browse to:

http://<IMAGING_SERVICES_HOSTNAME>:8090

Log in using the default credentials: admin / admin

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

Configure CAST Extend settings and Proxy settings:

Verify that all components are available:

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

Step 7 - 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.

Connect AI tools to your results

Next steps

• Configure HTTPS access
• Configure a reverse proxy

Uninstall