Installing VIS

Installing and Upgrading VIS Instances

This article explains how to install a new VIS instance on a Visbox or update an existing one. It does not cover OS installation or service configuration, but assumes the Visbox is already prepared.

Access to the files

This guide is intended for installers with access to VIS installation bundles. File access may be restricted and subject to authorization. Customers with active support agreements can obtain files through Event Gates partners or the service desk—opening a support ticket may be required.

Note: Physical access to installation files does not guarantee license or usage rights. When in doubt, consult your system integrator or the Event Gates service desk.

Preparing for a VIS Installation

Clean installation

A clean installation means deploying VIS on a Visbox that has no existing VIS components. After installing the VIS software, you must also install the AI model(s) and an interpreter. These are not included in the default VIS installation bundle and must be selected based on your deployment requirements. Consult the Event Gates service desk for guidance.

Version update

In a version update, the Visbox already contains models and an interpreter. Take care not to overwrite them.

Before the update

• Download the installation bundle from the Event Gates service desk repository or your authorized source.
• The bundle includes an installation script (install.sh) and a zipped folder containing VIS files.
• Ensure you have valid credentials and SSH access to the Visbox.
• The Visbox must have the OS installed and configured to run VIS.

If performing a clean installation, have your interpreter and model ready. For demo setups or undefined deployments, request the default interpreter for person detection using the Event Gates PF model.

Deploying a VIS instance

Running VIS installation script

1. Copy the zipped installation file to the Visbox using scp.
2. SSH into the Visbox as the eventgates user.
3. Unzip the file to the $HOME directory.
4. Run the script: ./install.sh

What the script does:

• Stops vis, vis-admin, and config-manager services.
• Prompts for the eventgates user password to modify permissions.
• Deletes all frontend build folders to avoid hash-based duplication.
• Creates configuration folders for config-manager if needed (e.g., /etc/opt/vis, and related folders like vislet, region, etc.).
• Extracts contents of vis-bundle.zip to appropriate directories (/opt/vis, /opt/vis-admin, /opt/config-manager).
• Creates and enables service files if necessary, then restarts the services.

Installing VIS Admin

Running the Installation Script

1. Download the VIS Admin zip file from the publish location at osTicket knowledgebase.
2. Copy the zip file to the Visbox using scp.
3. SSH into the Visbox as the eventgates user.
4. Unzip the file in the $HOME directory.
5. Enter the unzipped directory and run: ./install.sh

What the Script Does

• Prompts for the eventgates user password to modify permissions.
• Copies VIS Admin files to /opt/vis-admin.
• Creates and enables the VIS Admin service if it does not already exist.
• Restarts the VIS Admin service.

Validating the Installation

• Open the served URL on port 10000 to verify VIS Admin is running.

Cleanup

• Remove zip file and extracted folder.

Installing Configuration Manager

Running the Installation Script

1. Download the Config Manager zip file from the publish location at osTicket knowledgebase.
2. Copy the zip file to the Visbox using scp.
3. SSH into the Visbox as the eventgates user.
4. Unzip the file in the $HOME directory.
5. Enter the unzipped directory and run: ./install.sh

What the Script Does

• Prompts for the eventgates user password to modify permissions.
• Copies Config Manager files to /opt/config-manager.
• Creates and enables the Config Manager service if it does not already exist.
• Restarts the Config Manager service.

Validating the Installation

• Open the served URL on port 15000 to verify Config Manager is running.

Cleanup

• Remove zip file and extracted folder.

Deploying the model

Model deployment is not handled by the installation script and must be done manually:

1. Download the model files from the publish location.
2. Transfer them to the Visbox using scp.
3. SSH into the Visbox as the eventgates user.
4. Copy files to /opt/vis/vis_trt/yolo.
5. Rename .weights and .cfg files to yolov4-{network_size}-{detector_type_id}. Omit the detector_type_id if using the PF model.
6. Navigate to /opt/vis/vis_trt/yolo.
7. Run: python yolo_to_onnx.py -c {class_number} -m yolov4-512-{detector_type_id} python onnx_to_tensorrt.py -c {class_number} -m yolov4-512-{detector_type_id}
8. Restart VIS.

Deploying the interpreter

Interpreter deployment is manual to prevent overwriting existing interpreters:

1. Download the interpreter folder from the publish location.
2. Transfer it to the Visbox using scp.
3. SSH into the Visbox as the eventgates user.
4. Copy the folder to /opt/vis/vis_core/.
5. Restart VIS.

Validate the installation

• Check that services are running on ports 5000, 10000, and 15000.
• Open a video feed in Visor to verify the current VIS version (requires a deployed model and interpreter).