Skip to main content

Run KentixONE as a Docker container

To set up a virtual SiteManager, you need a Docker installation on your server system. After installing Docker, create a docker-compose.yml file in a directory of your choice.

docker-compose.yml
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, you can configure all necessary settings. Most importantly, set the IP or domain under which the web interface should be reachable. You can also change the container name and the names of the virtual volumes as you like.

Docker Login​

Before you can start the stack, you must log in to the Docker registry on the server. Use the command "docker login" and enter "license" as the username and your personal Docker license as the password.

docker login kentix360.com:5000

Credentials:

  • User: license
  • Password: [your personal Docker license]

If the login is successful, you should see the following message:

Authenticating with existing credentials...
Login Succeeded

Start the stack​

After successful authentication, start the stack with the command "docker-compose up". On Linux/macOS, you must run it with "sudo".

sudo docker compose up

Downloading the container image can take some time. As soon as you see the following message, the container has been built and started successfully:

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

You should now see the container's live process logs. These indicate the boot progress and the address the container started with. If you don't want to follow the process in the console, start the stack in detached mode by adding "-d":

sudo docker compose up -d

The virtual SiteManager should now be reachable at the IP address you configured.

Update the Docker container​

If a container installation exists as described above, you can update the Docker container with the following sequence of commands:

sudo docker compose down

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

sudo docker compose up -d

This stops the container and deletes any data that is not stored on a volume. Please also observe any migration notes that may apply.

Wichtiger Hinweis zur Migration 8.x.x → 8.3.0

If you plan to migrate a Docker container to version 8.3.0 or later, please note the following. Due to a missing configuration entry, camera images may be deleted during the update.

This occurs if no dedicated volume for the camera images is defined in the Docker Compose file, for example:

  • mount:/mnt/

Procedure for a faulty configuration​

Find the current name of your container. You can do this with the following command:

docker ps

An example 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 several Docker containers exist, you can identify the correct one by the image name.

Back up the camera images with the following command:

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

Then update the container. After the Docker container has been updated and started, you can restore the images with the following command:

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

These steps ensure all camera recordings are preserved after the update. In addition, you should extend your Docker Compose file to include the volume for the camera images.