Skip to main content
Skip table of contents

‎Linux Environment Setup

LAST UPDATED: FEB 11, 2025

System Requirements and Network Configuration

Hardware (Can be virtual)

Component

Minimum

Recommended

CPU

4 CPU Cores

8 CPU Cores

Memory

8GB RAM

16GB RAM

Host Local Storage

30GB SSD

100GB SSD (Raid 1 or 10)

Operating System

Version

License

Linux Ubuntu / Red Hat

-

Firewall Ports

Service

Protocol

Port

Direction

Firewall / Proxy

D3 SOAR Proxy Agent

TCP

443

Outbound to Internet

Allow

READER NOTE

  1. The server for D3 Proxy Agent must be able to communicate with D3 vSOC servers via TCP ports 443.

  2. D3 Proxy Agent must be installed on servers that have direct access to the internal security products, such as firewalls, SIEM, Exchange, etc.

  3. If Web Proxy is enabled in your network environment, Web Proxy IP needs to be provided for docker-compose configuration during the installation. See Using D3 Proxy Agent with a Web Proxy Server).

Docker Engine Installation

Installing Docker on Ubuntu

Follow the instructions from the documentation to install docker using the apt package manager: Install Docker Engine on Ubuntu | Docker Docs

  1. Run the command below to check if Docker is installed:

BASH
docker version

Alternatively, you can install from a package with these instructions:

You can find different Ubuntu releases for Docker at https://download.docker.com/linux/ubuntu/dists/

Download and install four .deb packages from <version>/pool/stable/amd64:

  1. docker-ce-cli

  2. docker-ce

  3. http://containerd.io

  4. docker-compose-plugin

Command to install on ubuntu:

BASH
sudo dpkg -i /path/to/<replace_with_package>.deb

Command to check if docker service is running:

BASH
sudo systemctl status docker

Installing Docker on Red Hat

Follow the instructions from the documentation to install docker using the yum package manager: https://docs.docker.com/engine/install/rhel/

Alternatively, you can install from a package with these instructions:

Click here for Red Hat package distributions

Download and install four .rpm packages from <version>/s390x/stable/packages:

  1. docker-ce-cli

  2. docker-ce

  3. http://containerd.io

  4. docker-compose-plugin

Command to install on Red Hat:

BASH
sudo yum install /path/to/<replace_with_package>.rpm  

Command to start docker server:

BASH
sudo systemctl start docker

Authenticating to Azure Container Registry

The D3 Agent image hosted on Azure Container Registry is private. Authenticate to the D3 Azure Container Registry to pull and install it.

  1. Contact a D3 account representative to obtain the service_account.key file. Ensure that the file name remains as service_account.key without any appended parentheses or numbers.

  2. Create a directory for the D3 Agent installation on the Linux host machine:

    BASH
    mkdir DemoD3AgentDirectory
  3. Change to the newly created directory:

    BASH
    cd DemoD3AgentDirectory
  4. Copy the service_account.key file into the newly created directory.

  5. Authenticate to the Azure Container Registry using the following command:

    BASH
    sudo docker login -u d3acrpull --password-stdin https://d3soar.azurecr.io < service_account.key
Authenticating to Google Container Registry (Discontinuing in March 2025)

The D3 Proxy Agent image hosted on Google Container Registry is private. Authenticate to the D3 Google Container Registry to pull and install it.

  1. Contact the D3 account representative to obtain the service_account_d3soar.json file. Ensure that the file name remains as service_account_d3soar.json without any appended parentheses or numbers.

  2. Create a directory for the D3 Proxy Agent installation on the Linux host machine:

    BASH
    mkdir D3ProxyAgent
  3. Change to the newly created directory:

    BASH
    cd D3ProxyAgent
  4. Copy the service_account_d3soar.json file into the newly created directory.

  5. Authenticate to the Google Container Registry using the following command:

    BASH
    sudo docker login -u _json_key --password-stdin https://gcr.io < service_account_d3soar.json

READER NOTE

  • Successful authentication will result in a “Login Succeeded” message in your terminal.

WARNING

  • The service_account_d3soar.json file must be named exactly as service_account_d3soar.json without any changes to its name.

  • If you encounter errors, verify the naming and content of your service_account_d3soar.json file.

  1. (Optional) Test and verify that you can successfully pull an image from the D3 Google Container Registry by running the following command:

    BASH
    sudo docker pull gcr.io/nimble-cortex-285618/d3prod/d3agent:<D3 vSOC version>

READER NOTE

  • The <D3 vSOC version> conforms to the following format: #.#.#.#.

    • Eg. 16.8.112.0.

  • The <D3 vSOC version> can be found within your D3 vSOC login page.

    Frame 2-20240709-013409.png
  • Upon a successful pull, you will see something like the following:

    Frame 1 (28)-20241017-001413.png
  • Upon a failed pull, you will see a “Failed to fetch <D3 vSOC version> from request...” message:

    Frame 2 (27)-20241017-001646.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.