Skip to main content

CxSAST Reporting Schedule Installation (Docker image)

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

Note

This is a Linux based image.

Installation steps

  1. Download the CxSAST Reporting Scheduler Docker image.

  2. Load the CxSAST Reporting Scheduler Docker image into your CxSAST Reporting Scheduler host Docker.

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

  3. Configure the CxSAST Reporting Scheduler settings using:

    • 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"

      A complete example is provided at the end of this guide.

    • Environment variables

      CONNECTION_STRING Required - Database connection string to a SQL Server.

  4. To startup the CxReportingService container, run the docker image with the following command:

    docker run `
--env-file=<vars.env file path> `
-v ~/cx-reporting-service:<value of REPORTS_OUTPUT_PATH env var> `
--restart always `
cx-reporting-scheduler:latest

Notice

If you intend to deploy the Manager and Client API images using docker compose, please refer to CxSAST Reporting Service Docker Compose Setup

Example

The following is an example of installing CxSASTReportingService in the same machine as CxSAST:

docker run -p 5002:5002 `
-v ~/cx-reporting-service:/app/CxReports
--env-file="/var/jenkins/workspace/reporting-service-validation_dev/pipelines/reporting-service/.env" `
cx-reporting-scheduler:latest

The vars.env file is configured as follows:

CONNECTION_STRING=Data Source=10.32.1.117\SQLExpress;Initial Catalog=CxDB;Integrated Security=False;User ID=testuser;Password=testpassword;Pooling=True
In this section: