Configuration File

The configuration file customizes the UI and behavior of an installer. The file is typically called config.xml and located in the config directory.

A minimal configuration file consists of an <Installer> root element with <Name> and <Version> elements as children. All other elements are optional, and can appear in arbitrary order.

The following example shows a typical configuration file:

<?xml version="1.0"?>
    <Name>Some Application</Name>
    <Title>Some Application Setup</Title>
    <Publisher>Your Company</Publisher>
        <Argument>Argument 1</Argument>
        <Argument>Argument 2</Argument>
    <RunProgramDescription>My nice application</RunProgramDescription>
    <StartMenuDir>Some Application Entry Dir</StartMenuDir>


Summary of Configuration File Elements

The following table summarizes the elements in the configuration file.

Note: We recommend that you place all files that you refer to in the configuration file in the config directory. However, you can also use relative paths, which the tools resolve relative to the location of the config.xml file.

You can use predefined variables (embedded in @ characters) as values of the elements. For more information, see Predefined Variables.

Name Name of the product being installed. This is mandatory.
VersionVersion of the product being installed in the following format: [0-9]+((\.|-)[0-9]+)* such as 1-1; 1.2-2; 3.4.7. This is mandatory.
TitleName of the installer as displayed on the title bar.
PublisherPublisher of the software (as shown in the Windows Control Panel).
ProductUrlURL to a page that contains product information on your web site.
IconFilename for a custom installer icon. The actual file is looked up by attaching a '.icns' (OS X), '.ico' (Windows) or '.png' (Unix) suffix. Deprecated, use <InstallerApplicationIcon> or <InstallerWindowIcon> instead.
InstallerApplicationIconFilename for a custom installer icon. The actual file is looked up by attaching a '.icns' (OS X), '.ico' (Windows). No functionality on Unix.
InstallerWindowIconFilename for a custom window icon in PNG format for the Installer application.
LogoFilename for a logo used as QWizard::LogoPixmap.
WatermarkFilename for a watermark used as QWizard::WatermarkPixmap.
BannerFilename for a banner used as QWizard::BannerPixmap (only used by ModernStyle).
BackgroundFilename for an image used as QWizard::BackgroundPixmap (only used by MacStyle).
WizardStyleSet the wizard style to be used ("Modern", "Mac", "Aero" or "Classic").
WizardDefaultWidthSets the default width of the wizard in pixels. Setting a banner image will override this.
WizardDefaultHeightSets the default height of the wizard in pixels. Setting a watermark image will override this.
TitleColorSet the color of the titles and subtitles (takes an HTML color code, such as "#88FF33").
RunProgramCommand executed after the installer is done if the user accepts the action. Provide the full path to the application.
RunProgramArgumentsArguments passed to the program specified in <RunProgram>. You can add several <Argument> child elements that each specify an argument to <RunProgram>.
RunProgramDescriptionText shown next to the check box for running the program after the installation. If <RunProgram> is set but no description provided, the UI will display Run <Name> now. instead.
StartMenuDirName of the default program group for the product in the Windows Start menu.
TargetDirDefault target directory for installation. On Linux, this is usually the user's home directory.
AdminTargetDirDefault target directory for installation with administrator rights. Only available on Linux, where you usually do not want to install in the administrator user's home directory.
RemoteRepositoriesList of remote repositories. This element can contain several <Repository> child elements that each contain the <Url> child element that specifies the URL to access the repository. For more information, see Configuring Repositories.
MaintenanceToolNameFilename of the generated maintenance tool. Defaults to maintenancetool. The platform-specific executable file extension is appended.
MaintenanceToolIniFileFilename for the configuration of the generated maintenance tool. Defaults to MaintenanceToolName.ini.
RemoveTargetDirSet to false if the target directory should not be deleted when uninstalling.
AllowNonAsciiCharactersSet to true if the installation path can contain non-ASCII characters.
RepositorySettingsPageVisibleSet to false to hide the repository settings page inside the settings dialog.
AllowSpaceInPathSet to false if the installation path cannot contain space characters.
DependsOnLocalInstallerBinarySet to true if you want to prohibit installation from an external resource, such as a network drive. This might make sense for e.g. very big installers. The option is only used on Windows.
TargetConfigurationFileFilename for the configuration file on the target. Default is components.xml.
TranslationsList of language codes to be used for translating the user interface. To add several language variants, specify several <Translation> child elements that each specify the name of a language variant. Optional. For more information, see Translating Pages.
UrlQueryStringThis string needs to be in the form "key=value" and will be appended to archive download requests. This can be used to transmit information to the webserver hosting the repository.
ControlScriptFilename for a custom installer control script. See Controller Scripting.
CreateLocalRepositorySet to true if you want to create a local repository inside the installation directory. This option has no effect on online installers. The repository will be automatically added to the list of default repositories.

© 2016 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. The Qt Company, Qt and their 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.