Get Started on CAST Imaging Documentation

How to Use This Documentation

Mon, 01 Jan 0001 00:00:00 +0000

This documentation is organized by task, not by feature. Each section answers a specific question a user might have.

Learning paths by role

Developer

You want to find the impact of a change, trace a call path, or understand a piece of code.

Architect

You want to understand the structure of an application you have not seen before.

Quick Start — Windows

Mon, 01 Jan 0001 00:00:00 +0000

This guide gets you from zero to a working CAST Imaging instance on one Windows machine. It is designed for proofs of concept and demos.

Production deployments

For a production installation with multiple servers or Docker, see Install and deploy.

Before you start


Who this is for	IT administrator setting up a demo environment
Role required	Local administrator on the Windows machine
Prerequisites	Windows Server 2016 or later; 16 GB RAM minimum; internet access to download installers

Step 1: Install CAST Storage Service

CAST Storage Service is a pre-configured PostgreSQL package. It stores the results of the code analysis.

Quick Start — Docker / Linux

Mon, 01 Jan 0001 00:00:00 +0000

This guide gets you from zero to a running CAST Imaging instance using Docker. It covers Linux hosts and Windows hosts with Docker Desktop installed.

Production deployments

This guide is for quick evaluation. For a production Docker deployment, see Install with Docker.

Before you start


Who this is for	IT administrator or developer evaluating CAST Imaging
Role required	Docker user with permission to run containers
Prerequisites	Docker Engine 24+ and Docker Compose v2; 16 GB RAM; internet access to pull images

Step 1: Pull the CAST Imaging images

[TODO: docker pull commands and image registry details]

Log In and Navigate the Welcome Page

Mon, 01 Jan 0001 00:00:00 +0000

When you open CAST Imaging in a browser for the first time, you land on the login page. After login, the Welcome page is your starting point for any application.

Before you start


Who this is for	Any new CAST Imaging user
Role required	Any role
Prerequisites	CAST Imaging is installed and running; you have a username and password

Step 1: Log in

[TODO: Navigate to the CAST Imaging URL; enter username and password; click Log in]

Understand the User Interface

Mon, 01 Jan 0001 00:00:00 +0000

The CAST Imaging interface has four main areas. Understanding them helps you work faster.

Before you start


Who this is for	Any new CAST Imaging user
Role required	Any role
Prerequisites	You have logged in and opened an application

The four main areas

[TODO: Annotated screenshot showing the four areas]

Investigation panel (left)

The left panel controls what you see on the canvas. Use it to:

Switch between scopes (Application, Transaction, Module, etc.)
Select a specific transaction or module to display
Change the aggregation level (Level 1 to Objects)
Change the perspective (CAST Taxonomy, Modules, Services, Architecture)

Canvas (centre)

The canvas shows the graph. You interact with it by: