Licensing¶
IDLive Doc uses software protection to protect ID R&D's intellectual property. To function, the IDLive Doc's libraries require a license key, which should be installed on the target system before starting your application.
If the key is not present your application will fail to start with the following error:
Sentinel LDK Protection System: Sentinel key not found (H0007)
You don't need the license key to compile the application, only to run it.
License variants¶
IDLive Doc SDK is distributed in 2 variants: Eval (for evaluation) and Prod (for production). They differ in limitations the license imposes:
-
The evaluation variant will function for 90 days from the release date.
-
The production variant will function for 1 year from the release date.
The expiration date can be found in the key's file name. For example the key:
eval-license-2022-05-02.usermode.v2c
will expire on May 2, 2022. You can additionally query the expiration date via the API. Once the license has expired you either need to update to the new IDLive Doc version or contact us for the new license key.
Install license key¶
The license key is a file with an extension .v2c
. The archive with license key and license installation utility is provided in the license package and can be found in the sdk
folder. License is installed as following:
./install_license_linux *.usermode.v2c
.\install_license_windows.exe *.usermode.v2c
The license key will be installed for the current user only.
Admin mode license ¶
The default license key contains a user mode license and it can only be used by one system user. It can be separately installed for every user necessary, but we additionally provide the key with an admin mode license that can be used system-wise. As a downside it requires you to install a special system service (RTE, or Run-time Environment). See the next section for the installation manual.
The key can be found in the license package's docker
directory. You can install it once you've installed the RTE:
./install_license_linux docker/*.adminmode.v2c
As you can notice the "mode" of the license is mentioned in the key's file name. You should use the key with either admin mode or user mode license, not both. It is safe to install both keys but this won't bring any benefits.
Note
Admin mode licenses are currently only provided for Linux releases.
Install RTE¶
The RTE package is in aksusbd.tar.gz
archive which is located in the rte
directory of license package. You need to unpack it and run the installer:
mkdir aksusbd
tar xf aksusbd.tar.gz -C aksusbd --strip-components=1
cd aksusbd
sudo ./dinst
This will install a aksusbd
system service. You can control it with the service manager your OS has. For example to check the service's status run this:
sudo systemctl status aksusbd.service
sudo service aksusbd status
This service should be active for the admin mode license to work.