Deploying the iTDS with Docker

Modified on: Wed, 24 Jun, 2020 at 11:59 AM


The Paterva iTDS is available as Docker images. Your Electronic Delivery document contains a link to the Docker Compose YAML file (itds.yml) that should be downloaded and will be used to pull the required Docker images from Paterva's Docker registry and Docker Hub, provision volumes, and start the containers in the default network.

These instructions were tested on an Ubuntu 20.04 LTS host using IPv4. Instructions may differ slightly depending on your preferred host operating system and network configuration. 

Note: The instructions below should be executed from the host server through console or a SSH session. Commands have to be executed with elevated user privileges (e.g. “sudo” or with the “root” user) if the logged in user is not in `docker` group.

Software Requirements

The host machine running the Docker containers will need to have the following installed:

Starting the Server

After you have installed Docker and Docker Compose on your Host machine follow the steps below:

Step 1: Login to Paterva's Docker registry

To download the latest Docker images you first need to log into our Docker Registry using the following command:

docker login

Enter the iTDS Docker Registry username and password as specified in the Delivery document.

Note: If the delivery document contains multiple server licenses, the password is different per server license.

Step 2: Copy your Docker Compose YAML file

Your delivery document includes a link to a Docker Compose YAML file (itds.yml) that can be used to deploy iTDS. You will need to either copy the Docker Compose YAML file or directly download it onto the machine that will be running the Docker containers.

Note: It is recommended that you always run the docker-compose commands from the same directory as the docker-compose YAML file. Please copy the docker-compose YAML file to it’s own directory (e.g. /var/maltego/ or /home/maltego/), and run all future commands from this directory.

You can use either of the following commands to download the YAML file directly on to the host machine (you may need "write permissions" if downloading to a system directory).

wget -O itds.yml


curl -o itds.yml

Step 3: Start the server

From the directory containing the Docker Compose YAML file (e.g. /home/maltego/), build and start the server using ‘docker-compose’:

docker-compose -f itds.yml up -d

The iTDS Docker images will be pulled and from Paterva's Docker Registry. Once the images have been pulled, the containers will start running automatically in Detached mode (-d). You can now access the iTDS web interface using the host machine's IPv4 address or DNS Name. e.g., https://{{ Server IPv4 or DNS Name }}/

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.