NLS setup

Local, dedicated, and public NLS

bg-dots
bg-dots

Overview

This article describes network licensing (NLS) setup on a Vinteo server.

  • Root NLS — root network license server;
  • NLS Server — network license server;
  • NLS Client — network license client.

Local NLS is a layout where the NLS Client and NLS Server run on the same host as the Vinteo server.

Notice:

Used for a single VCS server and for cascading.

Dedicated NLS is a layout where the NLS Server is installed on a separate host in the customer perimeter, and NLS Clients on Vinteo servers connect to that NLS Server over the network.

Notice:

Used with reservation and when several standalone VCS servers are on site.

Agree the scheme and NLS Server registration method with technical support (support@vinteo.ru) before the work starts.

Setup order:

  1. Local NLS — the NLS Server is already installed with the VCS server → NLS Server registration → Registering NLS Client.
  2. Dedicated NLS — Dedicated NLS Server (install and configuration) → NLS Server registration on the NLS Server host → Registering NLS Client on each VCS server.
  3. Public NLS — Public NLS (do not deploy an NLS Server in the customer perimeter).

GOST library

The libengine-gost-openssl library (or libgost-astra) is required as an NLS Server package dependency. Install it before the NLS Server package. Package page: libengine-gost-openssl.

curl -LO http://ftp.ru.debian.org/debian/pool/main/libe/libengine-gost-openssl/libengine-gost-openssl_3.0.1-2+b1_amd64.deb
apt install -y ./libengine-gost-openssl_3.0.1-2+b1_amd64.deb

Install the same library on hosts that use GOST encryption to talk to the NLS Server.

Dedicated NLS Server

This section applies only to dedicated NLS. For local NLS, continue to NLS Server registration.

After installation and configuration on the NLS Server host, run NLS Server registration, then Registering NLS Client on the VCS servers.

Installation

Obtain the NLS Server distribution from technical support (support@vinteo.ru). The NLS Server is shipped as nls-server-net and nls-server-hasp. Install one variant on the host — the packages conflict. The client on the VCS server must match the same line: nls-client-net or nls-client-hasp.

Attention!
If the NLS Server is deployed on a virtual machine rather than a physical host, the nls-server-hasp package is used (and the nls-client-hasp client). The nls-server-net variant is for a physical host when technical support does not issue a HASP key.

Step 1. Update package indexes and install helper utilities if needed:

apt update && apt upgrade -y
apt install -y wget curl gnupg lsb-release

Step 2. Install PostgreSQL and confirm the cluster accepts connections. Without a running PostgreSQL, NLS Server package setup will not finish:

apt install -y postgresql postgresql-contrib
pg_lsclusters
pg_isready

If the cluster is down and the log reports a missing conf.d directory, create it and start the cluster (replace the version number, for example 17):

mkdir -p /etc/postgresql/17/main/conf.d
chown postgres:postgres /etc/postgresql/17/main/conf.d
systemctl start postgresql@17-main
pg_isready

Step 3. Install the GOST library — see GOST library.

Step 4. Install the agreed NLS Server package (confirm the file name with support):

apt install ./nls-server-net_<version>_amd64.deb

If dependency errors occur:

apt install -f

If package configuration stopped because of PostgreSQL, after starting the cluster run:

dpkg --configure -a

Step 5. Verify that the files are present:

ls -la /usr/bin/network_license_server
ls -la /etc/vcs/nls/
ls -la /lib/systemd/system/nls-server.service

Step 6. Do not start the NLS Server service until NLS Server registration is complete. Until /etc/vcs/nls/nls-last.conf exists, systemctl start nls-server may time out because startup re-enters registration mode. After nls-last.conf appears:

systemctl enable nls-server
systemctl start nls-server
systemctl status nls-server

On each VCS server that will obtain licenses from this NLS Server, stop the local nls-server and disable autostart if it is not needed for other roles:

systemctl stop nls-server && systemctl disable nls-server

NLS Server configuration for remote clients

File /etc/vcs/nls/nls.conf on the dedicated host. After installation, defaults are often LOCAL 1 and BIND_IP 127.0.0.1 — change them for a dedicated NLS Server. Leave paths, registration, and database settings unchanged unless required.

So the NLS Server accepts NLS Client connections from VCS hosts over the network:

