Description

HSM Server is a solution, which can collect and store monitoring data from different sources as well as pass it to clients via different ways. HSM server is written with .Net Core 5.0, which means that it is a cross-platform solution. There is always a Docker Image, which contains the latest version of HSM server. We recommend to launch HSM server as a Docker container with the image above.

Installation guide

Install Docker

Go to docker.com to see the docker installation guide.

Get HSM server image

To download the image just pull it from the dockerhub. Use the following terminal command:

docker pull hsmonitoring/hierarchical_sensor_monitoring:_version_

Substitute the version with the HSM server version you want to install. For example, current stable version is 2.1.4.

Launching a container

HSM Server application uses port 44330 for the API which receives monitoring data, default SSL port 443 for safe connection to a website, and port 22900 for gRPC client. Do not forget to configure the ports when run the container! Otherwise, the ports will be unreachable.

IMPORTANT! Docker containers store the data inside themselves, and that data is removed when the container is killed. HSM Server collects monitoring data and stores it in a database, so you need some other settings in order not to lose your monitoring data after the container is stopped. We recommend using docker volumes and mapping some folders inside the container to the folders from your computer files system. We strongly recommend to create volumes not only for database, but also for configuration and logs folders. Considering this, the final command for running the HSM Server would look similar to this:

docker run -d -it -v  /usr/HSM/Logs:/app/Logs -v /usr/HSM/MonitoringData:/app/MonitoringData -v /usr/HSM/Config:/app/Config -v /usr/HSM/Databases:/app/Databases -p 44330:44330 -p 22900:22900 -p 443:44333 hsmonitoring/hierarchical_sensor_monitoring

In case of using the above command, the database will be stored at /usr/HSM/MonitoringData folder, configuration files at /usr/HSM/Config, and logs at /usr/HSM/Logs. Please note, that you should not change the paths /app/Logs, /app/MonitoringData and /app/Config!

Updating HSM Server

Once you see a new published tag and/or release in this repository - you can update your HSM Server. To do this, stop current container with HSM Server running, remove old image, and go through the installation steps again.