Docker

Depending on the part of the system you want to install, you'll need the Docker run-time to be available. This page aims to get you started with the installation of Docker.

Only required for the node and algorithm development

You only need to install Docker when you are installing a node or are planning to develop algorithms. Docker is not required for the client (i.e. using VANTAGE6 to do research), or if you are setting up a server.

Linux

VANTAGE6 has been successfully tested on Ubuntu, other Linux distributions will most likely also work. To install Docker, follow the instructions on their website to install the engine. The lazy way would be to run the get-docker script:

Always verify scripts you download before executing them!

Bash
Bash
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

If you are logged in as non-root user (which should be the case), you need to add your username to the docker-group in order to run VANTAGE6 without root privileges.

Bash
Bash
sudo groupadd docker
sudo usermod -aG docker $USER

First, logout and login again so that the group privileges are granted to your user. Then you can test it by executing docker commands without sudo:

Bash
Bash
docker run hello-world

If you run into issues, please check the Docker documentation

MacOS

The easiest way to install Docker on MacOS is installing Docker desktop, see these instructions.

Shell
Shell
docker run hello-world

Windows

The easiest way to install Docker on Windows is installing Docker desktop, see these instructions. Make sure you select Linux Containers during the installation process. After installing the Docker engine needs access to the dataset location. Right click on the Docker icon and select settings:

Find your way to the settings.

Then go to Shared Drives and make sure the drive where the data is located is checked and press Apply.

Make sure the drive where the data is located is shared with the Docker engine.
PowerShell
PowerShell
docker run hello-world