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 one of the following operating systems:
- Windows Server 2022
- Windows 11
Installing the License Server on a Docker container is not supported.
Microsoft Edge WebView2 Runtime is required to use the License Administrator graphical interface utility. WebView2 Runtime should be included with Microsoft software updates, so long as the machine allows regular updates from Microsoft. If WebView Runtime is not on the machine, you will need to install it. See https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section for installation.
Administrator Privileges
You need administrative privileges to perform the steps in this document.
Firewall Configuration
Correct System Time and Date
Install the License Server Service
-
Navigate to the setup-license_serverxx-win.exe file that was downloaded to the computer and run it, where xx is the version number.
-
Follow the prompts to the Select Products dialog box. The following are selected by default and are required on the License Server machine:
- Program Files
- Node.js - Deselect this option only if you already have a supported installation of Node.js
- MongoDB - Deselect this option only if you already have a supported installation of MongoDB.
- In the Ready to Install dialog box, click Install.
- Click Finish.
-
When installation is complete, activate the license by clicking 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.
-
If you installed MongoDB, restart the machine.
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.exe 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 located 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 specifying the path, escape the backslash character. For example, if licenses will be stored in C:\server\license, enter as "C:\\server\\license".
If specifying the path, escape the backslash character. For example, if logs will be located in C:\tmp\logs, enter as "C:\\tmp\\logs".
The server.log file is located in \logs.
There are two other log files: nv5geospatiallicenseserver.out and nv5geospatiallicenseserver.err. These logs are written by the License Server service, and they may contain messages written before the License Server successfully initializes (which means they would not appear in the server.log file). They are located in \logs.
Start/Stop/Restart the License Server Service
To restart, start, or stop a service, go to the Windows Control Panel, under Administrative Tools > Services.
Restart the License Server service:
In the Services tab, right-click the NV5 Geospatial License Server service and select Restart.
To start the License Server service:
In the Services tab, right-click the NV5 Geospatial License Server service and select Start.
To stop the License Server service:
In the Services tab, right-click the NV5 Geospatial License Server service and select Stop.
Uninstall the License Server Service
- Deactivate the license, described in the Licensing Utility section.
- From the Start menu, select Control Panel > Programs and Features.
- Select the NV5 Geospatial License Server program, and click Uninstall.