LOCAL 0
BIND_IP 0.0.0.0

If the file contains BIND_IP 127.0.0.1, comment out that line or change the value to 0.0.0.0.

After changing nls.conf, restart nls-server in an agreed maintenance window (if the service is already running after registration).

The VCS server must reach the NLS Server licensing port (PORT_TCP_IN; typically 4000). Do not use the panel HTTPS port for client -reg.

NLS Server web interface (optional)

The panel is shipped as the nls-dashboard package (agree the version with support). The package places files under /var/www/html/nls/dashboard, installs Nginx, and adds /etc/nginx/conf.d/nls.conf (HTTPS on port 8443 by default, certificates from /etc/vcs/nls/crt/).

apt install ./nls-dashboard_<version>_amd64.deb
nginx -t
systemctl enable --now nginx
systemctl reload nginx
test -f /var/www/html/nls/dashboard/index.html

The panel directory must contain index.html without an extra nested …/dashboard/dist/… path.

For the panel behind Nginx, set HTTP API and WebSocket in nls.conf (TLS terminates on Nginx):

PORT_HTTP 5000
PORT_WS 7000
USE_HTTPS 0

In /etc/nginx/conf.d/nls.conf, the API upstream is usually 127.0.0.1:5000, and WebSocket is often 127.0.0.1:7001 (location /ws/notifications). The upstream port must match PORT_WS in nls.conf (typical PORT_WS is 7000). If they differ, fix Nginx or PORT_WS, then run nginx -t and systemctl reload nginx.

Replace port 8443 with 443 if needed. Before changing the port, check usage and other sites under /etc/nginx/sites-enabled/ and /etc/nginx/conf.d/.

Changing only Nginx does not require restarting nls-server; changing USE_HTTPS or ports in nls.conf does.

Open the panel at https://<NLS-Server-DNS-or-IP>:8443/ (or without :8443 if listening on 443). The panel user is su. Obtain the password on the same host with network_license_server -su (do not save the output in tickets or screenshots).

In the panel, confirm the VCS server registration request and assign licenses. An HTTP 200 for the HTML page only means the page loaded; verify /api and the WebSocket as well. See Diagnostics.

NLS Server registration

NLS Server registration is shared for local and dedicated NLS. Run the commands on the host where the NLS Server runs:

  • local NLS — on the VCS server;
  • dedicated NLS — on the NLS Server host after installation.

Online registration

Before starting, confirm that the NLS Server host can reach Root NLS at 31.128.48.15 (agree the port with technical support).

Step 1. Start the network license server in registration mode:

network_license_server -nls -reg

Step 2. Notify technical support (support@vinteo.ru) that the registration request has been sent.

Step 3. After confirmation on Root NLS, start the service and enable autostart:

systemctl start nls-server && systemctl enable nls-server

Offline registration

Offline registration is performed in a closed perimeter (the NLS Server does not contact Root NLS) and only by agreement with technical support (support@vinteo.ru) before the work starts.

Attention!
When virtualization is used, offline registration is performed only via HASP.

Step 1. Start the network license server in offline registration mode:

network_license_server -nls --reg

An action menu opens:

  • 1) Create NLS registration file — create a registration request file to send to Root NLS;
  • 2) Registering NLS by file — register the NLS Server using a file received from Root NLS;
  • 3) Loading licenses from file — load the license pool from a file;
  • 4) Exit — leave the menu.

Step 2. Select 1) and specify the path for the request file (by default — nls-registration-request.data in the current user’s home directory), or accept the default with Enter:

After the file is created successfully, the wizard reports completion and returns to the menu:

Send the request file to technical support (support@vinteo.ru) so Root NLS registration can be completed.

Step 3. When support returns the registration file, select 2) and provide the path to that file:

Step 4. If needed, load licenses with 3) Loading licenses from file, then leave the menu (4) Exit).

Step 5. Start the NLS Server service and enable autostart:

systemctl start nls-server && systemctl enable nls-server

After NLS Server registration, register the NLS Client — see Registering NLS Client.

Registering NLS Client

Register the NLS Client with client -reg on the VCS server. The process is the same for local, dedicated, and public NLS — only the wizard parameter values differ.

Attention!
Public NLS (nls.vinteo.com) is intended only for test installations and pilot projects. For day-to-day operation, use local or dedicated NLS.

