Configuration

Table of Contents

• Standard Configuration Directories
  • Linux
  • Windows
• Custom Configuration File Locations

The Xentara licence server is configured using a number of configuration files. These configurations files must be placed in specific locations to enable the Xentara licence server to find them.

The Xentara licence server uses the following configuration files:

• The Licence Server Certificate
• The Server Licence
• Xentara Licences
• The Licence Server Config File

Standard Configuration Directories

The Xentara licence server searches for its configuration files in a number of different directories. By default, the directories consist of one user specific directory, as well as one user-independent system directory.

Linux

Under Linux, Xentara follows the recommendations of the XDG Base Directory Specification to locate configuration files. The configuration files are placed in a subdirectory “xentara-licence-server” within the XDG configuration directories (referred to as $XDG_CONFIG_DIRS in the specification).

By default, Xentara searches for configuration files in the following two directories, in order:

• ${HOME}/.config/xentara-licence-server
• /etc/xdg/xentara-licence-server

The XDG Base Directory Specification specifies two environment variables called XDG_CONFIG_HOME and XDG_CONFIG_DIRS that can be used to modify this search path. Please refer to the XDG Base Directory Specification for details.

You can also specify additional search directories using the Xentara licence server command line option --config-dir.

Windows

Under Windows, Xentara looks for configuration files in the local app data directory, and in the program data directory. These directories are stored in the environment variables %LOCALAPPDATA% and %ProgramData%, respectively. Xentara searches the following two directories, in order:

• %LOCALAPPDATA%\Xentara Licence Server\Config
• %ProgramData%\Xentara Licence Server\Config

%LOCALAPPDATA% is usually C:\Users\<UserName>\AppData\Local, and %ProgramData% is usually C:\ProgramData.

You can specify additional search directories using the Xentara licence server command line option -ConfigDir.

Note

In the Windows Explorer, the directory “Users” is usually shown in the local language of the computer. If your system language is German, e.g., the directory will be shown as “Benutzer”. The actual path remains C:\Users, however. Also, the “AppData” directory is hidden in the Windows Explorer by default, and can only be seen if the option to show hidden files is turned on.

Custom Configuration File Locations

The configuration search path can be modified using the command line option --config-dir (Linux) or -ConfigDir (Windows), or the environment variables XDG_CONFIG_HOME and XDG_CONFIG_DIRS (Linux only).

The configuration search path for licence files can be further modified using the command line option --licence-dir (Linux) or -LicenceDir (Windows).

There are also command line options that allow you to specify alternate locations for certain files. The option --config (Linux) or -Config (Windows) can be used to specify an alternate location for the licence server config file, for example. These command line options disable the search path described here, and load the file directly from the specified location.

The location of the server certificate and corresponding private key can also be configured in the licence server config file.