Licensing

Before using Edge Xpert, you must install a license which is validated as each Edge Xpert service starts.

A docker volume is provisioned with your license file or files. You can use the following command to manage your license file:

edgexpert license [<option>]

The options are as follows:

Option	Description
`install`	Installs the specified licenses to the license volume
`uninstall`	Uninstall the specified license
`view`	Lists all currently installed licenses
`check`	Validates all installed licenses
`clean`	Deletes the license volume

Obtaining a License

Edge Xpert Customers

Users with an active Edge Xpert support contract can download their corresponding license file(s) from the Support Portal on the IOTech website. After logging in, navigate to My License Keys where you can check and download your licenses.

Edge Xpert Evaluators

Users wishing to evaluate Edge Xpert will receive an evaluation / trial license by filling in the downloads form here.

License Read Permissions

Please ensure that your license file has appropriate permissions. To allow the Edge Xpert containers to read the license file, the Other user must have read access. This can be verifed using the following command:

ls -l <path>/<license file>

The Other permission set is the three-character block at the end of the permission code. If this does not include r, read permission can be granted with the following command:

chmod +r <path>/<license file>

If read permission has not been granted for your license file, Edge Xpert services will not be able to access the license file and run correctly.

Install a License

Info

License volume is renamed to license-data to better support Docker Compose v2 in v2.3.0 release.
Please reinstall license(s) after upgrading Edge Xpert to 2.3.x

To install a license, do the following:

Open a terminal

Enter the following command:

edgexpert license install <path>/<license file>

If the license is successfully installed, the terminal displays the following:

Creating license volume: license-data
The following license/s were installed:  
<license file>

Validate a License

To validate a license, do the following:

Open a terminal

Enter the following command:

edgexpert license check

If the check is successful, the terminal displays the following:

Edge Xpert Licensing: Validating License File <license file>
Edge Xpert Licensing: Signature valid
Edge Xpert Licensing: License valid

List Installed Licenses

To list all installed licenses, do the following:

Open a terminal
Enter the following command:
```
edgexpert license view
```
The terminal displays a list of all installed licenses.

Uninstall a License

To uninstall a license, do the following:

Open a terminal
Enter the following command:
```
edgexpert license uninstall <license file>
```
If the license is successfully uninstalled, the terminal displays the following:
```
Successfully uninstalled license: <license file>
```

Delete the License Volume

To delete the license volume, do the following:

Open a terminal
Enter the following command:
```
edgexpert license clean
```
Enter y when prompted, as illustrated below, to confirm deletion of the license-data volume and to clear all installed licenses:
```
clean: delete the license-data volume and clear all installed licenses (y/n)? y
```