Skip to content

Prerequisites

Complete these prerequisites before proceeding with either online or offline installation of ForensiQ. First review the software and hardware requirements and choose your deployment setup.

An SSH server must be running on the installation target. The deployment account must be able to log in over SSH and use sudo to become root.

Prepare the following operating-system dependencies on every target node before starting either installer. The curl and apt commands below require access to the listed repositories.

Offline prerequisites

For offline installation, run them while connected, or install equivalent packages and dependencies from your offline package media or internal repository.

The offline installer bundle does not include these operating-system packages.

Operating-system dependencies

1. System update

Make sure the operating system is up to date and that the required CLI tools are installed.

sudo apt update && \
sudo apt -y install curl lsb-release && \
sudo apt upgrade -y && \
sudo reboot

2. Add Docker GPG key and repository

sudo mkdir -p /etc/apt/keyrings && \
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo tee /etc/apt/keyrings/docker.asc > /dev/null && \
sudo chmod a+r /etc/apt/keyrings/docker.asc && \
printf '%s\n' \
'Enabled: yes' \
'Types: deb' \
'URIs: https://download.docker.com/linux/ubuntu' \
"Suites: $(lsb_release -cs)" \
'Components: stable' \
'Architectures: amd64' \
'Signed-By: /etc/apt/keyrings/docker.asc' | \
sudo tee /etc/apt/sources.list.d/docker.sources > /dev/null

3. (Indexer/Standalone nodes only) Add NVIDIA Container Toolkit GPG key and repository

curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo tee /etc/apt/keyrings/nvidia-container-toolkit.asc > /dev/null && \
sudo chmod a+r /etc/apt/keyrings/nvidia-container-toolkit.asc && \
printf '%s\n' \
'Types: deb' \
'URIs: https://nvidia.github.io/libnvidia-container/stable/deb/amd64' \
'Suites: /' \
'Signed-By: /etc/apt/keyrings/nvidia-container-toolkit.asc' | \
sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.sources > /dev/null

4. Install required dependencies

Choose the package set that matches the node environment.

sudo apt update && \
sudo apt -y install gpg ca-certificates software-properties-common docker-ce docker-ce-cli docker-compose-plugin containerd.io python3-pip python3-venv nvidia-driver-580 nvidia-docker2 openssh-server && \
sudo reboot

Headless server installation is only supported on Ubuntu 24.04.

sudo apt update && \
sudo apt -y install --no-install-recommends gpg ca-certificates software-properties-common docker-ce docker-ce-cli docker-compose-plugin containerd.io python3-pip python3-venv linux-modules-nvidia-580-server-generic nvidia-compute-utils-580-server libnvidia-compute-580-server nvidia-utils-580-server nvidia-docker2 openssh-server && \
sudo reboot

sudo apt update && \
sudo apt -y install gpg ca-certificates software-properties-common docker-ce docker-ce-cli docker-compose-plugin containerd.io python3-pip python3-venv openssh-server && \
sudo reboot

1. System update

Make sure the operating system is up to date and that the required CLI tools are installed.

sudo apt update && \
sudo apt -y install curl lsb-release && \
sudo apt upgrade -y && \
sudo reboot

2. Add Docker GPG key and repository

sudo mkdir -p /etc/apt/keyrings && \
curl -fsSL https://download.docker.com/linux/debian/gpg | sudo tee /etc/apt/keyrings/docker.asc > /dev/null && \
sudo chmod a+r /etc/apt/keyrings/docker.asc && \
printf '%s\n' \
'Enabled: yes' \
'Types: deb' \
'URIs: https://download.docker.com/linux/debian' \
"Suites: $(lsb_release -cs)" \
'Components: stable' \
'Architectures: amd64' \
'Signed-By: /etc/apt/keyrings/docker.asc' | \
sudo tee /etc/apt/sources.list.d/docker.sources > /dev/null

3. (Indexer/Standalone nodes only) Add NVIDIA Container Toolkit GPG key and repository

curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo tee /etc/apt/keyrings/nvidia-container-toolkit.asc > /dev/null && \
sudo chmod a+r /etc/apt/keyrings/nvidia-container-toolkit.asc && \
printf '%s\n' \
'Types: deb' \
'URIs: https://nvidia.github.io/libnvidia-container/stable/deb/amd64' \
'Suites: /' \
'Signed-By: /etc/apt/keyrings/nvidia-container-toolkit.asc' | \
sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.sources > /dev/null

4. (Indexer/Standalone nodes only) Install NVIDIA CUDA keyring

curl -fsSLo /tmp/cuda-keyring_1.1-1_all.deb https://developer.download.nvidia.com/compute/cuda/repos/debian12/x86_64/cuda-keyring_1.1-1_all.deb && \
sudo dpkg -i /tmp/cuda-keyring_1.1-1_all.deb && \
sudo rm /tmp/cuda-keyring_1.1-1_all.deb

5. Install required dependencies

sudo apt update && \
sudo apt -y install linux-headers-$(uname -r) nvidia-driver cuda-drivers ca-certificates software-properties-common docker-ce docker-ce-cli docker-compose-plugin containerd.io python3-pip python3-venv nvidia-docker2 openssh-server && \
sudo reboot

sudo apt update && \
sudo apt -y install ca-certificates software-properties-common docker-ce docker-ce-cli docker-compose-plugin containerd.io python3-pip python3-venv openssh-server && \
sudo reboot

Verify dependencies and access

For indexer and standalone nodes, verify the NVIDIA driver after the reboot:

nvidia-smi

Verify that Docker is running without pulling an image from a registry:

sudo docker info

Ensure that the user running the installer can access Docker without sudo:

sudo usermod -aG docker $USER

Log out and log back in before continuing so that the group change takes effect.

Verify Docker access as the user who will run the installer:

docker info

Deployment information

Have the following information ready before starting either installer:

  • Target machine IP address or hostname.
  • SSH username and password or SSH private key for the installation target.
  • Sudo password for the deployment account, unless it has passwordless sudo.
  • ForensiQ deployment configuration type: standalone, core, or indexer.
  • Local networking information required by your deployment. Consult your network administrator if necessary.

Choose an installation method

Once the prerequisites are ready, choose the installation method that matches your server's internet access.

  • Online installation

    If your server has internet access, proceed to the installation guide for instructions on how to install ForensiQ.

    Online installation

  • Offline installation (experimental)

    If your server does not have internet access, you can use the offline installation method to install ForensiQ.

    Offline installation