Attention

This document is no longer being updated. For the most recent documentation, including the latest release notes for version 6, please refer to Documentation Version 7

Requirements

Hardware

Minimal System requirements are for all containers except the database:
Disk: 25 gb
Memory: 16-32 gb
CPU: 4-8 x86_64 cores

Additionally you will need more disk space, memory and cpu if you run your database as well as container. Please refer to the minimal requirements for your database to the database manufacturer.

A rough approximation rule:

Required Database Disk Space = 4 * Sourcedata-Diskspace

Note

Please note that ARM CPU architecture is not supported, make sure your host runs on x86_64.

Software

The graphical user interface is fine tuned for Google Chrome Browser and will refuse a login using any other browser.

The Datavault Builder can be installed on any system capable of running a docker host and able to connect to docker.com. For a list with a current overview of supported Environments please visit: https://docs.docker.com/engine/installation/

Docker

To access the Datavault Builder repository, please provide us your Email address so you your account can be initiated.
Install Docker (https://docs.docker.com/engine/installation/)
Install Docker-Compose (https://docs.docker.com/compose/install/)

Test your Docker environment:

Verify Docker version to be 19+:

docker --version

Verify docker-compose version to be 1.24+:

docker-compose --version

Log into Docker and pull an image from our repository (once you have provided us your user and have been granted access):

docker login docker.datavault-builder.com
docker pull docker.datavault-builder.com/datavaultbuilder/api:6.10.1.1

Note

If this doesn’t work check the following prerequisities:

your computer is connected to the internet
if you use a proxy that the proxy is configured correctly
you have the latest version of Docker and Docker compose installed

Note

Windows Server

Please note, that running linux based containers on Windows Server environments is officially supported since Windows Server 2019 and the license for docker EE is included in the server license. https://docs.microsoft.com/en-us/windows-server/get-started-19/whats-new-19#linux-containers-on-windows

Note

Proxy

If you use a proxy to connect to the internet please check the corresponding chapter. If you have no chance at all to connect to the internet from your server you can download the container images as well on another computer and transfer it via USB drive or local network connection. Please be aware that this will increase your maintenance efforts and is not recommended.

On the same page, install instructions for each system are as well present.

Sample

As an example, we have prepared you the install instructions for CentOS 7 (Tested version: 7.4 minimal, normal installation without any additional packages).

Run the following commands as root:

yum remove docker docker-common docker-selinux docker-engine yum install -y yum-utils  device-mapper-persistent-data lvm2 yum-config-manager --add-repo
https://download.docker.com/linux/centos/docker-ce.repo
yum install docker-ce
systemctl start docker
systemctl enable docker
curl -L
https://github.com/docker/compose/releases/download/[current version]/docker-compose-`uname
-s`-`uname -m` -o /usr/local/bin/docker-compose chmod +x /usr/local/bin/docker-compose

In case you would like to start the containers with another user than root, add that user:

groupadd docker
usermod -aG docker USERNAME

Test

This is already it. Test the installation as describe in the next chapter and then just copy the provided docker-compose into a local folder, cd to that folder and start the application:

docker login docker.datavault-builder.com
docker-compose up -d

Download of Container Images on Another Computer

Note

Short: use the save CLI command.

https://docs.docker.com/engine/reference/commandline/save/

You can pull the image on a computer that have access to the internet:

sudo docker pull hello-world

Then you can save this image to a file:

sudo docker save -o hello-world_image.docker hello-world

Transfer the file on the offline computer (USB/CD/whatever) and load the image from the file:

sudo docker load -i hello-world_image.docker

Reference for docker load:: https://docs.docker.com/engine/reference/commandline/load/

Test your Docker Installation

Test you Docker environment. Save the following file to a local folder to a file called docker-compose.yml:

version: '3.1'

services:

helloworld:
    image: 'hello-world'

Switch using cmd or bash to the folder where you saved the docker-compose.yml and type:

docker-compose up

You should get a message saying:

helloworld  |
helloworld  | Hello from Docker!

If this doesn’t work check the following prerequisites:

that your computer is connected to the internet
if you use a proxy that the proxy is configured correctly as in the linked manual for Docker
you have the latest version of Docker and Docker compose installed (depending on you Linux distribtion you can’t use Apt as they have to old version of te packages)