Configuration

aqtinstall can be configured through a configuration file. A default configuration is stored in aqt/settings.ini file.

You can specify custom configuration file through AQT_CONFIG environment variable or “-c” or “–config” command line option.

A file is like as follows:

[DEFAULTS]

[aqt]
concurrency: 4
baseurl: https://download.qt.io
7zcmd: 7z
print_stacktrace_on_error: False
always_keep_archives: False
archive_download_location: .
min_archive_size: 41

[requests]
connection_timeout: 3.5
response_timeout: 30
max_retries_on_connection_error: 5
retry_backoff: 0.1
max_retries_on_checksum_error: 5
max_retries_to_retrieve_hash: 5
hash_algorithm: sha256
INSECURE_NOT_FOR_PRODUCTION_ignore_hash: False

[mirrors]
trusted_mirrors:
    https://download.qt.io
blacklist:
    http://mirrors.ustc.edu.cn
    http://mirrors.tuna.tsinghua.edu.cn
    http://mirrors.geekpie.club
fallbacks:
    https://mirrors.ocf.berkeley.edu/qt
    https://ftp.jaist.ac.jp/pub/qtproject
    http://ftp1.nluug.nl/languages/qt
    https://mirrors.dotsrc.org/qtproject

[kde_patches]
patches:
    0001-toolchain.prf-Use-vswhere-to-obtain-VS-installation-.patch

Settings

The [aqt] section configures basic behavior.

concurrency:

concurrency is a setting how many download concurrently starts. It should be a integer value.

baseurl:

baseurl is a URL of Qt download site. When you have your own Qt download site repository, you can set it here. It is as same as --base option.

7zcmd:

It is a command name of 7-zip. When aqtinstall is installed without recommended library py7zr, it is used to extract archive instead of py7zr library. When --external option specified, a value is override with option’s one.

print_stacktrace_on_error:

print_stacktrace_on_error is either True or False. The True setting causes a stack trace to be printed to stderr any time an error occurs that will end the program. The False setting will hide the stack trace, unless an unhandled exception occurs.

always_keep_archives:

This is either True or False. The True setting turns on the --keep option every time you run aqt, and cannot be overridden by command line options. The False setting will require you to set --keep manually every time you run aqt, unless you don’t want to keep .7z archives.

archive_download_location:

This is the relative or absolute path to the location in which .7z archives will be downloaded, when --keep is turned on. You can override this location with the --archives-dest option.

min_module_size:

This is the minimum decompressed size, in bytes, of the modules that aqt is permitted to list. The authors of aqt have discovered that the Qt repository contains a few mysteriously “empty” modules, including the examples modules for qtlottie and qtquicktimeline. These modules consist of a single archive that contains empty directories, and they are exactly 40 bytes when uncompressed. The authors feel that it is not useful for aqt list-* to list these empty modules. If you want to print these modules with aqt list-*, please feel free to change the min_module_size value to something less than 40.

This setting has no effect on your ability to install these modules. aqt install-* can will still install them without any warnings.

The [requests] section controls the way that aqt makes network requests.

connection_timeout:

connection_timeout is a timeout in second for connection. It is passed to requests library.

response_timeout:

response_timeout is a timeout in second how much time waiting for response. It is passed to requests library.

max_retries:

Deprecated; please do not use this setting. It has been replaced by the

max_retries_on_connection_error:

max_retries_on_connection_error is an integer that controls how many times aqt will try to reconnect to the server in the case of a connection error.

retry_backoff:

retry_backoff is a floating point number that controls how long aqt will sleep between failed connection attempts. Setting this value too low will hammer the server, and may result in no successful connections at all.

max_retries_on_checksum_error:

This setting controls how many times aqt will attempt to download a file, in the case of a checksum error.

hash_algorithm:

This is either sha256, sha1 or md5. sha256 is the only safe value to use here. Default is sha256 if not set. See also trusted_mirrors setting.

INSECURE_NOT_FOR_PRODUCTION_ignore_hash:

This is either True or False. The True setting disables hash checking when downloading files. Although this is not recommended, this may help when hashes are not available. The False setting will enforce hash checking. This is highly recommended to avoid corrupted files.

The [mirrors] section is a configuration for mirror handling.

trusted_mirrors:

trusted_mirrors is a list of URLs that you trust to provide accurate checksums for all downloaded archives. This is a security feature; please do not change this value unless you know what you’re doing!

aqtinstall downloads all checksums from mirrors in this list. These checksums are used to verify that every other file that aqtinstall downloads is, in fact, the correct file, and not a corrupt or malicious copy of the file. You may need to modify this list if the default mirrors are unreachable, or if you do not trust that they have not been compromised.

aqtinstall can safely download archive files from the fallback mirror list, and ensure that they are not malicious files, by checking them against the checksums downloaded from the trusted_mirrors list. aqtinstall uses the SHA-256 algorithm to perform this check.

blacklist:

It is a list of URL where is a problematic mirror site. Some mirror sites ignore a connection from IP addresses out of their preffered one. It will cause connection error or connection timeout. There are some known mirror sites in default. If you are not happy with the default sites, you can override them with custom settings.

fallbacks:

It is a list of URL where is a good for access. When mirror site cause an error, aqt use fallbacks when possible. You can find a list of mirrors at: https://download.qt.io/static/mirrorlist/