Quickstart

Simple instructions to get you up and running with CAST Imaging 3.x on a single Microsoft Windows machine

Overview

Instructions for installing CAST Imaging 3.x on one single Microsoft Windows machine: this quickstart guide covers the installation and initial configuration of the required components, basic analysis and information about accessing and consuming your results and is aimed at those wanting up and running quickly and use the installation from the same Microsoft Windows machine (e.g. for POCs/demos etc.). The following steps are explained:

Installation instructions for Docker can be found here.

Prerequisites

  • Physical or virtual machine
  • 64bit Windows 10/11, Windows Server 2016/2019/2022
  • 16GB RAM minimum (32GB RAM recommended)
  • 256GB SSD minimum
  • Java JDK (≥ 17 LTS and ≤ 20 64bit), with appropriate %JAVA_HOME% system environment variable
  • Local administrator privileges (ability to Run as administrator)
  • A valid global license key
  • A valid CAST Extend API key
  • Unused TCP ports:
    • As defined here
    • CAST Storage Service:
      • 2284

Ensure that no existing installations of CAST Storage Service, CAST Imaging Core, CAST Imaging Console/Node (v1/v2/v3) or CAST Imaging Viewer (v1/v2/v3) are present.

Install CAST Storage Service

Download the latest release of com.castsoftware.css and unzip it anywhere on your local disk. To run the installer, execute the setup.bat file with elevated permissions (right click, Run as administrator) at the root of the unzipped files. The install process will then proceed. CAST recommends leaving all settings at their default position.

CAST Storage Service is a PostgreSQL database used by CAST Imaging to store configuration and analysis results.

  1. Download and unzip the latest release of com.castsoftware.css on your local disk.
  2. Execute the setup.bat file with elevated permissions (right click, Run as administrator) at the root of the unzipped files.

Note: Leave all settings at their default position.

After successful installation you will find a functioning CAST Storage Service (CSS) on localhost:2284 with operator/CastAIP default credentials.

Install CAST Imaging Core

CAST Imaging Core is the analysis engine providing core services to the CAST analyzers.

  1. Download and unzip the latest release of com.castsoftware.aip on your local disk.
  2. Execute the setup.bat file with elevated permissions (right click, Run as administrator) at the root of the unzipped files.

Note: Leave all settings at their default position.

Install CAST Imaging Console and CAST Imaging Node Service components

CAST Imaging Console is the web application used to launch analyses of your application. CAST Imaging Node Service provides communication between CAST Imaging Cnsole and the CAST Imaging Core.

  1. Download and unzip the latest release of com.castsoftware.imaging.console on your local disk.
  2. Locate the config_installer.conf file at the root of the unzipped files and open it with a text editor. Check that all parameters match your installation requirements. A full explanation of each parameter is provided in Installation on Microsoft Windows, but leaving the settings at their default will provide a working installation.
  3. Open a CMD window with elevated permissions (right click, Run as administrator) and execute the following command from the root of the unzipped files:
    cast-imaging-console-install.bat configFile=config_installer.conf
    
  • A database called keycloak_v3 will be created on the CAST Storage Service for storing authentication data. Note: If this database already exists it will be re-used and this may cause unexpected behaviour.
  • Persistence schemas called admin_center and analysis_node will be created in the database of your choice on the target CAST Storage Service/PostgreSQL instance. Note: If these schemas already exist they will be re-used and this may cause unexpected behaviour.

Install CAST Imaging Viewer

  1. Download and unzip the latest release of com.castsoftware.imaging.viewer on your local disk.
  2. Execute the ImagingSystemSetup.exe file at the root of the unzipped files.
  3. Configure the following options in the installer to point to your CAST Imaging Console installation.
    • Eureka host: set to localhost
    • Eureka port: 8098 the default port of the Imaging Control Panel service.

      CAST Imaging Viewer installer

Complete initial configuration

The CAST Imaging Console component will be opened in your default browser (alternatively browse to http://HOST_HOSTNAME:8090 where HOST_HOSTNAME is what you have entered as Eureka host in the proceeding section).

  1. Login using the default admin/admin credentials. You will be prompted to configure:

    • your licensing strategy. Choose either a Named Application strategy (where each application you onboard requires a dedicated license key entered when you perform the onboarding), or a Contributing Developers strategy (a global license key based on the number of users):

      License key

    • CAST Extend settings (API key/proxy):

      CAST Extend settings

  2. Browse to the URL below and ensure that you have one node and the CAST Imaging Viewer components listed:

    http://localhost:8090/admin/services
    

    Services

Onboard a simple application

Prepare your source code

Prepare a ZIP file containing the source code to onboard and analyze:

  1. Create a temporary folder
  2. Add your client code in one sub-folder
  3. Add your database code in another sub-folder
  4. Zip the two sub-folders into one single ZIP file

For example:

D:\temp
    |---JEE
    |---SQL

Onboard your new application

  1. Browse to http://localhost:8090/home/applications
  2. Click Onboard application
  3. Enter a name for your application (1)
  4. Click the upload button (2) to attach the ZIP file you created previously:

    Onboard app

  5. Click Run Scan (1) to begin the initial “fast scan” of your source code: this allows CAST to discover what is in the ZIP file and how to handle it during the analysis process:

    Run scan

Start your analysis

When the ZIP file is scanned, results are automatically displayed.

  1. Scroll to the bottom of the page
  2. Check the panel at the bottom: if you have a green tick (1), you are good to go and you can start the analysis process (2):

    Alt text

If you do not have a green tick, you need to re-organize the source code in your ZIP file.

Consult your results

When the analysis is complete, browse to http://localhost:8090/home/applications, and click Ready to view for your application:

Ready to view

The results of your application analysis will be displayed in CAST Imaging Viewer. Use the left hand panel, or double click items in the “view” to navigate your application and the objects within it:

Results