Hardware Requirements

  • Internet access to GitHub and DockerHub
  • 2+ cores recommended
  • minimum 4gb ram
  • 15gb+ free space on top of OS install

If using AWS, t3a.medium or equivalent instance type recommended

Video Guides

Installation Video Guide

Linux Distribution-specific Dependency Installation Instructions

Ubuntu Dependency Installation

CentOS/RHEL Dependency Installation

Linux Mint Dependency Installation

General Notes

This guide was written with the above Operating Systems in mind. Installs on other Operating systems are not supported.

VECTR is a large web application and associated ecosystem. For easiest installation the VECTR machine requires GitHub/DockerHub internet access for Docker containers to update, and to download files from the VECTR GitHub as needed. The configuration should be entirely contained within the .env file and deployed by the containers themselves.

VECTR Installation Instructions

Clone the VECTR git repository into a folder where VECTR will live. This is a permanent directory where the application files will live.

Recommendation

/opt/vectr

Using the example of '/opt/vectr' , I would run the following in a terminal

mkdir -p /opt/vectr
cd /opt/vectr
wget https://github.com/SecurityRiskAdvisors/VECTR/releases/download/ce-5.6.1/sra-vectr-runtime-5.6.1-ce.zip -O /opt/vectr
unzip sra-vectr-runtime-5.6.1-ce.zip

Using the text editor of your choice edit the .env file:

sudo nano .env

VECTR

The following fields should be filled out. For detailed documentation on .env fields see ENV Details

VECTR_HOSTNAME= This is the URL you will be accessing VECTR from

VECTR_PORT= This is the port the Tomcat instance will be listening on for HTTPS

VECTR_DATA_KEY= This is the encryption key for the Mongo database. Needed for future integrations or potentially data recovery. Change this and store in a safe place.

CAS_ENCRYPT_PASSWORD= This is the encryption key for the CAS(Authentication) database. Change and store in a safe place.

MONGO_INITDB_ROOT_PASSWORD= This is the password for the default login of the MongoDB. You may need this in the future if manual access to your database is required. Change and store in a safe place.

COMPOSE_PROJECT_NAME= project name you would like to name the containers

Set the appropriate values and save the file

Run a docker-compose command to bring up the containers

docker-compose up -d

This will take a few minutes as Docker will need to download the images and then build the containers. Success will look like this, with your output being the created containers.

VECTR

Usage

The VECTR webapp is available at https://your_docker_host:8081 Where your_docker_host is the URL set accordingly in the .env file. The port will be 8081 by default unless modified. Log in with the default credentials

User: admin

Password: 11_ThisIsTheFirstPassword_11

Please change your password after initial login in the user profile menu

Check out our How-to Videos for getting started in VECTR once you have it installed

Troubleshooting/Advanced Installation

If you have a very locked down internal network or are performing an advanced installation, please see the VECTR Technical Reference for environment and configuration details.

For installs that require an "offline" install see Limited Network Connectivity