Cluebase VMS Installation Manual

Installation manuel Contents

Automatic installation

Docker container framework and Docker-compose extension are required for Cluebase VMS installation and operation.

1.1. Linux

Please run the install.sh script to automatically install Cluebase VMS on a clean Linux OS.

To run the script, please go to the folder containing “install.sh” and run the following command:

$ sudo sh install.sh

1.2. Windows

Please run the batch file WINDOWS_install.bat to install Cluebase VMS on Windows OS.

2.1. Docker installation

Docker container framework and Docker-compose extension are required for Cluebase VMS installation and operation.

2.1.1.Installing Docker on Linux

Run the following command:

$ sudo apt-get update && apt-get install docker-ce docker-ce-cli containerd.io

2.1.2. Installing docker-compose on Linux

Run the following command:

$ sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

Grant the necessary access rights by running the following command:

$ sudo chmod +x /usr/local/bin/docker-compose

2.1.3. Installing Docker on Windows (please note that Windows operating system is experimental and may have limitations)

Download the latest version of Docker Desktop from the official website: https://www.docker.com/products/docker-desktop

The Docker Desktop installer includes the Docker engine and Docker compose.

2.2. Preparation for VMS installation

2.2.1. Download Cluebase.zip. Create a VMS folder and unzip the contents of the zip file to that folder.

You will need to edit the environment variable file, the .env file, to successfully install the VMS.

Please note that this file is hidden in the folder by default.

2.2.2. Open the .env file and specify the server's IP address in the following fields:

APP_HOST=0.0.0.0 (the server's public IP address) MACHINE_HOST=0.0.0.0 (local IP address of the server)

If the VMS should only be used in the local network, both IP addresses will be the same.

2.2.3. Installing and running VMS
Enter the VMS folder and run the following command:

$ sudo docker-compose up -d

This command will automatically download, install and run VMS.

Open a web browser (Google Chrome, Mozilla Firefox and Safari are recommended), enter the server's IP address and press Enter.

By default login and password: admin/admin.

Run the following command from the VMS folder to stop the VMS server:

$ sudo docker-compose down

To update the VMS version:
1.stop the VMS
2.Run the following command from the VMS folder:

$ sudo docker-compose pull

3.Restart VMS:

$ sudo docker-compose up -d