Cluebase VMS Installation Manual

Cluebase VMS Installation Manual

This manual explains how to install Cluebase VMS using the interactive installer package.

The installer deploys Cluebase VMS as a Docker Compose-based system. During installation, it can also install optional components such as the AI module, LPR module, BI service, HTTPS configuration, and GPU runtime support.

Installation Package

The installation package contains:

• install.sh - main interactive installer.
• lib/steps.sh - installation steps and helper functions.
• lib/ui.sh - interactive menu interface.
• templates/cluebase/ - Cluebase VMS Docker Compose templates, configuration files, certificates, and management scripts.
• templates/bi/ - optional BI service Docker Compose templates and configuration files.

After installation, the installer creates the deployment directories in the directory where it is run:

• ./cluebasevms/ - Cluebase VMS deployment directory.
• ./bi/ - BI deployment directory, created only if BI is selected.

The installer also creates common management scripts in the same directory:

• ./start.sh
• ./stop.sh
• ./restart.sh
• ./update.sh
• ./uninstall.sh

System Requirements

Minimal requirements depend on the number of cameras, enabled analytics, and archive retention period. For a basic installation, prepare a Linux server with:

• Ubuntu or another compatible Debian-based Linux distribution.
• Bash shell.
• sudo access.
• Internet access for downloading Docker packages and Docker images.
• Static IP address.
• Free disk space for Docker images, configuration files, database data, archive files, and optional AI/BI data.

For GPU mode:

• NVIDIA GPU.
• Installed NVIDIA driver.
• Working nvidia-smi command.
• Internet access for installing NVIDIA Container Toolkit if it is not already installed.

The installer supports the following CPU architectures:

• x86_64 / amd64
• aarch64 / arm64

If the server architecture is not supported, the installer stops before making deployment changes.

Network Ports

Depending on selected options, the following ports may be used:

• 80 - Cluebase VMS web interface when HTTP is selected.
• 443 - Cluebase VMS web interface when HTTPS is selected.
• 8080 - BI web interface when HTTP is selected.
• 8443 - BI web interface when HTTPS is selected.
• 3000 - Cluebase backend local port.
• 3307 - MySQL external local binding.
• 4001 - livestream server local binding.
• 4444 - WebSocket server.
• 4646 - embedded video analytics service.
• 8095 - LPR API port.
• 8565 - RTSP server.
• 9001 - AI service port.
• 32433 - LPR license service port.

Make sure that required ports are not already used by another application.

Preparing the Installer

1. Copy the installer archive to the target server.
2. Extract the archive.
3. Open a terminal in the extracted installer directory.
4. Make sure the main script is executable:

chmod +x install.sh

The installer creates deployment files in the current working directory. Run it from the directory where you want the cluebasevms and optional bi folders to be created.

Starting Installation

Run the installer:

./install.sh

The installer opens an interactive menu. Use the Up and Down arrow keys to move through options and press Enter to select.

File:Installer welcome screen.png

Installer welcome screen