Linux via Docker/Podman installation variables

Overview

A list and explanation of the variables available in the configuration.conf file used for an Installation on Linux via Docker/Podman.

Configure these parameters only in configuration.conf. Do not edit the .env files directly - they are generated by the installer from the values in configuration.conf.

Imaging Services

Variable	Description
`IMAGING_SERVICES_HOSTNAME`	Defines the FQDN (fully qualified domain name) or static IP address for the `imaging-services` component. Use `hostname -f` (FQDN) or `hostname -I` (IP address) to determine this value. Do not use `localhost`, `127.0.0.1`, or simple hostnames. In single machine mode, set this to the FQDN/IP of the host machine — all other `xxx_HOSTNAME` variables can be left blank. In distributed mode, set this on every machine to the FQDN/IP of the machine hosting `imaging-services`.
`IMAGING_SERVICES_PORT_GATEWAY`	Defines the TCP port number for the `gateway` service (default: `8090`). This is the main entry point for accessing CAST Imaging in a browser. CAST recommends leaving port numbers at default values where possible.
`IMAGING_SERVICES_PORT_AUTHORIZATION`	Defines the TCP port number for the `auth-service` (default: `8092`). CAST recommends leaving port numbers at default values where possible.
`IMAGING_SERVICES_PORT_CONSOLE`	Defines the TCP port number for the `console` service (default: `8091`). CAST recommends leaving port numbers at default values where possible.
`IMAGING_SERVICES_PORT_KEYCLOAK`	Defines the TCP port number for the `sso-service` (Keycloak) (default: `8096`). CAST recommends leaving port numbers at default values where possible.
`IMAGING_SERVICES_PORT_CONTROL_PANEL`	Defines the TCP port number for the `control-panel` service (default: `8098`). CAST recommends leaving port numbers at default values where possible.

Keycloak

Variable Description

Variable	Description
`KEYCLOAK_LOGIN_ADMIN_USER`	Available in ≥ 3.6.0-funcrel Defines the username for the Keycloak UI login admin user (see Authentication). Default value: `kcadmin`. The default password for this account is `admin`, however this is temporary — on first login to the Keycloak UI, the user will be prompted to change it. Note that the `admin` user is reserved strictly as an internal service account used for communication between CAST Imaging services and is not intended for Keycloak UI login.
`KEYCLOAK_SERVICE_ACCOUNT_PASSWORD`	Available in ≥ 3.6.0-funcrel Sets a custom password for the Keycloak internal service account `admin` (default password: `admin`). This account is used exclusively for internal service-to-service communication and is not intended for Keycloak UI login. Previously known as `KEYCLOCK_PASSWORD`.

KEYCLOAK_LOGIN_ADMIN_USER

Available in ≥ 3.6.0-funcrel

Defines the username for the Keycloak UI login admin user (see Authentication). Default value: kcadmin. The default password for this account is admin, however this is temporary — on first login to the Keycloak UI, the user will be prompted to change it. Note that the admin user is reserved strictly as an internal service account used for communication between CAST Imaging services and is not intended for Keycloak UI login.

KEYCLOAK_SERVICE_ACCOUNT_PASSWORD

Available in ≥ 3.6.0-funcrel

Sets a custom password for the Keycloak internal service account admin (default password: admin). This account is used exclusively for internal service-to-service communication and is not intended for Keycloak UI login. Previously known as KEYCLOCK_PASSWORD.

Domain synchronization

Variable	Description
`IMAGING_DOMAIN_SYNCHRO_ENABLED`	Enables or disables domain/tenant mapping. Set to `true` to enable this feature. Default value: `false` (disabled). CAST highly recommends enabling this as part of a fresh installation if you require it, as it is not straightforward to enable post-installation.

Database

Variable	Description
`DB_MODE`	Controls whether CAST Imaging uses an embedded or external PostgreSQL instance (see Database requirements). Set to `embedded` (default) to have CAST automatically create and manage a PostgreSQL container. Set to `external` to provide your own PostgreSQL instance and configure the connection parameters below.
`DB_HOST`	Hostname or IP address of the external PostgreSQL server. Only required when `DB_MODE=external`. Leave blank when `DB_MODE=embedded`.
`DB_PORT`	Port number for the PostgreSQL instance (default: `2285` for the embedded instance but can be customized; use `5432` or the appropriate port for an external instance).
`DB_USER`	Username for connecting to the embedded or external PostgreSQL instance (default: `operator`).
`DB_PASSWORD`	Plain-text password for the PostgreSQL user defined by `DB_USER` (default: `CastAIP`). Must always be present and must match the encrytped entry in `DB_ENCRYPTED_PASSWORD`.
`DB_ENCRYPTED_PASSWORD`	Encrypted alternative to `DB_PASSWORD`. Use the encryption tool provided in the `tools` folder of the installation media to generate the encrypted value. Must always be present and must match the plain text entry in `DB_PASSWORD`.
`DB_DATABASE`	Name of the PostgreSQL database in the embedded or external instance to connect to (default: `postgres`).

Imaging Viewer

