Common Components

  • VECTR Tomcat Docker Container
  • VECTR Mongo Docker Container
  • VECTR .env file
  • VECTR docker-compose file

Environment

VECTR uses Docker containers and the docker-compose tool to setup a consistent running environment. There are a number of different services that contribute to VECTR working as a whole, and as a result, a bare metal installation is too complex for us to support.

Host

Our VECTR deployments are typically run on linuxs host for ease of use with the required tooling and better Docker support. OS X or Windows installations may be possible but are not officially supported. Amazon AWS Ubuntu EC2 instances are commonly used to host VECTR deployments.

Network Access

The VECTR docker-compose attempts to retrieve images from DockerHub, internet access to it is required unless the images are manually loaded prior.

Outbound port 80, 81, and possibly 443 requests are made to github to check for updates. The application does not automatically update, but will be able to check from the ? in the top right.

The VECTR docker container makes outbound package manager calls to update its containerized linux instances and may use the HKP protocol to request keys for updated debian/ubuntu packages.

Access Privileges

sudo/admin access is required on the host machine to run docker by default. It is possible to implement docker without root access but that is not covered in our documentation.

VECTR requires access to its deploy directory, and its data directory location.

Configuration

Configuration almost entirely takes place in the .env and docker-compose.yml file. The docker-compose.yml should not normally need to be changed and is easily readable by those familiar with docker-compose.

Documentation for the .env file can be found ENV File Description