CodeMeter Offline Licensing Deployment Guide

Background

If the server running LCC reconstruction cannot connect to the external network and cannot obtain authorization control information from the XGRIDS licensing server in real time, intranet licensing via CodeMeter is supported.

Solution Overview

Within the private data center, select one machine to serve as the CodeMeter license management server.
- The CodeMeter license management server can be a Windows machine or a Linux machine.
- If the data center supports 【USB dongle】, plug the USB dongle into this machine (XGRIDS provides a green USB dongle that supports intranet licensing).
- If the data center server does not support a USB hardware dongle, XGRIDS can generate a 【software license】 for a specific machine and import it into that machine.
Overview of the mode by which a Docker container requests a runtime license from the licensing server:

Linux Private Licensing Server Deployment

Install the CodeMeter Service

On the selected licensing server, install the CodeMeter Runtime environment, then:

If using the USB dongle form, simply plug the USB dongle into this server;
If using the software license mode, the software license must be bound to the hardware characteristics of the selected licensing server and cannot be changed.

※ If you choose to install the software license on a virtual machine, to keep this software license always available, do not change the physical machine hosting the virtual machine, and do not change the main hardware of that physical machine, such as the CPU, motherboard, network card, etc.

CodeMeter Runtime Installation Package Download Addresses

For servers with a newer OS version (such as Ubuntu 20.04 or above), CodeMeter Runtime (Version 8.20) is recommended:

Linux rpm：https://cdn-bukbb1.xgrids.cloud/developer/deploy/codemeter/CodeMeter-8.20.6558-501.x86_64.rpm
Linux deb：https://cdn-bukbb1.xgrids.cloud/developer/deploy/codemeter/codemeter-lite_8.20.6558.501_amd64.deb

If the server OS version is older, installing CodeMeter Runtime (Version 7.51) is recommended:

Linux rpm：https://cdn-bukbb1.xgrids.cloud/developer/deploy/codemeter/CodeMeter-lite-7.51.5429-500.x86_64.rpm
Linux deb：https://cdn-bukbb1.xgrids.cloud/developer/deploy/codemeter/codemeter-lite_7.51.5429.500_amd64.deb

CodeMeter Runtime Installation Method

# DOWNLOAD Version8.20
wget https://cdn-bukbb1.xgrids.cloud/developer/deploy/codemeter/codemeter-lite_8.20.6558.501_amd64.deb

# INSTALL
sudo dpkg -i --force-all ./codemeter-lite_8.20.6558.501_amd64.deb

# DOWNLOAD
wget https://cdn-bukbb1.xgrids.cloud/developer/deploy/codemeter/codemeter-lite_7.51.5429.500_amd64.deb

# INSTALL
sudo dpkg -i --force-all ./codemeter-lite_7.51.5429.500_amd64.deb

How to Uninstall CodeMeter Runtime

If the operating system version is newer (such as Ubuntu 20.04.6 LTS or above), when running the installation command for version 7.51, the output may contain an error message like 【Segmentation fault (core dumped)】.

sudo dpkg -i ./codemeter-lite_7.51.5429.500_amd64.deb    
                                                                                                                                                     
Selecting previously unselected package codemeter-lite.                                                                                                                                                                             
(Reading database ... 113440 files and directories currently installed.)                                                                                                                                                            
Preparing to unpack .../codemeter-lite_7.51.5429.500_amd64.deb ...                                                                                                                                                                  
Unpacking codemeter-lite (7.51.5429.500) ...                                                                                                                                                                                        
Setting up codemeter-lite (7.51.5429.500) ...                                                                                                                                                                                       
Segmentation fault (core dumped)                                                                                                                                                                                                    
Processing triggers for systemd (245.4-4ubuntu3.20) ...                                                                                                                                                                             
Processing triggers for man-db (2.9.1-1) ...

At the same time, running the cmu -l command, the output contains a "CodeMeter not running" error message.

In this case, it is recommended to uninstall the current version, then download version 8.20 and reinstall it.

# UNINSTALL 
sudo apt-get --purge remove codemeter-lite

Configure & Start the CodeMeter Network Licensing Service

