Skip to main content

How to run CxSAST Engine with Docker


How to:

  • Verify that your environment has an installation of Docker and Docker-Compose specific to your host’s OS.

  • Create the following files in a directory of your choice and set their contents to the sample contents given below, then update them according to the instructions in the Configuration section below.



    • docker-compose-activemq.yml

    If you run Docker on a Linux host, ‘sh’ scripts are provided for easy configuration. Otherwise, you’ll only need the ‘yml’ file with minor configurations.

  • Edit and insert environment-specific configuration to “” (Linux host only) or

    “docker-compose-activemq.yml” (any host OS). Configuration is further detailed in the appropriate section below.

  • Launch the container using ./ (Linux host only) or

    docker-compose -f docker-compose-activemq.yml up -d“ (any host OS)

    Note: If you are using the shell script, make sure it has execute permissions (chmod +x

  • When the container is up and running successfully in “detached” mode, it is possible to go into the running container with an interactive shell using: “docker exec -it cx-engine-service bash

  • To shut the container down, use ./ or

    docker-compose -f docker-compose-activemq.yml down


Before launching the container, configurations must be set to reflect the specific environment it intends to communicate. Currently, this is done manually by editing either ““ (recommended for Linux hosts) or “docker-compose-activemq.yml.“

Important: only the environment variables listed in the ‘yml’ file are those used by Engine Service. The environment variables in the shell ‘sh’ files are used only for the setup. If you wish to change the environment variables on a running container, look for them by name using the link above or by looking up their keys in the ‘yml’ file.

Breakdown of the values in the example above:

  • The environment contains an All-In-One installation on a laptop Windows machine with IP

  • A CentOS Linux VM, which will be the host of the dockerized Engine Service with IP

  1. This instance of Engine Service will use the message queue, so MESSAGE_QUEUE_DISABLE key is empty.

  2. MQ_PASSWORD is the encrypted password for the ActiveMQ instance installed on a remote machine

  3. MQ_URL_WITH_PORT is the IP and port of the installed ActiveMQ used by the entire solution

  4. Access_Control_URL is the IP where Access Control is installed. It will be used for authorization and authentication.

  5. ENGINE_SERVICE_API_URL_WITH_PORT is the IP of the Linux VM and the exposed port, which is bridged to the running container’s Engine Service port

  6. ENGINE_VERSION is used for informational and display purposes in the New Queue Management flow

  7. PUBLISHING_METHOD was configured to send results to the MQ just like an All-In-One default engine

  8. ENABLED_QUEUES was configured to use all queue options

Unless a fine-tuned environment is needed or result files need to stay in the engine container’s volume, it is suggested that the values above be used.

In a Windows or Mac hosting environment, edit the ‘yml’ file directly rather than the Linux-specific Shell script. Use the same values described in the Shell example for the key-value pairs under the “environment:” tag.

Required Prerequisites for Installing CxEngine

  • Linux host, equipped with either an x64 or ARM64 processor.

  • Docker engine, available from

  • For Amazon Linux images: Increased limit of file descriptors as explained below.

Package Content

The CxEngine package for Linux contains the following files:

  • cx-engine-server.tar (CxEngine image)



  • server.env

The package is provided with the following directory structure:


Installation and Configuration

These instructions assume that the prerequisites are in place and you downloaded the installation package.

Installing CxEngine

  1. Create a new directory.

  2. Copy the three installation files into the new directory:



  3. Retrieve the AMQ Password and the URL. The AMQ is usually deployed as part of the CxManager component.

    • To retrieve the AMQ password, connect to the CxSAST database, and execute the following SQL query:

      1 SELECT TOP (1000) [Id]

      2 ,[Key]

      3 ,[Value]

      4 ,[Description]

      5 FROM [CxDB].[dbo].[CxComponentConfiguration]

      6 WHERE [Key] = 'MessageQueuePassword'

    • To retrieve the AMQ URL, connect to the CxSAST database and execute the following SQL query:

      1 SELECT TOP (1000) [Id]

      2 ,[Key]

      3 ,[Value]

      4 ,[Description]

      5 FROM [CxDB].[dbo].[CxComponentConfiguration]

      6 WHERE [Key] = 'ActiveMessageQueueURL'

  4. Open server.env and update the following environment variables with the required data as follows:

    ES_MESSAGE_QUEUE_PASSWORD={retrieve from database}

    ES_MESSAGE_QUEUE_URL=tcp://{client host address as explained below}:{port}

    CX_ES_ACCESS_CONTROL_URL=http://{client host address}/CxRestAPI/auth

    CX_ES_END_POINT={cx-engine-server host address - example - http://x.x.x.x:8088}

    If a proxy is used, add the following proxy environment variables:



  5. Enter sh to install CxEngine. The image (cx-engine-server.tar) is extracted and loaded. The container is established.

Notice uses port 8088 by default, which must be entered in the server.env variables as relevant. To use a different port, follow the instructions below and use that new port where entering the port is required.


Unlike Windows services, the CxSAST Linux container does not restart automatically by default. Therefore, you have to configure the CxSAST Linux Engine containers to restart automatically. To do so, open with your text editor and, in the “docker_run_args=” section, add or uncomment “—restart=always”.

Changing the Port for the Command

It is recommended to use the default port (port 8088). If you have to use a different port, for example, port 8090, change the port as follows:

  1. Run the “docker run” command{exposed port}:8090

  2. Save the new setting.

Verifying that the Server with CxEngine is Running

The syntax below assumes that you use the default port (port 8088).

  1. Run the “docker ps” command. The following is returned, if the container is running:

    1 * IMAGE: cx-engine-server

    2 * PORTS:>8088/tcp

  2. Run the command "docker logs -f {container ID}”. The following is returned if the server is running.

    1 * Now listening on: <http://[::]:8088> |Application started

Connecting the CxEngine to the Application

  • In the web portal, go to Settings > Application Settings > Engine Management and connect to the new engine as explained under Engine Management.

Centos 8 Installation Notes

This note addresses users who use Centos 8 and did not set up a Docker engine yet.

RHEL switched from iptables to nftables, which means that there are no more iptables running on the Centos 8 level and all the firewall functionality is provided by nftables.

The migration from iptables to nftables requires one of the following:

Configuring Firewalld to use Iptable Configurations

This section explains how to provide an interface to firewalld to add iptables. To do so, do the following:

  1. At the prompt, enter - sudo vi /etc/firewalld/firewalld.conf

  2. Change - FirewallBackend=nftables to - FirewallBackend=iptables

  3. Save the change and reload firewalld. To do so, enter - sudo systemctl restart firewalld.service at the prompt.

Enabling Masquerading

  1. Check what interface docker is using (default is 'docker0').

    ip link show

  2. Check available firewalld zones, e.g., 'public'.

    - sudo firewall-cmd --get-active-zones

  3. Check what zone the docker interface it bound to, most likely 'no zone' yet.

    - sudo firewall-cmd --get-zone-of-interface=docker0

  4. Add the 'docker0' interface to the 'public' zone. Changes take effect once firewalld is reloaded.

    - sudo nmcli connection modify docker0 public

  5. Add masquerading. It allows for docker ingress and egress.

    - sudo firewall-cmd --zone=public --add-masquerade –permanent

  6. Optionally open required incoming ports (optional).

    - sudo firewall-cmd --zone=public --add-port=443/tcp

  7. Reload firewalld.

    - sudo firewall-cmd –reload

  8. Reload dockerd.

    - sudo systemctl restart docker

Best Practices to Maintain Docker Security

This document provides tips for best practice on the optimal security measures to be taken when running the Engine on Linux Docker.

Docker Image

The provided docker image uses the following protection:

  1. Uses a limited Linux version (.NET Core 2.1 and .NET Core 3.1 alpine).

  2. Creates a dedicated user (not root) to operate the respective docker.

Docker Orchestrators

When working with multiple docker orchestrators, each of them provides a default set of capabilities.

To optimize security, the customer can remove all capabilities. The Engine doesn’t require any special permission or capability in order to run.

To drop all capabilities when using Docker Compose, you can use the following command: