What to install?

To dockerize or not to dockerize, that's the question

General requirements

Python3

Installation of any of the vantage6 packages requires Python ≥ 3.6. For installation instructions, see python.org, anaconda.com or use the package manager native to your OS and/or distribution (e.g. apt for debian or Ubuntu, yum for fedora, or yast for SuSE).

We recommend you install vantage6 in a new, clean environment.

Docker

Running a node always requires the Docker runtime to be installed (and running). Running the server only requires docker when it's run as a dockerized application.

The correct installation of docker can be verified with the following command:

docker run hello-world

🐳 Always make sure that Docker is running!

🐳 If this command is not successful, please see Docker's website for installation instructions specific for your platform.

vantage6

vantage6 consists of several components that can be installed and run in several different ways. Which component(s) you need, and how you wish to install them, depends on your use case.

There are three (or four) components to consider:

  1. The server

  2. A node

  3. The client

  4. A Docker registry

When using Windows, make sure you share you're drives with Docker.

The server and the node can be run through Docker (preferably) or installed as regular Python packages/applications. We will cover both options in the following sections.