Xentara v2.1
User Manual
Floating Licenses

Instead of installing individual node licences that are tied to specific computers, Xentara can also be licenced using floating licences. When using floating licences, Xentara checks out licences from a central licence server, rather than requiring a node licence for each computer. Node licences are especially useful in conjuction with Docker containers, where node-locked licences are only available with limitations.

When using floating licences, Xentara will not use a locally installed node licence, but will instead check out a licence from a licence server. Xentara will hold on to that licence as long as Xentara is running. Once Xentara quits, the licence is freed up, and can be used by a different Xentara instance.

Each licence server only has a limited number of licences available. If all floating licences have been checked out, no new instance of Xentara can receive a licence until another instance has quit.

Besides Xentara itself, the floating licence infrastructure consists of two additional applications:

  1. The Xentara Licence Proxy, which runs on the same computer as Xentara, and
  2. The Xentara Licence Server, which runs on one or more separate licence server computers.

The licence proxy is a local service that is used as an intermediate between Xentara an the remote licence server. Xentara never talks to the licence server directly, but only communicates with the licence proxy. This prevents Xentara from having to establish a remote network connection to the licence server on startup, potentially reducing the amount of time needed Xentara to acquire a licence, and speeding up Xentara startup and restarts.

Configuring Xentara to Use Floating Licences

The ability to use floating licences is part of the licencing terms of your Xentara licence. You will not be able to use floating licences unless your licencing terms specifically allow them. If you plan to use floating licences, make sure you purchase a licence that allows floating licences.

If your licencing terms allow it, Xentara will attempt to use a floating licence if no suitable node licence if found for the local computer. If a suitable node licence is found, Xentara will always use that node licence rather than a floating licence. This prevents node-licenced computers from unintentionally consuming licences from a floating licence server.

In order for floating licences to work, the Xentara floating licence proxy must be running on the local Xentara host. See Running the Xentara Licence Proxy on how to run the Xentara floating licence proxy.

You must also configure the address of the licence server by creating a licence server configuration file. You can distribute the floating licences over multiple licence servers to acheive load balancing, or to support some redundancy.

Floating licences only replace node licences. The Xentara licence proper, containing the licencing terms, as well as skill licences, are installed locally as always.

Regular node-locked node licences and floating licences can be used side-by-side. You can install node licences for some of the computers, and use floating licences for the remaining computers. This allow you to have regular node-locked node licences for physical computers, for example, and use floating licences for Docker containers, all within the same licencing ecosystem.

Installing the Licence Server and the Floating Licences

The floating licence server, as well as the floating licences themselves, are installed on one or more licence servers. The installation of the licencing servers and licences is described in detail in the Xentara Licence Server manual.

Running the Xentara Licence Proxy

In order for floating licences to work correctly, the Xentara licence proxy must be running locally on the same computer as Xentara. The Xentara licence proxy application is installed automatically when you install Xentara, but you must manually configure it to run.

Normally, the Xentara licence proxy should run as a service, as described in Running Xentara as a Service. You can run the licence proxy manually, however, if you choose.

Under Linux, the Xentara licence proxy service is called xentara-licence-proxy and is located under /usr/bin. Under Windows, the Xentara licence proxy service is called XentaraLicenceProxy.exe and is located under App in the installation directory.

Normally, the Xentara licence proxy should run under the same Linux user or Windows user account under which Xentara itself is running, so that the configuration will be loaded from the same search path. You can run the licence proxy under a different user, however, if this is necessary or convenient.

Command Line Options

The command xentara-licence-proxy (Linux) or XentaraLicenceProxy.exe (Windows) accepts the following command line options:

Linux:--help
Windows:-Help or /?

Shows help for the Xentara licence proxy service command line options and exits.

Linux:--version
Windows:-Version

Outputs version information for the Xentara licence proxy service and exits.

Linux:--config-dir=<path> or --config-dir <path>
Windows:-ConfigDir <path>

Specifies an additional directory to search for the licence server configuration file before the standard locations are searched. <path> must be the path to the configuration directory. This option is ignored if an explicit path has been specified using --licence-servers.

This option can be specified multiple times.

Linux:--licence-servers=<path> or --licence-servers <path>
Windows:-LicenceServers <path>

Specifies the licence server configuration file to use. <path> must be the path to the licence server configuration file. If you do not specify a licence server configuration file, the file will be searched for in a number of standard locations.