Skip to main content

Interface: NsisOptions

Extends​

Extended by​

Properties​

allowElevation?​

readonly optional allowElevation?: boolean

assisted installer only. Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.

Default​

true

allowToChangeInstallationDirectory?​

readonly optional allowToChangeInstallationDirectory?: boolean

assisted installer only. Whether to allow user to change installation directory.

Default​

false

artifactName?​

readonly optional artifactName?: string | null

The artifact file name template. Defaults to ${productName} Setup ${version}.${ext}.

Overrides​

TargetSpecificOptions.artifactName

buildUniversalInstaller?​

readonly optional buildUniversalInstaller?: boolean

Disable building an universal installer of the archs specified in the target configuration Not supported for nsis-web

Default​

true

createDesktopShortcut?​

readonly optional createDesktopShortcut?: boolean | "always"

Whether to create desktop shortcut. Set to always if to recreate also on reinstall (even if removed by user).

Default​

true

Inherited from​

CommonWindowsInstallerConfiguration.createDesktopShortcut

createStartMenuShortcut?​

readonly optional createStartMenuShortcut?: boolean

Whether to create start menu shortcut.

Default​

true

Inherited from​

CommonWindowsInstallerConfiguration.createStartMenuShortcut

customNsisBinary?​

readonly optional customNsisBinary?: CustomNsisBinary | null

Allows you to provide your own makensis, such as one with support for debug logging via LogSet and LogText. (Logging also requires option debugLogging = true)

Inherited from​

CommonNsisOptions.customNsisBinary

customNsisResources?​

readonly optional customNsisResources?: CustomNsisResources | null

Allows you to provide your own nsis-resources

Inherited from​

CommonNsisOptions.customNsisResources

deleteAppDataOnUninstall?​

readonly optional deleteAppDataOnUninstall?: boolean

one-click installer only. Whether to delete app data on uninstall.

Default​

false

differentialPackage?​

readonly optional differentialPackage?: boolean

Marks the package as built with differential download support for the update server.

displayLanguageSelector?​

readonly optional displayLanguageSelector?: boolean

Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).

Default​

false

guid?​

readonly optional guid?: string | null

The GUID for the installer. Used to identify the application for upgrade and uninstall operations. If not specified, a deterministic GUID is generated from the app ID (appId) — but this means changing your appId will break silent upgrades of existing installs.

See​

GUID vs Application Name

Inherited from​

CommonNsisOptions.guid

include?​

readonly optional include?: string | null

The path to NSIS include script to customize installer. Defaults to build/installer.nsh. See Custom NSIS script.

installerHeader?​

readonly optional installerHeader?: string | null

assisted installer only. MUI_HEADERIMAGE, relative to the build resources or to the project directory.

Default​

build/installerHeader.bmp

installerHeaderIcon?​

readonly optional installerHeaderIcon?: string | null

one-click installer only. The path to header icon (above the progress bar), relative to the build resources or to the project directory. Defaults to build/installerHeaderIcon.ico or application icon.

installerIcon?​

readonly optional installerIcon?: string | null

The path to installer icon, relative to the build resources or to the project directory. Defaults to build/installerIcon.ico or application icon.

installerLanguages?​

readonly optional installerLanguages?: string | string[] | null

The installer languages (e.g. en_US, de_DE). Change only if you understand what do you do and for what.

installerSidebar?​

readonly optional installerSidebar?: string | null

