Installing, updating, and removing Long-term database🔗

The Long-term database service ensures storing of selected types of events and access to them regardless of the archive storage settings. With this service there is no need to be concerned that event data will be lost if the archive is deleted.

Note

This feature is available only for Enterprise and ULTRA licenses.

The service can be installed on any computer without installing the Eocortex server on it.

Only one service instance can be configured for the entire system.

The service can be installed using the following two options:

  • Online, if the device has Internet access.

  • Offline, if the device does not have Internet access.

Supported versions:

  • Debian 10

  • Debian 11

Online installation

  1. Add Eocortex repository:

    wget -O - http://packages.eocortex.com/deb/install/eocortex-deps-debian.sh | bash

  2. Install the service.

    sudo apt-get install eocortex-long-term-database-service
Offline installation

Warning

For this installation method, you will need a computer with Internet access and the same operating system as the one on which you want to install the Long-term database service.

  1. Clear local repository:

    sudo apt-get clean

  2. Add Eocortex repository:

    wget -O - http://packages.eocortex.com/deb/install/eocortex-deps-debian.sh | bash

  3. Install all required packages (dependencies):

    sudo apt-get install -d -y eocortex-long-term-database-service

  4. Create the LongTermDatabasePackages directory and transfer all downloaded packages to it:

    mkdir ~/LongTermDatabasePackages/ && cp -R /var/cache/apt/archives/*.deb ~/LongTermDatabasePackages/

  5. After that, copy the entire LongTermDatabasePackages directory to a USB drive and transfer the data to the server. Install the Long-term database service and all dependencies using the following command:

    sudo dpkg -i /path_to_LongTermDatabasePackages/*.deb
Dependencies

The following dependency packages must be installed in the operating system for the service to work:

  • aspnetcore-runtime-6.0 (>= 6.0)

  • debconf (>= 0.5)

  • postgresql-12

During the online installation the dependency packages will be installed automatically, while during the offline installation they may require to be installed manually.

To check if a package is installed and its version, use the command dpkg -s %package_name%.

Update

To update the service, run the following commands:

sudo apt-get update

sudo apt-get install eocortex-long-term-database-service

Or download a new version package from the repository and install it manually using the dpkg command.

Uninstallation

To uninstall the service, use the following command:

sudo apt-get remove eocortex-long-term-database-service

Supported versions:

  • Ubuntu 20.04

  • Ubuntu 22.04

Online installation

  1. Add Eocortex repository:

    wget -O - http://packages.eocortex.com/deb/install/eocortex-deps-ubuntu.sh | bash

  2. Install the service.

    sudo apt-get install eocortex-long-term-database-service
Offline installation

Warning

For this installation method, you will need a computer with Internet access and the same operating system as the one on which you want to install the Long-term database service.

  1. Clear local repository:

    sudo apt-get clean

  2. Add Eocortex repository:

    wget -O - http://packages.eocortex.com/deb/install/eocortex-deps-ubuntu.sh | bash

  3. Install all required packages (dependencies):

    sudo apt-get install -d -y eocortex-long-term-database-service

  4. Create the LongTermDatabasePackages directory and transfer all downloaded packages to it:

    mkdir ~/LongTermDatabasePackages/ && cp -R /var/cache/apt/archives/*.deb ~/LongTermDatabasePackages/

  5. After that, copy the entire LongTermDatabasePackages directory to a USB drive and transfer the data to the server. Install the Long-term database service and all dependencies using the following command:

    sudo dpkg -i /path_to_LongTermDatabasePackages/*.deb
Dependencies

The following dependency packages must be installed in the operating system for the service to work:

  • aspnetcore-runtime-6.0 (>= 6.0)

  • debconf (>= 0.5)

  • postgresql-12

During the online installation the dependency packages will be installed automatically, while during the offline installation they may require to be installed manually.

To check if a package is installed and its version, use the command dpkg -s %package_name%.

Update

To update the service, run the following commands:

sudo apt-get update

sudo apt-get install eocortex-long-term-database-service

Or download a new version package from the repository and install it manually using the dpkg command.

Uninstallation

To uninstall the service, use the following command:

sudo apt-get remove eocortex-long-term-database-service

Network settings of the service🔗

Warning

These settings should be made on the device where the service is installed.

As part of the installation process, a configuration file appsettings.json containing network settings will be created in the root directory of the service.

Default path:

/opt/EocortexLongTermDatabaseService/appsettings.json

Below is an example of default settings:

{
    "Application": {
        "Brand": "Eocortex",
        "AppName": "LongTermDatabase"
    },
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft.AspNetCore": "Warning"
        }
    },
    "AllowedHosts": "*",
    "AlwaysRedirectToHttps": false,
    "Network": {
        "Endpoints": {
            "Http": {
                "Url": "http://*:8999"
            }
        }
    },
    "ConnectionStrings": {
        "DefaultConnectionString": "Host=localhost;Port=5432;Database=longtermdatabase;Username=eocortex;Password=masterkey;",
        "ConnectionStringWithDatabasePlaceholder": "Host=localhost;Port=5432;Database={0};Username=eocortex;Password=masterkey;"
    }
}

To change the HTTP port, find the following section in the configuration file:

"Network": {
    "Endpoints": {
        "Http": {
            "Url": "http://*:8999"
        }
    }
},

And set a custom port in the Url line instead of the default 8999.

To add an SSL certificate to the service configuration and enable HTTPS connection, change the Network section as follows:

"Network": {
    "Endpoints": {
        "Http": {
            "Url": "http://*:8999"
        },
        "HttpsInlineCertFile": {
            "Url": "https://*:18999",
            "Certificate": {
                "Path": "path_to_the_cert",
                "Password": "cert_password"
            }
        }
    }
}

Where:

  • Path: Location of the PFX file of the certificate.

  • Password: Password of the certificate.

Note

Changing the HTTPS port can be done similarly to the HTTP protocol, but for the HttpsInlineCertFile section.

To enable forced redirection of all requests to the service to a secured connection, find and change the value from false to true for the following line:

"AlwaysRedirectToHttps": false,

Note

After saving the settings, the service must be restarted via the Services snap-in to take all changes into effect.

Warning

Changing other settings provided in the configuration file may cause the service to malfunction or fail. It is not recommended to change settings that are not described in the present documentation.

Related references🔗

Overview of the service

Usage of the service in the Eocortex Client application

Long-term database

Installation of Long-term database on Windows