Installation guidelines for the ONYX license server

The use of a license server is an alternative to the use of traditional license keys (provided by Mapping).
It allows ONYX servers to obtain licenses upon request.
This can, for instance, allow you to manage a pool of ONYX servers that can adapt to the number of licenses according to demand.

A license server is a central server which must stay accessible to all devices in the pool.
Each ONYX server is linked to it as a client.

License Server

The license server has Mapping license keys available which it provides to clients requesting them.

Installation

Linux

Requirements

The following librairies must be installed and updated on the installation server:

• openssl1.0 (or equivalent, the binary file searched for is libcrypto.so.1)
• libcap-progs (or libcap2-bin on some systems)

Steps

The license server is provided in the form of a .tar.gz file

1. Unzip the file: tar -xvf Setup_LicenseServer_linux_xxxxxxxxx.tar.gz
2. Launch the script install.sh (with root rights)
3. Follow instructions

Extract from a usual installation process:

Where do you want to install the application? [/apps/M-LicenseServer/]
>
Installation directory: /apps/M-LicenseServer/
same for data directory: /apps/M-LicenseServer/

Which listening port for this server? [2005]
>
Listening port: 2005

The application was succefully installed!

Do you want to start the service now? [Y/n]
>
Starting M-LicenseServer...
done.
Service started.

Entering software keys

The license keys (provided by Mapping) must be entered with the following command for the license server to be activated:

M-LicenseServer -key

The program then allows you to enter the software keys:

Your serial number: DEADD00D
Your type of processor: x86_x86_

Enter the product number:
Enter the key:

Information such as "serial number" and "type of processor" must be transmitted to Mapping to obtain the software keys to activate the server.

Launching the server in service mode

Linux

systemctl start M-LicenseServer

Windows

A new entry point called Mapping Licence server was created in the operating system's list of services.

Launching the server in interactive mode

This launch mode is recommended for Docker containers:

M-LicenseServer -debug

This mode does not give control back.

Configuration

Linux

The configuration file's location (mapping.conf) is given in the /etc/mappinglstab file

Windows

The configuration file's location (mapping.conf) is given in the Windows Registry:

HKLM\SOFTWARE\Mapping\Licence server\ConfigFileFullpath

(Or a similar location such as WOW6432Node, HKCU...)

Client (ONYX Server) needing a key

When a key is retrieved it is assigned to a specific binary file: LicenseRequester.

This binary file is provided with the rest of all Mapping binary files.

Configuring the client

The configuration file for the client is located in the same configuration file (mapping.conf) as other ONYX Server modules.

To activate the use of a license server at client level, the following block needs to be added to the mapping.conf file:

<block name="LICENSESSERVER">
  <group>
    <element>
      <info name="[LICENSE_SERVER]">ON</info>
      <info name="[LICENSE_SERVER_IP]">192.168.10.11</info>
      <info name="[LICENSE_SERVER_PORT]">2005</info>
    </element>
   </group>
 </block>

The following elements need to be specified:

• LICENSE_SERVER: ON/OFF (activates or does not activate the license server mode)
• LICENSE_SERVER_IP: IP address of the license server (does not run with a DNS address)
• LICENSE_SERVER_PORT: listening port of the license server.

Running the license server

LicenseRequester is automatically called as soon as a Mapping module needs a key to run.

However, keys can also be requested manually with:

LicenseRequester -claim