InstallBuilder User Guide 24

fullName

string

The full product name, as it will be displayed in the autoupdater

shortName

string

The short version of product name. It can only contain alphanumeric characters. This property does not allow variables.

version

string

Product version number.

vendor

Name of your company

string

Vendor name

logoImage

string

48x48 GIF or PNG logo image that will be placed at the top right corner of the autoupdate wizard. If no image is specified, the default image will be used

leftImage

string

163x314 GIF or PNG image that will be placed at the left side of the autoupdate wizard in the Welcome and Update Finished pages. If no image is specified, the default image will be used

splashImage

string

The GIF or PNG image that will appear when launching the autoupdate wizard.

wmImage

string

48x48 GIF or PNG logo image that will be shown in the window manager task bar on Unix systems. If no image is specified, the default logo image will be used

osxApplicationBundleIcon

string

ICNS file to include in the AutoUpdate Application Bundle

enableRetinaDisplayImages

0

0, 1

Enable Retina Display Images

windowsExecutableIcon

string

ICO file with an specific format to set the icon for the autoupdate executable file on Windows systems.

requireInstallationByRootUser

0

0, 1

Whether or not running the autoupdater will require super user privileges (root on Linux, Administrator user on Windows and OS X). This setting will prevent the autoupdate from running if the user is not root or Administrator on all operating systems except for OS X. In OS X, the regular authentication dialog window will be shown, asking the user for the administrator password so the autoupdate wizard can be run with root privileges

requestedExecutionLevel

requireAdministrator

requireAdministrator, asInvoker, highestAvailable

UAC execution level of the AutoUpdate on Windows

rebootRequired

0

0, 1

Determines whether or not to ask the user to reboot after the AutoUpdate process is completed (Windows-specific option).

singleInstanceCheck

0

0, 1

Check that only one autoupdater instance is running

removeLogFile

0

0, 1

This project property controls automatic deletion of the generated log file after installation. It is set to 0 by default. If set to 1, the installer will remove the log file

removeUninstallationLogFile

0

0, 1

This project property controls automatic deletion of the generated log file after uninstallation. It is set to 0 by default. If set to 1, the installer will remove the uninstallation log file

osxPlatforms

osx-x86_64 osx-arm64

string

Space separated list of platforms that will be supported when generating OSX bundles. Can be osx-intel, osx-x86_64, osx-arm64, osx-ppc and osx-10.2

createOsxBundleZip

0

0, 1

Create a zip archive from OS X bundle to ease shipping of OS X bundles

osxApplicationBundleIdentifier

com.installbuilder.autoupdate

string

Identifier used to uniquely identify this autoupdate package

windowsResourceProductName

${product_fullname}

string

Product Name for resources embedded in Windows executable

windowsResourceProductVersion

${product_version}

string

Product Version for resources embedded in Windows executable

windowsResourceOriginalFilename

setup.exe

string

Original Filename for resources embedded in Windows executable

windowsResourceFileDescription

string

File Description for resources embedded in Windows executable

windowsResourceFileVersion

1.0.0.0

string

File version for resources embedded in Windows executable

windowsResourceCompanyName

$\{project.vendor\}

string

Company Name for resources embedded in Windows executable

windowsResourceInternalName

string

Internal Name for resources embedded in Windows executable

windowsResourceLegalCopyright

Copyright $\{project.vendor\}

string

Legal Copyright for resources embedded in Windows executable

windowsResourceComments

string

Comments for resources embedded in Windows executable

windowsResourceLegalTrademarks

string

Legal Trademarks for resources embedded in Windows executable

disableSplashScreen

0

0, 1

Disable the initial splash screen.

splashScreenDelay

0

positive integer or zero

Extra display time of the splash screen in milliseconds

overrideGtkButtonText

0

0, 1

Translate buttons to the selected language instead of using system-built values for Unix GTK mode

enableGtkDarkThemesSupport

0

0, 1

Try to honor GTK dark themes coloring. This property does not allow variables.

width

500

positive integer or zero

Autoupdate wizard window width

height

350

positive integer or zero

Autoupdate wizard window height

autoUpdateInitializationActionList

Actions executed when the update installer has started

<action>

postUpdateDownloadActionList

Actions executed after downloading the update installer.

<action>