Cluebase VMS Installation Manual - Revision history

Vcloudai at 08:53, 18 May 2026

2026-05-18T08:53:26Z

Vcloudai: Blanked the page

2026-05-18T08:34:31Z

Blanked the page

← Older revision		Revision as of 09:34, 18 May 2026
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 ==~~

Vcloudai at 08:29, 18 May 2026

2026-05-18T08:29:23Z

Show changes

Vcloudai at 08:27, 18 May 2026

2026-05-18T08:27:26Z

Show changes

Vcloudai: /* Sign in */

2025-04-17T07:58:47Z

← Older revision		Revision as of 08:58, 17 April 2025
Line 110:		Line 110:
	== Sign in ==		== Sign in ==
	Open a web browser (Google Chrome, Mozilla Firefox and Safari are recommended), enter the server's IP address and press Enter. <br>		Open a web browser (Google Chrome, Mozilla Firefox and Safari are recommended), enter the server's IP address and press Enter. <br>
	[[File:~~Picture 24~~.png\|thumb~~\|none~~]]<br>		[[File:Sign in.png\|none\|thumb]]
			<br>
	By default login and password: admin/admin.		By default login and password: admin/admin.

Vcloudai: /* Server IP update */

2024-07-09T05:31:44Z

Server IP update

← Older revision		Revision as of 06:31, 9 July 2024
Line 114:		Line 114:

	== Server IP update ==		== Server IP update ==
	sudo ./newIP.sh		sudo sh newIP.sh

	== Stopping the VMS ==		== Stopping the VMS ==
	Run the following command from the VMS folder to stop the VMS server:<br>		Run the following command from the VMS folder to stop the VMS server:<br>

	$ sudo ./stop.sh<br>		$ sudo sh stop.sh<br>

	== Updating VMS ==		== Updating VMS ==
	To update VMS version:<br><br>		To update VMS version:<br><br>
	$ sudo ./update.sh<br>		$ sudo sh update.sh<br>

	== Start VMS ==		== Start VMS ==
	$ sudo .~~/start~~.sh<br>		$ sudo sh start.sh<br>

			== Uninstall VMS ==
			$ sudo sh uninstall.sh<br>

	== Camera settings recommendations ==		== Camera settings recommendations ==
	1. Always use the CBR setting, as when using VBR on some camera models, the bitrate may drop to limits, which may cause the video stream to be temporarily shut down. <br>		1. Always use the CBR setting, as when using VBR on some camera models, the bitrate may drop to limits, which may cause the video stream to be temporarily shut down. <br>
	2. Always set the minimum keyframe interval (I Frame interval or Key Frame interval).		2. Always set the minimum keyframe interval (I Frame interval or Key Frame interval).

Vcloudai: /* Camera settings recommendations */

2024-01-09T22:09:10Z

Camera settings recommendations

← Older revision		Revision as of 23:09, 9 January 2024
Line 129:		Line 129:

	== Camera settings recommendations ==		== Camera settings recommendations ==
	1. Always use the CBR setting, as when using VBR on some camera models, the bitrate may drop to limits, which may cause the video stream to be temporarily shut down.		1. Always use the CBR setting, as when using VBR on some camera models, the bitrate may drop to limits, which may cause the video stream to be temporarily shut down. <br>
	2. Always set the minimum keyframe interval (I Frame interval or Key Frame interval).		2. Always set the minimum keyframe interval (I Frame interval or Key Frame interval).

Vcloudai at 22:08, 9 January 2024

2024-01-09T22:08:33Z

← Older revision		Revision as of 23:08, 9 January 2024
Line 127:		Line 127:
	== Start VMS ==		== Start VMS ==
	$ sudo ./start.sh<br>		$ sudo ./start.sh<br>

			== Camera settings recommendations ==
			1. Always use the CBR setting, as when using VBR on some camera models, the bitrate may drop to limits, which may cause the video stream to be temporarily shut down.
			2. Always set the minimum keyframe interval (I Frame interval or Key Frame interval).

Vcloudai at 20:27, 13 November 2023

2023-11-13T20:27:44Z

← Older revision		Revision as of 21:27, 13 November 2023
Line 111:		Line 111:
	Open a web browser (Google Chrome, Mozilla Firefox and Safari are recommended), enter the server's IP address and press Enter. <br>		Open a web browser (Google Chrome, Mozilla Firefox and Safari are recommended), enter the server's IP address and press Enter. <br>
	[[File:Picture 24.png\|thumb\|none]]<br>		[[File:Picture 24.png\|thumb\|none]]<br>
	By default login and password: admin/admin.~~<br>~~		By default login and password: admin/admin.

			== Server IP update ==
			sudo ./newIP.sh

	== Stopping the VMS ==		== Stopping the VMS ==
Line 121:		Line 124:
	To update VMS version:<br><br>		To update VMS version:<br><br>
	$ sudo ./update.sh<br>		$ sudo ./update.sh<br>
	3.Start VMS~~:<br>~~
			== Start VMS ==
	$ sudo ./start.sh<br>		$ sudo ./start.sh<br>

Vcloudai: /* Stopping the VMS */

2023-11-13T20:26:07Z

Stopping the VMS

← Older revision		Revision as of 21:26, 13 November 2023
Line 116:		Line 116:
	Run the following command from the VMS folder to stop the VMS server:<br>		Run the following command from the VMS folder to stop the VMS server:<br>

	$ sudo ~~docker-compose down~~ <br>		$ sudo ./stop.sh<br>

	== Updating VMS ==		== Updating VMS ==
	To update ~~the~~ VMS version:<br> ~~1.stop the VMS <br> 2.Run the following command from the VMS folder:~~<br>		To update VMS version:<br><br>
	$ sudo ~~docker-compose pull~~ <br>		$ sudo ./update.sh<br>
	3.~~Restart~~ VMS:<br>		3.Start VMS:<br>
	$ sudo ~~docker-compose up -d~~<br>		$ sudo ./start.sh<br>