Skip to main content

CxSAST Reporting Portal Installation (Docker image)

Following is a step-by-step guide for installing the CxSAST Reporting Client API component as a Docker image.


This is a Linux-based image.

Installation steps


Dependency Requirements:

The Authorization Setup Script must be executed prior to the Client API Installation. The script and guide can be found at CxSAST Reporting Authorization Setup.

  1. Download the CxReportingPortal Docker image.

  2. Load the CxReportingPortal Docker image into your desired host Docker.

    docker image load --input <image filename>.tar

  3. Configure the CxReportingPortal settings using:

    o Docker .env file

    o Environment variables

    Docker .env file

    The image provided receives multiple parameters via environment variables. To pass them to the container, create a .env file with key-value pairs using the following format: KEY=value

    This file is then passed in the docker run command with the following option:

    --env-file="<path to file>\vars.env"

    The provided .env file must be the same as the one provided to CxSASTReporting Manager. For more information, refer to CxSASTReporting Manager Installation Guide (Docker image).

    Environment variables

    • REPORTING_API_URL Required - Endpoint for the client API. By default, our suggestion is (http://localhost:5555).

    • IDENTITY_PROVIDER_URL Required - Endpoint for the Access control host (http://<access control API address>:<port>).

  4. To start up the CxReportingPortal container, run the docker image with the following command:

    docker run -p 80:5001 `
    --env-file=<vars.env file path> `
    --restart always `
  5. You can verify that the installation was successful by checking <ip>:<port> on the browser.

    This should open the application correctly. The user is redirected to the CxSAST authentication page.