After installation, you need to enable CodeMeter's network server feature. The specific steps are as follows:

a) Stop the CodeMeter service using the command line

sudo service codemeter stop 
sudo service codemeter-webadmin stop

**※ You must stop the service first before you can modify the ini file. Otherwise, the modifications will not take effect.**

b) Modify the Server.ini configuration file;

sudoedit /etc/wibu/CodeMeter/Server.ini

# Or open it with your preferred editor using administrator privileges:
sudo vim /etc/wibu/CodeMeter/Server.ini

c) In the Server.ini configuration file, set IsNetworkServer=1 (means allowing it to act as a server to license containers)

In the Server.ini configuration file, set CleanUpTimeOut=3 (means the license count is automatically released 3 minutes after a client terminates abnormally)

In the Server.ini configuration file, set RemoteRead=2 (means allowing the licensing server's WebUI to be accessed from other computers)

Save the file after modifying.

d) Start the CodeMeter service again using the command line

sudo service codemeter start
sudo service codemeter-webadmin start

e) Use the command line cmu -l to check whether the CodeMeter service started properly. If normal, it appears as shown below

This image is the Linux command-line output screen, corresponding to the check result after the CodeMeter service starts, produced by running the command 'cmu -l'. The screen shows the operating path as the root user being in the /home/wibu/Desktop directory of the Ubuntu system. After the command runs, it returns the CodeMeter Universal Support Tool version information (version 7.00b, released on April 23, 2020, for Linux), and also indicates that the number of currently connected Cm containers is 0. This result shows that the CodeMeter service check status is normal, matching the display for the service starting normally described in the context.

f) If startup is abnormal, the output will show CodeMeter not running.

If the configuration is still abnormal after strictly following the manual above, please contact technical support for help.

CodeMeter Licensing Server Management Page

If the licensing server's operating system itself has a graphical interface, you can open the management page by accessing http://localhost:22352/dashboard.html in the local browser.

The management page opened from the local machine has "write operation" permissions, such as taking a licensed client offline.

CodeMeter WebAdmin Dashboard page in the English interface. The top navigation bar contains Dashboard, Container, License Monitoring, Diagnosis, Configuration and Info, and the Dashboard panel lists Current Server, IP address, Operating System, Server Startup, Server Version and Runtime Version. This is the management page opened on the licensing server itself, which has write permissions.

If the licensing server's operating system does not have a graphical interface, in the installation steps above, Server.ini's RemoteRead=2 has already been set, which allows its management WebUI page to be accessed from other computers. If it has not been configured yet, the configuration method is as follows:

1) First stop the CodeMeter WebAdmin service (it must be stopped first)
sudo service codemeter-webadmin stop

2) Edit the ini file
sudo vim /etc/wibu/CodeMeter/Server.ini

Set RemoteRead to 2 in the [HTTP] section
RemoteRead=2   

3) Restart
sudo service codemeter-webadmin start

At this point, you can access the web page http://server IP address:22352/dashboard.html from another computer, where you can view the license management status:

CodeMeter WebAdmin Container page in the English interface. Red marks highlight the Container tab and the Licenses tab of the CmContainer card (serial number 3-6810124, CmStick/C 4.50). The license list of firm code 6001945 XGRIDS shows the Product Code, Name, Unit Counter, Valid Until, License Quantity and Feature Map columns, with the Product Code column boxed in red.

Import License

USB Dongle License Import Procedure

Simply plug the green USB dongle into this server.

Software License Import Procedure

Download the XGRIDS offline licensing tool software

#DOWNLOAD
wget https://xgbb1.oss-cn-shanghai.aliyuncs.com/developer/deploy/codemeter/codemeter-xgrids-tool

Run the tool on the server to output the license request file "XGrids-LCC-LICENSE-serialnumber.WibuCmRaC"

#DOWNLOAD codemeter-xgrids-tool
wget https://xgbb1.oss-cn-shanghai.aliyuncs.com/developer/deploy/codemeter/codemeter-xgrids-tool

#RUN codemeter-xgrids-tool
chmod +x ./codemeter-xgrids-tool
./codemeter-xgrids-tool

