QuickStart Guide

Installation

The following steps have to be executed in order to get MultiAV2 working. The guide is written for ubuntu focal, but should work with other distributions with minor adjustments as well.

1. Make sure your system is up to date.

sudo apt update

2. Install docker

sudo apt install docker.io -y

3. [Optional] Install docker-machine. Note: docker-machine is required when using auto-scale only. If you do not plan to use this feature, skip this step. For additional information regarding docker-machine, use the official documentation at: https://docs.docker.com/machine/.

curl -L https://github.com/docker/machine/releases/download/v0.16.2/docker-machine-`uname -s`-`uname -m` >/tmp/docker-machine &&
    chmod +x /tmp/docker-machine &&
    sudo cp /tmp/docker-machine /usr/local/bin/docker-machine

4. Install git, python3 and pip for python3:

sudo apt install git python3 python3-pip libpq-dev python3-dev -y

5. Clone the MultiAV2 repository

git clone https://github.com/sakkiii/MultiAV2.git

6. Install MultiAV2 via pip. This automatically installs all dependency packages as well.

cd MultiAV2
sudo pip3 install -r requirements.txt 
sudo pip3 install -e . 

Configuration

MultiAV2 is configured via one config file called config.cfg. The file is annotated with additional comments explaining most of the parameters. For additional information about the configuration file, checkout the config.cfg page of the wiki here.

vi multiav/config.cfg

Start the web interface

MultiAV2 can be used as python module (see the python api documentation here) or via web interface. To start the web interface and the REST API, execute the following command:

cd multiav
sudo python3 scripts/runserver.py

Per default, the web server listens on port 8080. Access the web interface via http://localhost:8080

Web interface deployment

MultiAV2 uses web.py as framework. Please refer to the web.py documentation for multiple deplyoment examples here