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 release | Required Docker Installer release |
|---|---|
| ≥ 2.15.0-beta2 | Starting from 2.15.0-beta2 of CAST Imaging, the Docker Installer will be provided with every single release and should be used to install the specific release and upgrade to the specific release. |
| ≥ 2.14.x | ≥ 1.2.10-funcrel |
| ≥ 2.13.x | ≥ 1.2.9-funcrel |
| ≥ 2.12.x | ≥ 1.2.8-funcrel |
| ≥ 2.11.x | ≥ 1.2.7-funcrel |
| ≥ 2.10.x | ≥ 1.2.6-funcrel |
| 2.7.1-funcrel - 2.9.x-funcrel | 1.2.4-funcrel - 1.2.5-funcrel |
| 2.7.x-funcrel | 1.2.3-funcrel |
| 2.5.x-funcrel - 2.6.x-funcrel | 1.2.2-funcrel |
| 2.1.x-funcrel - 2.4.0-funcrel | 1.1.0-funcrel, 1.2.0-funcrel or 1.2.1-funcrel |
| 2.0.x-funcrel | 1.1.0-beta1 only |
Microsoft Windows
Download the Docker Installer extension from CAST Extend and unzip it to a working folder anywhere on the server.
Linux
Download the Docker Installer extension from CAST Extend using curl:
- ensure you enter an appropriate CAST Extend API key in <key>. See CAST Extend website or Download an extension using CAST Extend API for more information about this
- the command below will download the latest release of the Docker Installer as a ZIP file- if you need to install a different release, ensure you state the specific extension release number, for example https://extend.castsoftware.com/api/package/download/com.castsoftware.imaging.docker/1.1.0-funcrel
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 unzip the ZIP that has been downloaded - the file can be unzipped anywhere:
unzip com.castsoftware.imaging.docker.1.2.11-funcrel.zip
Step 3 - initial install and start-up
A set of files and folders is produced when the extension is unzipped. These files are configuration/properties files and folders specifically for the Neo4j database storage that are used by the CAST Imaging containers when they are started:
Files: .env docker-compose.yml imaging imaging.exe imagingsetup (only in ≥ 1.2.11) imagingsetup.exe (only in ≥ 1.2.11) LICENSE Folders: etl etl-automation login logs neo4j server
Hyper-V mode for Docker Desktop on Microsoft Windows
If you are using Hyper-V mode for Docker Desktop, you must ensure that you add the path to the installation files to the Resources > File Sharing tab in the Docker Desktop UI so that these files are mounted by the Linux containers.
When using Docker installer ≥ 1.2.11, you should add the path to the installed files, not the unzipped files.
When using Docker installer ≤ 1.2.10, you should add the path to the unzipped files.
For example, if you unzipped/installed the files 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.
Docker installer ≥ 1.2.11
In these releases, the Docker Installer files are first installed to a specific location and are then run from there. Run the following command to do all of the following:
- install the files to the default installation location:
- Linux: /opt/CAST/container-support/
- Microsoft Windows: C:\CAST\container-support\
- pull the most recent "funcrel" release docker images of CAST Imaging
- start the required containers
Linux: ./imagingsetup -i install Windows: imagingsetup.exe -i install
If you would like to install the files to a different location, use the following command instead - note that the folder MUST NOT already exist:
Linux: ./imagingsetup -d [custom_path] -i install Windows: imagingsetup.exe -d [custom_path] -i install
Docker installer ≤ 1.2.10
In these older releases, the files are simply unzipped and all commands are run from the location where the files have been unzipped. Therefore, move to the folder where the Docker Installer files were unzipped and start CAST Imaging with the following command. 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
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:
