Deployment Guide (Linux OS)

Prerequisites

To run this application you need:

  • Docker Engine >= 17.06

  • Docker Compose is recommended with a version 1.14.0 or later.

  • Git minimum required git version is 2.18

Installation script will install Docker Engine and Docker Compose prerequisites automatically.

User must be root or have sudo rights.

Also, you need a request login/password by vixtera.com for docker-registry.cmlatitude.com and for application (require authentication)

Open ports on server

Next ports should be open on a server:

  • Analytics service (for both monolith or distributed)- 8120

  • Documentation (optional on-demand deployment) - 8888

  • Monolith version - 8080

  • Distributed version - 80

Hardware and OS requirements

ViEdge monolith version

  • Operating system = Ubuntu 18.04 or Ubuntu 20.04 (recommended)

  • System Memory >= 4 GB

  • CPU >= 2 cores

  • HDD free space >= 10 GB

  • Internet access

ViEdge distributed version

  • Operating system = Ubuntu 18.04 or Ubuntu 20.04 (recommended)

  • System Memory >= 16 GB

  • CPU >= 4 cores

  • HDD free space >= 30 GB

  • Internet access

Starting ViEdge

Execute next commands:

Install git

apt-get update
apt-get -y install git

Clone ViEdge repository

git clone https://github.com/vixtera/edge.git

Configure environment variables

Replace NETWORK_IP_DOCKER_HOST environment variable with your server IP or hostname in .env file

File location:

edge/monolith/.env or edge/distributed/.env

Example: NETWORK_IP_DOCKER_HOST=54.88.37.71 or NETWORK_IP_DOCKER_HOST=vixtera-edge.domain.com Choose ViEdge version - Monolith or Distributed Navigate to cloned edge folder:

cd edge

To start Monolith version:

Start script:

./vixtera-edge-monolith-start.sh

To start Distributed version execute:

./vixtera-edge-distributed-start.sh

To stop Monolith version execute:

./vixtera-edge-monolith-stop.sh

To stop Distributed version execute:

./vixtera-edge-distributed-stop.sh

Open ViEdge application in your browser

  • Monolith version - http://[ip or hostname]:8080 (without authentication)

  • Distributed version - http://[ip or hostname]

Use credentials that you received from Vixtera team support.