assisted installer only. MUI_WELCOMEFINISHPAGE_BITMAP, relative to the build resources or to the project directory. Defaults to build/installerSidebar.bmp or ${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp. Image size 164 × 314 pixels.

language?​

readonly optional language?: string | null

LCID Dec, defaults to 1033(English - United States).

license?​

readonly optional license?: string | null

The path to EULA license file. Defaults to license.txt or eula.txt (or uppercase variants). In addition to txt, rtf and html supported (don't forget to use target="_blank" for links).

Multiple license files in different languages are supported — use lang postfix (e.g. _de, _ru). For example, create files license_de.txt and license_en.txt in the build resources. If OS language is german, license_de.txt will be displayed. See map of language code to name.

Appropriate license file will be selected by user OS language.

readonly optional menuCategory?: string | boolean

Whether to create submenu for start menu shortcut and program files directory. If true, company name will be used. Or string value.

Default​

false

Inherited from​

CommonWindowsInstallerConfiguration.menuCategory

multiLanguageInstaller?​

readonly optional multiLanguageInstaller?: boolean

Whether to create multi-language installer. Defaults to unicode option value.

oneClick?​

readonly optional oneClick?: boolean

Whether to create one-click installer or assisted.

Default​

true

Overrides​

CommonWindowsInstallerConfiguration.oneClick

packElevateHelper?​

readonly optional packElevateHelper?: boolean

Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if perMachine is set to true.

Default​

true

perMachine?​

readonly optional perMachine?: boolean

Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).

If oneClick is true (default): Whether to install per all users (per-machine).

If oneClick is false and perMachine is true: no install mode installer page, always install per-machine.

If oneClick is false and perMachine is false (default): install mode installer page.

Default​

false

Overrides​

CommonWindowsInstallerConfiguration.perMachine

preCompressedFileExtensions?​

readonly optional preCompressedFileExtensions?: string | string[] | null

The file extension of files that will be not compressed. Applicable only for extraResources and extraFiles files.

Default​

[".avi", ".mov", ".m4v", ".mp4", ".m4p", ".qt", ".mkv", ".webm", ".vmdk"]

publish?​

optional publish?: Publish

Inherited from​

TargetSpecificOptions.publish

removeDefaultUninstallWelcomePage?​

readonly optional removeDefaultUninstallWelcomePage?: boolean

assisted installer only. remove the default uninstall welcome page.

Default​

false

runAfterFinish?​

readonly optional runAfterFinish?: boolean

Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.

Default​

true

Inherited from​

CommonWindowsInstallerConfiguration.runAfterFinish

script?​

readonly optional script?: string | null

The path to NSIS script to customize installer. Defaults to build/installer.nsi. See Custom NSIS script.

selectPerMachineByDefault?​

readonly optional selectPerMachineByDefault?: boolean

Whether to set per-machine or per-user installation as default selection on the install mode installer page.

Default​

false

shortcutName?​

readonly optional shortcutName?: string | null

The name that will be used for all shortcuts. Defaults to the application name.

Inherited from​

CommonWindowsInstallerConfiguration.shortcutName

unicode?​

readonly optional unicode?: boolean

Whether to create Unicode installer.

Default​

true

Inherited from​

CommonNsisOptions.unicode

uninstallDisplayName?​

readonly optional uninstallDisplayName?: string | null

The uninstaller display name in the control panel.

Default​

${productName} ${version}

uninstallerIcon?​

readonly optional uninstallerIcon?: string | null

The path to uninstaller icon, relative to the build resources or to the project directory. Defaults to build/uninstallerIcon.ico or application icon.

uninstallerSidebar?​

readonly optional uninstallerSidebar?: string | null

assisted installer only. MUI_UNWELCOMEFINISHPAGE_BITMAP, relative to the build resources or to the project directory. Defaults to installerSidebar option or build/uninstallerSidebar.bmp or build/installerSidebar.bmp or ${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp

uninstallUrlHelp?​

readonly optional uninstallUrlHelp?: string | null

The URL to the uninstaller help page in the control panel. Defaults to homepage from application package.json.

uninstallUrlInfoAbout?​

readonly optional uninstallUrlInfoAbout?: string | null

The URL to the uninstaller info about page in the control panel. Defaults to homepage from application package.json.

uninstallUrlReadme?​

readonly optional uninstallUrlReadme?: string | null

The URL to the uninstaller readme page in the control panel. Defaults to homepage from application package.json.

uninstallUrlUpdateInfo?​

readonly optional uninstallUrlUpdateInfo?: string | null

The URL to the uninstaller update info page in the control panel. Defaults to homepage from application package.json.

useZip?​

readonly optional useZip?: boolean

Forces zip compression format instead of LZMA. Used internally for differential update packages.

Default​

false

Inherited from​

CommonNsisOptions.useZip

warningsAsErrors?​

readonly optional warningsAsErrors?: boolean

If warningsAsErrors is true (default): NSIS will treat warnings as errors. If warningsAsErrors is false: NSIS will allow warnings.

Default​

true

Inherited from​

CommonNsisOptions.warningsAsErrors