Skip to content

License activation#

This section describes license activation in online and offline mode.

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.

Online activation#

Online activation is performed when you have an Internet connection on the device where the FaceStream 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 "./bin/data/" directory in the distribution package.

This file is mandatory for license activation. You must fill it with the correct values before launching FaceStream.

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 "./bin/data/" directory
  • Open the "license.conf" file
  • Enter the received parameters
  • Save changes in the "license.conf" file
  • Launch FaceStream

The license key will be generated and saved to the "./bin/data/" directory.

Offline activation#

Offline activation is performed when you do not have an Internet connection on the device where the FaceStream license is activated.

In this case, you should create a fingerprint of your device and use it to receive a license key on any other device with the Internet.

Offline activation process#

The activation process is as follows:

  • Request the website address for license key activation and EID from VisionLabs

Perform the following steps on the device where the license should be activated:

  • Go to the "./bin/data/" directory

  • Open the "license.conf" file

  • Enter the received EID

  • Save changes in the "license.conf" file

  • Go to the "./bin"

  • Run the "FingerprintViewer" utility to create a fingerprint of your device:

  • For Windows: launch the "FingerprintViewer.exe"

  • For Linux:

    • Give execution permissions to the "FingerprintViewer" utility

    chmod +x FingerprintViewer

    • Run the utility

    ./FingerprintViewer

  • The fingerprint will be printed in the console. Copy and save it.

Perform the following steps on the device with the Internet:

  • Go to the website to receive license (the website address was received on the first step of this instruction)

  • Enter your EID to enter the website

  • Get a license using your device fingerprint

  • Move the "license.dat" file to your device with FaceStream.

Perform the following step on the device where the license should be activated:

  • Copy the received license key "license.dat" to the "./bin/data/" directory of FaceStream.

License file parameters description#

License activation and next processing require the 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 activate license in containers "Value::Int1" 0

Server, EID, and ProductID - this information must be requested from VisionLabs and written to the file.

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!

By default, the file is created in the "./bin/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.

ContainerMode - the flag enables you to use the licensed product in Docker containers.

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"/>
</section>
Back to top