Install and Administer the License Server on Linux

System Requirements

Minimum hardware requirements:

Disk: 500 MB
RAM: 4 GB
CPU: 2 GHz - 2 Cores

The License Server requires an Intel/AMD 64-bit processor and a Linux distribution. In general, the License Server should successfully function on the Linux systems supported by MongoDB Community Server 8.0 and Node.js 22. These include:

RedHat/CentOS 8.0 and 9.0
SUSE 15
Debian 12
Ubuntu 20.04, 22.04, and 24.04
Amazon Linux 2023

Installing the License Server in a Docker container is not supported.

License Administrator User Interface Requirements

The following are required to use the License Administrator user interface to manage your License Server licenses:

Debian-based Linux with the libwebkit2gtk-4.0-37 and libgtk-3-0 packages installed.

Fedora-based Linux with the webkit2gtk and gtk3 packages installed.

Alternately, a command line licensing command can also be used to manage your License Server licenses if a desktop user interface is not available for your server. For details, see the Licensing Utility section.

Root or Sudo Privileges

You need root or sudo privileges to perform the steps in this document.

A graphical session is required to run the License Administrator user interface, which may be invoked during the License Server installation. Some Linux distributions disable this when the sudo command is invoked (i.e., the required DISPLAY environment variable is not set). If this is the case for your Linux distribution, use an alternative to sudo (such as direct root login or su), or the sudo configuration should be updated appropriately.

Firewall Configuration

Correct System Time and Date

Install the License Server Service

The License Server requires MongoDB Community Server on the machine. The installer will perform a check to determine if it is already installed. If it is not, you will be prompted to allow installing MongoDB before proceeding to License Server installation. So that MongoDB can be installed for you, you will need to have a package manager on the machine, such as apt-get or yum. If a package manager is not available, MongoDB will need to be installed manually.

Uncompress the setup-license_serverxx-linux.gz archive file that was downloaded to your computer, then unpack the file:

gunzip setup-"Resources/Snippets/LicenseServerVer.flsnp" />-linux.tgz
tar -xf setup-"Resources/Snippets/LicenseServerVer.flsnp" />-linux.tar

Change to the directory that has the installer script:
```
cd "Resources/Snippets/LicenseServerVer.flsnp" />
```
Start the installer:
```
./install_linux.sh
```
If prompted, allow installing MongoDB Community Server.
At the "Enter the name of a user account to run the service" prompt, enter one of the following:
- daemon, a generic user ID available in most Linux distributions that can be used to run background services.
- A specific user ID you have created for the purpose of running this license server.
- Your own account name.
When installation is complete, activate the license by entering Yes at the prompt to open the License Administrator.

Optionally, if you have a license.dat file, you can skip the activation process and place the file in the /license directory.

You can also activate licenses from the command line using the Licensing utility described in this document.

License Administrator

You will be prompted to open the License Administrator after installation is complete. To start the License Administrator at other times (e.g., to deactivate a license), run the license_administrator.sh file located in the /bin directory.

Connect a Client to the License Server

Clients can connect to the License Server using the License Administrator tool that is installed with their ENVI and IDL software.

Connect a Client to a License Server Using a Text File

Licensing Utility

To use the Licensing utility, open a terminal window and change to the /bin directory.

Activate Licenses

To activate a license (requires Internet access):

./licensing activate <activation_code>

where <activation code> is in the format 0000-0000-0000-0000. Submitting the activation code contacts the licensing portal with machine binding information. The portal returns a license, which will then be installed.

You can call activate multiple times to add more codes to the existing license, without needing to deactivate.
By default, a license is activated with a count of 1. You can optionally specify a different count by using a slash /. For example:
```
./licensing activate <activation_code>/2
```
You cannot change the count after the license is added (the same code cannot be activated multiple times). To change the count, you must deactivate the code, then re-add it with the new count.
You can also enter multiple activation codes of varying counts. For example:
```
./licensing activate <activation_code1> <activation_code2>/5
```
where <activation_code1> will be activated with the default count of 1 and <activation_code2> will be activated with a count of 5.

Check for License Upgrades

To check if a new license is available (requires Internet access):

./licensing check upgrades

If any parts of your license are eligible for upgrade, a list of upgradable Activation Codes will be returned. Use the upgrade subcommand to activate them.

Upgrade Licenses

To get the available license upgrades (requires Internet access):

./licensing upgrade

Deactivate Licenses

Deactivate licenses before uninstalling the License Server from the machine. To deactivate a license (requires Internet access):

To deactivate all licenses:
```
./licensing deactivate
```
To deactivate a specific license:
```
./licensing deactivate <activation_code>
```
where <activation_code> is in the format 0000-0000-0000-0000.

Connect a Client to a License Server

To connect a client to a license server, use the --proxy_server option:

./licensing activate <activation_code> --proxy_server=<ip_address> --proxy_port=<port_number>

See the Proxy Server section for additional options.

Print Binding Keys

To print the machine's key binding to the screen:

./licensing get bindings

Print License Details

To print license details to the screen:

./licensing show license

Other Options with the License Utility

License Server Configuration

Default configuration settings for the License Server are set in the /config/production.json file.

You must restart the License Server service after editing the License Server configuration file.

  "http": {

    "host": "192.168.128.1",

    "port": 4080

},

  "https": {

    "host": "192.168.128.1",

    "port": 40443,

    "key": "certs/key.pem",

    "cert": "certs/cert.pem,"

    "cipher": "TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256:TLS_CHACHA20_POLY1305_SHA256:ECDHE-ECDSA-
    AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-
    GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256",

    "minVersion": "TLSv1.2",

    "maxVersion": "TLSv1.3"

},

  "license": {

    "path": "license"

},

  "logging": {

    "daysToKeep": 30,

    "level": "info",

    "path": "logs",

    "allowDownloads": true

},

  "dashboard": {

    "show": true

If setting a path, ensure that the user who is running the License Server has write permissions for the directory.

The license_server.log file is located in /logs.

Start/Stop/Restart the License Server Service

Open a terminal window and use the following commands to start or stop the service:

sudo INSTALL_DIR/node/bin/node INSTALL_DIR/service.js start

sudo INSTALL_DIR/node/bin/node INSTALL_DIR/service.js stop

sudo INSTALL_DIR/node/bin/node INSTALL_DIR/service.js restart

Uninstall the License Server Service

You can use a script to uninstall the License Server, or you can uninstall it manually.

To use the uninstall script:

An uninstall script is located in /scripts/uninstall_linux.sh. The script deactivates licenses on the server, stops the server, and removes the License Server.

To run the script, enter the following at the command prompt:

 sudo <install_location>/scripts/uninstall_linux.sh

To manually uninstall:

Navigate to the License Server installation directory ().
If the license was activated with a code, deactivate the license (skip this step if using a license.dat file):

sudo bin/licensing deactivate
Stop the service:

sudo ./service.js remove
Remove the License Server:

sudo rm -rf install_location