Page tree
Skip to end of metadata
Go to start of metadata

Summary: CAST Imaging can be installed on Linux and Microsoft Windows operating systems as a set of docker containers. This section explains how to install CAST Imaging.

Step 1 - ensure deployment requirements are in place

Ensure that all requirements are in place. This includes the installation of any third-party software that is required to run CAST Imaging on Docker.

Installation of third-party software is out of scope of this documentation, however, some tips can be found in the following third-party documentation:

Ubuntu 

CentOS

Microsoft Windows

Step 2 - download and process the installation files

The CAST Imaging installation files for Docker are available as extensions published by CAST - see Docker Installer. Ensure you obtain the correct release/extension for your target release of CAST Imaging:

CAST Imaging releaseRequired Docker Installer release
≥ 2.11.x≥ 1.2.7-funcrel
≥ 2.10.x≥ 1.2.6-funcrel
2.7.1-funcrel - 2.9.x-funcrel1.2.4-funcrel - 1.2.5-funcrel
2.7.x-funcrel1.2.3-funcrel
2.5.x-funcrel - 2.6.x-funcrel1.2.2-funcrel
2.1.x-funcrel - 2.4.0-funcrel1.1.0-funcrel, 1.2.0-funcrel or 1.2.1-funcrel
2.0.x-funcrel1.1.0-beta1 only

Linux

Download the Docker Installer extension from CAST Extend using curl:

curl -O -J "https://extend.castsoftware.com/api/package/download/com.castsoftware.imaging.docker" -H "x-nuget-apikey: <key>" -H "accept: application/octet-stream"

Then unpack the ZIP that has been downloaded:

unzip com.castsoftware.imaging.docker.1.2.0-funcrel.zip

This location is where CAST Imaging will be run from and where the CAST Imaging data will be stored. A set of files and folders is produced when the extension is unzipped:

Files:
.env
docker-compose.yml
etl
etl-automation
imaging
imaging.exe
LICENSE

Folders:
login
logs
neo4j
server

Microsoft Windows

Download the Docker Installer extension from CAST Extend and unzip it to a working folder anywhere on the server - this location is where CAST Imaging will be run from and where the CAST Imaging data will be stored. A set of files and folders is produced when the extension is unzipped:

Files:
.env
docker-compose.yml
etl
etl-automation
imaging
imaging.exe
LICENSE

Folders:
login
logs
neo4j
server


If you are using Hyper-V mode for Docker Desktop, you must ensure that you add the parent folder path to the Resources > File Sharing tab in the Docker Desktop UI so that the installation files are mounted by the Linux containers. For example, if you unzipped them to D:\CAST\temp\DockerInstaller, then you need to add D:\CAST\temp\DockerInstaller to the File Sharing tab. Ensure that you click Apply and Restart so that the changes are taken into account:

This change is not required when using WSL2 mode.

Step 3 - initial start-up

Start CAST Imaging with the following command using terminal (Linux) or a CMD prompt (Microsoft Windows). This will pull the most recent "funcrel" release docker images of CAST Imaging and start them up:

Linux: ./imaging -s start
Microsoft Windows: imaging.exe -s start
CAST highly recommends running the commands from within the folder created when unzipping the extension, however, if you need to run them from outside the folder, ensure that on Microsoft Windows, the path to imaging.exe does not contain spaces/white space - the command will fail otherwise.

Step 4 - 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 - and if so, ensure that any firewall rules are created to allow access on port 8083. Ensure you specify the correct server (change "localhost"):

http://localhost:8083

If the setup has been completed successfully, you will see the following login page in your browser:

Click to enlarge

By default, a "local" authentication system is active. The default login credentials are as follows:

  • admin/admin
  • cast/cast

For more information about managing authentication and permissions, see:

  • No labels