Step 1 - ensure deployment requirements are in placeEnsure that all requirements are in place. This includes the installation of any third-party software that is required to run CAST Imaging on Docker. Info |
---|
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 filesThe 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 extension | Required release | Notes |
---|
≥ 2.1.0-funcrel | com.castsoftware.imaging.docker | ≥ 1.1.0-funcrel | This extension supports Docker on Linux and Microsoft Windows. Does not require an installation of Python on the target server. | 2.0.0-funcrel | com.castsoftware.imaging.docker | 1.1.0-beta1 only |
LinuxDownload the Docker Installer extension from CAST Extend using curl: Code Block |
---|
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: Code Block |
---|
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: Code Block |
---|
.env
docker-compose.yml
etl
etl-automation
imaging
imaging.exe
LICENSE
login
logs
neo4j
nginx
server
-login
-sourcecode |
Microsoft WindowsDownload 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: Code Block |
---|
.env
docker-compose.yml
etl
etl-automation
imaging
imaging.exe
LICENSE
login
logs
neo4j
nginx
server
-login
-sourcecode |
These files and folders will be mounted by the CAST Imaging containers, therefore you must ensure that you add the parent folder path to the Resources > File Sharing tab in the Docker for Windows GUI. For example, if you unzipped them to D:\Imaging, then you need to add D:\Imaging to the File Sharing tab. Ensure that you click Apply and Restart so that the changes are taken into account: Image Removed Image Added
Info |
---|
If you do not see the File Sharing option, you are almost certainly still in Windows Containers mode. You must switch to Linux Containers mode. |
Step 3 - initial start-upStart 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: Code Block |
---|
Linux: ./imaging -s start
Microsoft Windows: imaging.exe -s start |
Info |
---|
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 accessBrowse 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"): Code Block |
---|
| http://localhost:8083 |
If the setup has been completed successfully, you will see the following login page in your browser: Click to enlarge Image Removed Image Added
By default, a "local" authentication system is active. The default login credentials are as follows: Info |
---|
For more information about managing authentication and permissions, see: |
Once logged in, you will see the following screen - this indicates that the login was successful. No applications will be visible in the list, since no data import has taken place yet. Warnings will be displayed application data access permissions if you are logged in with the "cast" user which does not have the ADMIN role:
|