#OUTPUT：
-----> Make XGrids.WibuCmLIF
Executing command: /usr/bin/cmu -l
Command output:
 cmu - CodeMeter Universal Support Tool.
Version 8.20a of 2024-Dec-03 (Build 6558) for Linux
Copyright (C) 2007-2024 by WIBU-SYSTEMS AG. All rights reserved.

List all locally connected CmContainers:
- CmContainer with Serial Number 130-2780241535 and version 3.00 (empty)
Result: 1 CmContainer(s) listed.

Found Serial Number: 130-2780241535
Executing command: /usr/bin/cmu --create-lt-context --lt-request-file XGrids-LCC-LICENSE-130-2780241535.WibuCmRaC -s 130-2780241535 --firmcode 6001945
Command output:
 cmu - CodeMeter Universal Support Tool.
Version 8.20a of 2024-Dec-03 (Build 6558) for Linux
Copyright (C) 2007-2024 by WIBU-SYSTEMS AG. All rights reserved.

 Context file created successfully.

====== XGrids-LCC-LICENSE-130-2780241535.WibuCmRaC Created!  ======

Send the generated XGrids-LCC-LICENSE-serialnumber.WibuCmRaC file to the XGRIDS sales representative;
1. The XGRIDS sales representative uses this file to initiate the licensing application process.
2. After the application is approved, XGRIDS technical staff generate the license file (XGrids-LCC-LICENSE-serialnumber.WibuCmRaU).
XGRIDS sends the updated license file (XGrids-LCC-LICENSE-serialnumber.WibuCmRaU) to the customer.
After receiving the license file (XGrids-LCC-LICENSE-serialnumber.WibuCmRaU), the customer runs the following command on the server to import the update file:
```
cmu --import-lt-update --lt-update-file XGrids-LCC-LICENSE-<serial-number>.WibuCmRaU --firmcode 6001945 -s <serial-number>
```
To view the imported permissions within the licensing server, access http://server IP address:22352/dashboard.html

CodeMeter WebAdmin Container page in the English interface, used to check the licenses imported into the licensing server. Red marks highlight the Container tab, the Licenses tab and the Product Code column of firm code 6001945 XGRIDS, whose license entry shows the valid-until date, license quantity and feature map.

License Update Procedure

Query and record the current authorization serial number within the server

Run the `cmu -l` command to display the license serial number in the current system (for example, 130-1299254712). This serial number will be used in subsequent steps to generate the license request file.

This image shows the result of running a command in the Linux server command-line interface, used to obtain the license serial number. The top of the interface displays the version information of the CodeMeter tool currently in use, and below it clearly lists the locally connected CmContainers, where the license content with serial number 130-1299254712 is marked with a red box and indicated by a red arrow and the word 'serial number', corresponding to the license serial number mentioned in the context. This serial number is the key parameter needed to generate the license request file in subsequent steps.

Run the 【generate license request file】 command on the server: cmu --create-lt-context --lt-request-file "xxx.WibuCmRaC" -s130-xxxxxxxxxx --firmcode 6001945
1. 130-xxxxxxxxxx: the license serial number obtained in the previous step
2. xxx.WibuCmRac: the license request file name (the name can be customized, the suffix is fixed)
Provide the generated xxx.WibuCmRac to the relevant XGRIDS personnel, who will generate the license upgrade file xxx.WibuCmRaU (the suffix is fixed)
Run the 【import license upgrade file】 command on the server: cmu --import-lt-update --lt-update-file xxx.WibuCmRaU --firmcode 6001945 -s 130-xxxxxxxxxx
1. 130-xxxxxxxxxx: the license serial number obtained in the previous step
2. xxx.WibuCmRaU: the license upgrade file name generated by XGRIDS (the name can be customized, the suffix is fixed)
To view the updated server permissions, access http://server IP address:22352/dashboard.html

CodeMeter WebAdmin Container page in the English interface, showing the licenses after the update. A red box and arrow highlight the Valid Until column of firm code 6001945 XGRIDS, which now reads 2027-09-14 23:59:59, together with the License Quantity and Feature Map columns.

