Quickstart

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

Overview

Instructions for installing CAST Imaging v3 on one single Microsoft Windows machine from scratch: 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:

Overview
Requirements
Install CAST Storage Service
Install CAST Imaging Core
Install CAST Imaging
Complete initial configuration
Onboard a simple application

Note

Installation instructions for Linux via Docker can be found here.

Requirements

See Requirements.

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.

Download and unzip the latest release of com.castsoftware.css on your local disk.
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 8.4 is the analysis engine providing core services to the CAST analyzers.

Download and unzip the latest release of com.castsoftware.imaging.core on your local disk.
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

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

Download and unzip the latest release of com.castsoftware.imaging.console on your local disk.
Locate the config-all.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 variables, but leaving the settings at their default will provide a working installation.
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-install.bat package=all
```

Note

A database called `keycloak_v3` will be created on the CAST Storage Service for storing authentication data. 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. If these schemas already exist they will be re-used and this may cause unexpected behaviour.

Complete initial configuration

CAST Imaging component will be opened in your default browser (alternatively browse to http://localhost:8090).

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):
- CAST Extend settings / Proxy settings:
Browse to the URL below and ensure that you have one node and the CAST Imaging Viewer components listed:
```
http://localhost:8090/admin/services
```

Onboard a simple application

Prepare your source code

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

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

For example:

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

Onboard your new application

Browse to http://localhost:8090/home/applications
Click Onboard application
Enter a name for your application (1)
Click the upload button (2) to attach the ZIP file you created previously:
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:

Start your analysis

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

Scroll to the bottom of the page
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):

Note

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