Difference between revisions of "Cluebase VMS Installation Manual"

From vCloud.ai Documentation
Jump to navigation Jump to search
(Blanked the page)
Tags: Visual edit Blanking
Line 1: Line 1:
= 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:
* <code>install.sh</code> - main interactive installer.
* <code>lib/steps.sh</code> - installation steps and helper functions.
* <code>lib/ui.sh</code> - interactive menu interface.
* <code>templates/cluebase/</code> - Cluebase VMS Docker Compose templates, configuration files, certificates, and management scripts.
* <code>templates/bi/</code> - optional BI service Docker Compose templates and configuration files.
After installation, the installer creates the deployment directories in the directory where it is run:
* <code>./cluebasevms/</code> - Cluebase VMS deployment directory.
* <code>./bi/</code> - BI deployment directory, created only if BI is selected.
The installer also creates common management scripts in the same directory:
* <code>./start.sh</code>
* <code>./stop.sh</code>
* <code>./restart.sh</code>
* <code>./update.sh</code>
* <code>./uninstall.sh</code>
== 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.
* <code>sudo</code> 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 <code>nvidia-smi</code> command.
* Internet access for installing NVIDIA Container Toolkit if it is not already installed.
The installer supports the following CPU architectures:
* <code>x86_64</code> / <code>amd64</code>
* <code>aarch64</code> / <code>arm64</code>
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:
* <code>80</code> - Cluebase VMS web interface when HTTP is selected.
* <code>443</code> - Cluebase VMS web interface when HTTPS is selected.
* <code>8080</code> - BI web interface when HTTP is selected.
* <code>8443</code> - BI web interface when HTTPS is selected.
* <code>3000</code> - Cluebase backend local port.
* <code>3307</code> - MySQL external local binding.
* <code>4001</code> - livestream server local binding.
* <code>4444</code> - WebSocket server.
* <code>4646</code> - embedded video analytics service.
* <code>8095</code> - LPR API port.
* <code>8565</code> - RTSP server.
* <code>9001</code> - AI service port.
* <code>32433</code> - LPR license service port.
Make sure that required ports are not already used by another application.
== Preparing the Installer ==
# Copy the installer archive to the target server.
# Extract the archive.
# Open a terminal in the extracted <code>installer</code> directory.
# Make sure the main script is executable:
<pre>
chmod +x install.sh
</pre>
The installer creates deployment files in the current working directory. Run it from the directory where you want the <code>cluebasevms</code> and optional <code>bi</code> folders to be created.
== Starting Installation ==
Run the installer:
<pre>
./install.sh
</pre>
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|alt=Installer welcome screen|none|thumb|600x600px|Installer welcome screen]]
== Installation Options ==

Revision as of 09:34, 18 May 2026

Retrieved from "https://docs.vcloud.ai/index.php?title=Cluebase_VMS_Installation_Manual&oldid=1265"