Before starting the wizard:

  • local NLS — the NLS Server on this host is already registered;
  • dedicated NLS — the local nls-server on the VCS host is stopped (see Installation); the dedicated NLS Server DNS name resolves from the VCS server;
  • public NLS — the local nls-server is stopped and disabled from autostart; the VCS server can reach nls.vinteo.com over TCP 4000.
# dedicated and public NLS — if the local nls-server is still running:
systemctl stop nls-server && systemctl disable nls-server

Step 1. Start the wizard:

client -reg

Step 2. Enter parameters for the chosen scheme. Do not use the NLS Server HTTPS dashboard port.

Parameter Local NLS Dedicated NLS Public NLS
Enter the type of keys to encrypt 2 (Diffie–Hellman) or 1 (GOST) 2 (Diffie–Hellman) or 1 (GOST) 1 (GOST)
Enter Network License Server address 127.0.0.1 IP address or DNS name of the dedicated NLS Server nls.vinteo.com
Enter Network License Server port 4000 4000 4000
Enter a description of your server a clear VCS server name so support can identify the request a clear VCS server name so support can identify the request a clear VCS server name so support can identify the request

The default port is 4000.

Step 3. Start the NLS Client and enable autostart:

systemctl start nls-client && systemctl enable nls-client

In /etc/vcs/nls-client/default.conf, the address and port must match the table (not the panel HTTPS port).

For dedicated NLS: if the NLS Server publishes a web panel, confirm the VCS server registration request in the panel after the request is sent and assign licenses.

For public NLS: after the request is sent, the client remains at “Connected to the server” — expected until confirmation. Tell technical support (support@vinteo.ru) the host name from the wizard. After licenses are assigned, restart the NLS Client:

systemctl restart nls-client

Checks are in Diagnostics.

Public NLS

For public NLS, do not deploy an NLS Server in the customer perimeter: register only the NLS Client. Wizard parameters are in the Public NLS column of the table above; after the request is sent, the client remains at “Connected to the server” until technical support confirms. Checks are in Public NLS diagnostics.

Diagnostics

This section covers local, dedicated, and public NLS. Which checks apply depends on the scheme.

Services and version

systemctl status nls-server
systemctl status nls-client
network_license_server --version
  • Local NLS — check both nls-server and nls-client on the same host.
  • Dedicated NLS — nls-server on the NLS Server host; nls-client on the VCS server (local nls-server on the VCS host is usually stopped).
  • Public NLS — check nls-client on the VCS server; local nls-server must be stopped.

Additionally on a dedicated NLS Server host:

systemctl is-active nginx nls-server

Configuration

cat /etc/vcs/nls/nls.conf
cat /etc/vcs/nls-client/default.conf

In /etc/vcs/nls-client/default.conf, the address and port must match the scheme:

Scheme NLS Server / NLS address Port
Local 127.0.0.1 4000
Dedicated dedicated NLS Server IP or DNS 4000
Public nls.vinteo.com 4000

For a dedicated NLS Server, check LOCAL 0 and an external bind in /etc/vcs/nls/nls.conf (BIND_IP 0.0.0.0 or no BIND_IP 127.0.0.1). Do not put the panel HTTPS port in the NLS Client configuration.

Journals

journalctl -u nls-server -e
journalctl -u nls-client -e

Connection status and available licenses are also shown in the VCS web interface under System → Licenses.

Dedicated NLS Server web panel

If the panel is published:

nginx -t
test -f /var/www/html/nls/dashboard/index.html

Review /var/log/nginx/nls.error.log (strip secrets before sharing).

Typical failure signs:

  • remote VCS cannot connect — LOCAL, BIND_IP, PORT_TCP_IN, DNS, and network rules;
  • 502 on /api — nls-server state and upstream port/protocol match;
  • page loads but data does not update — WebSocket /ws/notifications, Upgrade/Connection headers;
  • HTML returns 200, but that does not confirm license issuance — check /api and the WebSocket.

Public NLS diagnostics

If the connection fails, check reachability of nls.vinteo.com:4000 from the VCS server and the nls-client journals. Until technical support confirms registration, “Connected to the server” on the client is expected.

Installing on an open distribution HTTPS certificate