Guide d'installation de ONYX Serveur de licence/en

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

A license server is a central license server which must stay accessible to all devices in the stock.<br/>
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.</br>

===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

# Unzip the file: tar -xvf Setup_LicenseServer_linux_xxxxxxxxx.tar.gz
# Launch the script install.sh (with root rights)
# 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 "your 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 <code>Mapping Licence server</code> 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 <code>/etc/mappinglstab</code> 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) ayant besoin d'une clé==
Le rôle de réclamer une clé est affecté à un binaire spécifique : '''LicenseRequester'''.

Ce binaire est fourni avec l'ensemble des binaires Mapping.

===Configuration du client===
La configuration du client se trouve dans le même fichier de configuration (mapping.conf) que les autres modules ONYX Server.

Pour activer l'utilisation d'un serveur de licence au niveau du client, il suffit d'ajouter le bloc suivant dans le fichier mapping.conf :
 <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>

Et renseigner les éléments suivants : 
* <code>LICENSE_SERVER</code> : ON/OFF (permet d'activer ou non le mode serveur de licence)
* <code>LICENSE_SERVER_IP</code> : adresse IP du serveur de licence (ne fonctionne pas avec une adresse DNS)
* <code>LICENSE_SERVER_PORT</code> : port d'écoute du serveur de licence.

===Execution===
'''LicenseRequester''' est invoqué automatiquement dès lors qu'un module Mapping a besoin d'une clé pour fonctionner.

Cependant, il est également possible de lancer manuellement une demande de clés :
 LicenseRequester -claim