License activation#
This section describes license activation.
License activation should be performed after the distribution package is unarchived.
The generated license can only be used on the device where it was activated as the fingerprint of the device is used for its creation.
NOTE! Always remember that incorrect config may huck the things up very badly. Pay attention to what you configure and how. Always double-check what you deploy.
Online activation#
Online activation is performed when you have an Internet connection on the device where the LUNA SDK license is activated.
Licensing configuration options are specified via the "license.conf" file which is an XML document with special tag formatting.
You can find the "license.conf" file in the "data" directory in the distribution package.
This file is mandatory for license activation. You must fill it with the correct values before launching LUNA SDK.
Fill in this file carefully. Incorrectly entered data may cause problems with activation on the device.
Online activation process#
The activation process is as follows:
- Request the Server, EID, and ProductID from VisionLabs
- Go to the "data" directory
- Open the "license.conf" file
- Enter the received parameters
- Save changes in the "license.conf" file
The license key will be generated and saved to the "data" directory.
Now you can use LUNA SDK.
License file parameters description#
License activation and next processing requires parameters listed below.
| Parameter | Description | Type | Default value |
|---|---|---|---|
| Server | Activation server URL | "Value::String" | (empty) |
| EID | Entitlement ID | "Value::String" | (empty) |
| ProductID | Product ID | "Value::String" | (empty) |
| Filename | Default license filename | "Value::String" | license.dat |
| ContainerMode | If run in container | "Value::Int1" | 0 |
| ConnectionTimeout | Request timeout (in seconds) | "Value::Int1" | 15 |
Server, EID, and ProductID - this information must be requested from VisionLabs and written to the file. It is mandatory for activation procedure.
EID field should be filled in for the online and offline activation.
Server and ProductID fields should be filled in for the online activation only.
Filename - the name of the file to save license after activation. The maximum length of the setting string is 64 symbols. Do not change this name!
ContainerMode - 0 - ignore any virtual network interfaces in the formation of the fingerprint.
1 - take into account all virtual interfaces in the formation of a fingerprint. The last option used while
running in docker container due to physical network interface is not available by default.
Although, you can make physical interface available with --net=host and set ContainerMode to 0
In this case you can be sure fingerprint will not be changed among containers.
More reading in "Licensing in docker container"
ConnectionTimeout - set the maximum time in seconds that you allow to transfer operation to take.
Normally, name lookups can take a considerable time and limiting operations risk aborting perfectly normal operations.
Timeout 0 (zero) means it never times out during transfer. The ConnectionTimeout can't be set to a negative value,
or a value that is large than maximal, which is 300 seconds.
By default, the file is created in the "data" directory. The file has a binary format. At the next launch of the product on the same device, a license will be read from this file.
An example of the "license.conf" file:
<section name="Licensing::Settings">
<param name="Server" type="Value::String" text=""/>
<param name="EID" type="Value::String" text=""/>
<param name="ProductID" type="Value::String" text=""/>
<param name="Filename" type="Value::String" text="license.dat"/>
<param name="ContainerMode" type="Value::Int1" x="0"/>
<param name="ConnectionTimeout" type="Value::Int1" x="15"/>
</section>