Variable	Description
`IMAGING_VIEWER_HOSTNAME`	Defines the FQDN or static IP address for the `imaging-viewer` component. In single machine mode, leave this blank - the installer will use `IMAGING_SERVICES_HOSTNAME`. In distributed mode, set this to the FQDN/IP of the machine hosting the `imaging-viewer` component.
`IMAGING_VIEWER_SERVER_PORT`	Defines the TCP port number for the `imaging-viewer` server service (default: `9000`). CAST recommends leaving port numbers at default values where possible.
`IMAGING_VIEWER_FE_PORT`	Defines the TCP port number for the `imaging-viewer` front-end service (default: `8083`). CAST recommends leaving port numbers at default values where possible.
`IMAGING_VIEWER_ETL_PORT`	Defines the TCP port number for the `etl` service (default: `9001`). CAST recommends leaving port numbers at default values where possible.
`IMAGING_VIEWER_AI_SERVICE_PORT`	Defines the TCP port number for the AI service (default: `8082`). CAST recommends leaving port numbers at default values where possible.
`IMAGING_VIEWER_API_PORT`	Defines the TCP port number for the `imaging-apis` service (default: `8070`). CAST recommends leaving port numbers at default values where possible.

Analysis Node

Variable	Description
`IMAGING_NODE_HOSTNAME`	Defines the FQDN or static IP address for the `analysis-node` component. In single machine mode, leave this blank - the installer will use `IMAGING_SERVICES_HOSTNAME`. In distributed mode, set this to the FQDN/IP of the machine hosting the `analysis-node` component.
`IMAGING_NODE_PORT`	Defines the TCP port number for the `analysis-node` service (default: `8089`). CAST recommends leaving port numbers at default values where possible.
`IMAGING_NODE_INSTANCEID`	Uniquely identifies this node in the Control Panel service. The default format is `IMAGING_NODE_HOSTNAME-IMAGING_NODE_PORT`. Before modifying this value, be aware that it significantly impacts service startup. If changed, ensure no other node is already registered with the same ID. Leave blank to use the default.
`NO_OF_PARALLEL_JOBS_IN_NODE`	Available in ≥ 3.6.0-funcrel Sets the number of parallel jobs that can be executed at any one time on this node (default: `2`). Leave blank to use the default value. Note that this setting can also be changed post-installation via `NB_OF_THREADS_FOR_NODE` in `docker-compose.override.yml` - if that option is set, it will always override the value defined here. See Configure parallel analyses for more information.

Imaging Dashboards

Variable	Description
`IMAGING_DASHBOARDS_HOSTNAME`	Defines the FQDN or static IP address for the `dashboards` component. In single machine mode, leave this blank - the installer will use `IMAGING_SERVICES_HOSTNAME`. In distributed mode, set this to the FQDN/IP of the machine hosting the `dashboards` component.
`IMAGING_DASHBOARDS_PORT`	Defines the TCP port number for the `dashboards` service (default: `8097`). CAST recommends leaving port numbers at default values where possible.

General

Variable Description

INSTALL_DIR Root installation location where the properties and YAML files for each component will be stored (default: /opt/cast). During installation, three sub-folders are created here: core, installation, and shared. In distributed mode with multiple analysis-node components, the /opt/cast/shared sub-folder must be accessible in read/write mode to ALL analysis-node and the imaging-services instances (for example via a network mount). Do not share the parent folder /opt/cast. See also Docker/Podman file storage locations.

OFFLINE_MODE Set to true to run the installer without downloading Docker images from the internet. When enabled, all required images must already be available locally before proceeding. Leave blank or set to false for a standard online installation. See Running the installer without an internet connection.

Variable	Description
`INSTALL_DIR`	Root installation location where the properties and YAML files for each component will be stored (default: `/opt/cast`). During installation, three sub-folders are created here: `core`, `installation`, and `shared`. In distributed mode with multiple `analysis-node` components, the `/opt/cast/shared` sub-folder must be accessible in read/write mode to ALL `analysis-node` and the `imaging-services` instances (for example via a network mount). Do not share the parent folder `/opt/cast`. See also Docker/Podman file storage locations.
`OFFLINE_MODE`	Set to `true` to run the installer without downloading Docker images from the internet. When enabled, all required images must already be available locally before proceeding. Leave blank or set to `false` for a standard online installation. See Running the installer without an internet connection.

Do not change

The variables listed below are for internal use only. Do not change these values unless explicitly instructed to do so by CAST Support.

Variable	Description
`INTERVAL_HEALTH_CHECK`	Interval between health check attempts during installation (default: `10s`).
`TIMEOUT_HEALTH_CHECK`	Timeout for each health check attempt during installation (default: `10s`).
`RETRY_HEALTH_CHECK`	Number of health check retries during installation (default: `50`).
`IMAGING_SERVICES_VERSION`	Docker image tag for the `imaging-services` component.
`IMAGING_SERVICES_SSO_VERSION`	Docker image tag for the SSO service component.
`IMAGING_DASHBOARDS_VERSION`	Docker image tag for the `dashboards` component.
`IMAGING_VIEWER_VERSION`	Docker image tag for the `imaging-viewer` component.
`IMAGING_NODE_VERSION`	Docker image tag for the `analysis-node` component.