Qt License Server configuration Data collection

Qt License Service configuration

Qt Online Installer configures Qt License Service automatically and you should not touch the configuration files unless you need to investigate potential issues. The only exception is the configuration file where you need to define the On-Prem Qt License Server or Offline Qt License Server instance address.

Configuration file locations

The table below summarizes the locations of the Qt License Service configuration files.

Linux macOS Windows

File	Location
Configuration file	`$HOME/.local/share/Qt/qtlicd/qtlicd.ini`
On-demand startup registration file	`$HOME/.local/share/Qt/qtlicd/installations.ini`
On-demand TCP port configuration file	`$HOME/.local/share/Qt/qtlicd/port.ini`
License cache	`$HOME/.local/share/Qt/qtlicd/cache`
Qt Account configuration file	`$HOME/.local/share/Qt/qtaccount.ini`

File	Location
Configuration file	`$HOME/Library/Application Support/Qt/qtlicd/qtlicd.ini`
On-demand startup registration file	`$HOME/Library/Application Support/Qt/qtlicd/installations.ini`
On-demand TCP port configuration file	`$HOME/Library/Application Support/Qt/qtlicd/port.ini`
License cache	`$HOME/Library/Application Support/Qt/qtlicd/cache`
Qt Account configuration file	`$HOME/Library/Application Support/Qt/qtaccount.ini`

File	Location
Configuration file	`C:\Users\<user>\AppData\Roaming\Qt\qtlicd\qtlicd.ini`
On-demand startup registration file	`C:\Users\<user>\AppData\Roaming\Qt\qtlicd\installations.ini`
On-demand TCP port configuration file	`C:\Users\<user>\AppData\Roaming\Qt\qtlicd\port.ini`
License cache	`C:\Users\<user>\AppData\Roaming\Qt\qtlicd\cache`
Qt Account configuration file	`C:\Users\<user>\AppData\Roaming\Qt\qtaccount.ini`

Configuration file: qtlicd.ini

In Qt License Service version 3.4.0 or later, the qtlicd.ini file is automatically provisioned with default values (with Cloud Qt License Server). This means that if you're using Cloud Qt License Server, you don't have to configure anything.

The table below summarizes the available configuration options.

Option	Default	Description
`server_addr`	Empty	Address and port of Qt License Server. If you're using On-Prem Qt License Server or Offline Qt License Server, set the address accordingly. Address and port must be in format `<server IP address>:<port>` or `<server url>:<port>`.
`ca_bundle_path`	`auto`	Path to a CA bundle file containing root and intermediate certificates. Set an absolute path or `auto` to attempt auto-detection of the CA bundle path. If a valid CA bundle cannot be found, `/etc/ssl/certs` is used as a fallback. Change only if Qt License Service cannot find the CA bundle path from the default location. Note: This setting has effect only on Linux.
`proxy_url`	`auto`	By default, Qt License Service uses automatic proxy settings. On all platforms, Qt License Service tries to read proxy settings from proxy environment variables: `http_proxy`, `https_proxy`, `all_proxy`, and `no_proxy`. When environment variables are not set, Qt License Service doesn't use proxy. Also, on Windows and macOS, Qt License Service attempts to use the system proxy configuration which takes priority over the environment variables. To not use proxy, set the value as `none`. To use a manual proxy URL for transfers, set the value as an URL in format `<scheme>://<hostname\|IP>:<port>`. To modify the value from the CLI: qtlicensetool(.exe) --set-proxy-url <URL\|auto\|none> Note: If the proxy requires authenticating, you can add the credentials to environment variables: `QTLICD_PROXY_USERNAME` and `QTLICD_PROXY_PASSWORD`.
`tcp_listening_addr`	`loopback`	IP address where Qt License Service listens for requests. To accept connections on all available network interfaces, including public ones, set the value to `any`. To accept connections only from the same host, set the value to `loopback`. To accept connections only from a specific IP, set the value to an IP address. Note: If you set the value to `any`, the firewall might block incoming connections and you need to manually allow the traffic.
`tcp_listening_port`	`0`	TCP/IP port where Qt License Service is listening for requests. Set the value to `0` to automatically find and assign to a free port based on an operating system specific range. Set a positive value to manually set the port.
`queue_min_retry_interval`	`1000`	Qt License Server can be temporarily overloaded. This is the minimum time in milliseconds after which queued requests are performed again.
`queue_max_retry_time`	`10000`	Maximum retry interval time after each reservation attempt in milliseconds. After each reservation attempt, `queue_interval_increment` increments the time.
`queue_interval_increment`	`1000`	Time added to the retry interval after each reservation attempt in milliseconds.
`on_demand_shutdown_timeout`	`60`	Maximum time in seconds between requests after which Qt License Service in on-demand mode automatically shuts down.
`hw_id`	Empty	Hardware ID of the host machine. Qt License Service sets this automatically on the first run. To reset it, remove the value and restart Qt License Service. Warning: Qt License Service sets this automatically. Do not edit the value.

On-demand startup registration file: installations.ini

The installations.ini file is maintained automatically. The file should look like this:

[_home_user_some_path_qtlicd]
path=$HOME/<some_path_here>/qtlicd(.exe)
source=qt_installer
timestamp=2024-02-14 08:21:09
version=3.2.1

If the Qt License Service executable is not listed in this file, register it manually by:

Linux macOS Windows

<QtSDK>/Tools/LicenseService/qtlicd --register

<QtSDK>/Tools/LicenseService/qtlicd --register

<QtSDK>\Tools\LicenseService\qtlicd.exe --register

On-demand TCP port configuration file: port.ini

You do not need to touch the port.ini file. It is generated and maintained automatically.

If the automatic on-demand TCP port configuration file cleanup fails, delete the file.

License cache

Qt License Service caches your license reservations in a cache folder. This allows you to continue your work even if there is a network outage.

Warning: Do not alter the contents of this folder.

To manually remove your current reservations:

Linux macOS Windows

<QtSDK>/Tools/LicenseService/qtlicensetool --clear-reservations

<QtSDK>/Tools/LicenseService/qtlicensetool --clear-reservations

<QtSDK>\Tools\LicenseService\qtlicensetool.exe --clear-reservations

This clears your local license cache and attempts to release those on Qt License Server as well.

Qt Account configuration file: qtaccount.ini

The Qt Account login's JSON Web Token (JWT) is stored in the qtaccount.ini file. The JWT is used for authenticating the license reservation requests. If the JWT expires, refresh it by logging into your Qt Account:

Using Qt Online Installer or Qt Maintenance Tool.
From the command line:

Linux macOS Windows

<QtSDK>/Tools/LicenseService/qtlicensetool --login

<QtSDK>/Tools/LicenseService/qtlicensetool --login

<QtSDK>\Tools\LicenseService\qtlicensetool.exe --login

Qt License Server configuration Data collection

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.