Note: After authorization becomes invalid due to a system reinstall, you need to import all the 【*.WibuCmRaU】 files in sequence to restore the original authorization. Please keep every 【*.WibuCmRaU】 file delivered to you.

Settings When the LCC Container Starts

When the LCC container starts, pass the licensing server's IP address into the container as the "CODEMETER_SERVER" environment variable.

For details, refer to the 【LCC Reconstruction Software Docker Edition】 guide.

※ When starting the LCC container, note that you must not use the –privileged parameter in the startup command line

※ The container's network connection is generally the Bridge mode by default. Please keep this mode, otherwise the encryption program may fail to communicate

Others

How to Check the Accessibility of the Licensing Server

When a container runs on another host machine, you first need to confirm that this host machine can access port 22350 of the licensing server.

The test command is as follows:

telnet 192.168.68.205 22350

Trying 192.168.68.205...
Connected to 192.168.68.205.
Escape character is '^]'.

At the same time, note that host machines other than the licensing server must not install CodeMeter Runtime, otherwise when the container runs it will first look for authorization within the current host machine, causing it to fail to obtain authorization properly.

How to Determine Whether CodeMeter Runtime Startup Is Abnormal

If the output of the cmu -l command contains CodeMeter not running, it means it did not start properly. Please contact technical support to investigate the cause (the installation may have failed.)

cmu -l 

cmu - CodeMeter Universal Support Tool. 
Version 7.51 of 2022-Aug-25 (Build 5429) for Linux
                                            
List all locally connected CmContainers:   
Result: 0 CmContainer(s) listed. (CodeMeter not running)

How to View the Current License Usage

After the program inside the container starts, it will request the number of licenses required for execution based on the specified CodeMeter licensing server address.

When the process terminates normally, the license will generally be released within a few minutes; the license can then be normally used by the next startup.

CodeMeter WebAdmin License Monitoring page in the English interface, listing the available licenses on the server. The table shows the Product Code, Name, Feature Map and License Quantity columns, and a red box highlights the Used and Available columns that indicate how many licenses are currently occupied.

How to Manually Release a License

If the container is killed directly, the license requested by the process inside the container needs to wait until timeout before it can be released (the default timeout of the CodeMeter license server is generally 120 minutes; in the installation tutorial of this document, it has been changed to 3 minutes).

From the License Monitor page, based on the last access time, you can confirm terminated programs and click the operation button to release them manually.

CodeMeter WebAdmin License Monitoring Details page in the English interface. The table lists ID, Client (User), Client Process ID, Application Information, Access Mode, First Access, Last Access and Expires, and a red box and arrow highlight the Action column, which is used to release a license manually.

Note: Only when opening the WebUI page on the licensing server's local machine do you have operation permissions. Otherwise, you can only wait for automatic release.

Authorization Exception Handling Method

When authorization is damaged for some reason (system exception):

First, delete the existing authorization: cmu -sserialnumber --delete-cmact-license

Then import them one by one starting from the WibuCmRaU file of the first authorization

Reference: Official Documentation on the Specific Procedure for Importing a Software License

https://help.wibu.com.cn/help/FAQ/codemeter/cmact/1757

Delete the Software Lock Authorization Bound on the Server

Refer to the official documentation for instructions: https://help.wibu.com.cn/help/FAQ/codemeter/cmact/ad7e

If operating on a Windows system, open CMD and enter the command line `cmu32 –l` to view the software lock serial number.

The image shows the interface for viewing the software lock serial number using the `cmu32 -l` command on a Windows system. The top of the interface displays the version information of the CodeMeter Manager, and below it lists all locally connected CmContainers, where the software lock serial number '130 - 1633636009' is highlighted with a red box. This image relates to the operation steps for deleting the software lock authorization bound on the server in the document, and is the example for the operation of viewing the software lock serial number in step 1, helping the user confirm the software lock serial number to subsequently perform the software lock deletion operation.

Then use the following command to delete the software lock:

cmu32 -s130-1633636009 --delete-cmact-license

If operating on a Linux system, enter the `cmu –l` command to view the software lock serial number, then use the following command to delete the software lock.

cmu -s130-1633636009 --delete-cmact-license