SiteManager as a Docker container – MANUAL

KentixONE Operating mode

SiteManager Operation	Stand-alone operation

For the installation of SiteManager Docker, a deeper knowledge of Docker technology is required. Details on basic Docker topics are not covered here and cannot be covered by our technical support.

To set up a Virtual SiteManager, a Docker installation is required on your server system. After successful Docker installation, create a docker-compose.yml file in a directory of your choice.

version: "3"
services:
  sitemanager:
  image: kentix360.com:5000/sitemanager:latest
  environment:
  - address=192.168.178.137
  - license=D2EE-09EA-7C9B-C174-7BB2-9C8D-59F3-903E
  volumes:
  - webserver_shared:/var/www/shared
  - data:/media/data/
  - mount:/mnt/
  ports:
  - "192.168.178.137:443:443"
  - "192.168.178.137:80:80"
volumes:
  webserver_shared:
  data:
  mount:

With this file all necessary settings can be configured. Important here is mainly the IP or domain under which the web interface should be reached. The names of the container and virtual volumes can also be changed as desired.

Before the stack can be started, a Docker login to the server must occur. To do this, use the command “docker login ” and enter “license” for the user name and “your personal Docker license” for the password.

docker login kentix360.com:5000
----
User: license
Password:  [Ihre persönliche Docker Lizenz]

If the login is successful, the following message should appear:

Authenticating with existing credentials...
Login Succeeded

After successful authentication, start the stack with the command “docker-compose up”. Under Linux/MacOS you have to execute this with “sudo“.

sudo docker compose up

Downloading the container image may take some time. Once the following message appears, the container has been successfully built and started:

Creating "yourFolder"_sitemanager_1 ... done
Attaching to "yourFolder"_sitemanager_1

Now you should see the active process logs of the container. These indicate the status of the startup and the address with which the container was started. If you do not want to actively follow the process in the console, start the stack detached with the addition “-d“:

sudo docker compose up -d

Now the Virtual SiteManager is reachable under the IP address you have defined, if the configuration is correct.

Updating the Docker container

If there is a container installation as described above, the Docker container can be updated with the following command sequence:

sudo docker compose down

sudo docker pull kentix360.com:5000/sitemanager:latest

sudo docker compose up -d

This will shut down the container and delete all data not backed up to the volume. Please note any upcoming migration notices.

Important note, for the migration of versions 8.x.x → 8.3.0

If you want to migrate a Docker container to version 8.3.0 or higher, please note the following. Due to a missing configuration information, camera images can be deleted during an update.

This case occurs when no separate volume for the camera images is defined in the Docker Compose file:

- mount:/mnt/

Procedure in the event of a faulty configuration

Find out the current name of your container. This can be done with the following command:

docker ps

A sample output looks like this:

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
01b2a337f77e kentix360.com:5000/sitemanager:latest. "/usr/bin/supervisor..." 19 seconds ago Up 16 seconds 161-162/tcp, 0.0.0.0:443->443/tcp, 0.0.0.0:81->80/tcp sitemanager-1

The name is in the last column of the table, in this case ‘sitemanager-1’. If there are multiple Docker containers, you can use the name of the image as a guide.

Use the following command to save the camera images:

docker exec {Docker-Name} mv /mnt/kentix /media/data/sd_card

Afterwards you update the container. After the Docker container is updated and started, you can restore the images with the following command:

docker exec {Docker-Name} mv /media/data/sd_card/kentix /mnt

With the help of these steps, all camera recordings will be preserved after the update. Additionally, you should extend your Docker Compose file to include the volume for the camera images.