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

deleteAppDataOnUninstall?​

readonly optional deleteAppDataOnUninstall?: boolean

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

Default​

false

differentialPackage?​

readonly optional differentialPackage?: boolean | "compressed" | "store-asar"

Marks the package as built with differential download support for the update server, and selects how the app package is compressed:

  • false — no differential download support.
  • "store-asar" — differential-aware, with the app's resources/app.asar stored uncompressed (7-Zip Copy) inside the package. The differential updater diffs the compressed package with a content-defined blockmap, and the asar is a single compressed member — so any change to app code re-downloads the entire compressed asar (~100% of the member; its header rewrite alone diverges every block). Storing it keeps unchanged regions byte-identical between releases, making the delta proportional to what actually changed (measured on a ~32 MB asar: a one-line source change cost 0.2% instead of 100%). The stored asar's byte range is also chunked with finer content-defined blocks (4/8/16 KiB instead of the 8/16/32 KiB used for the rest of the installer), so a small change costs proportionally fewer bytes still. Trade-off: the installer and full package grow by roughly what compressing the asar saved. Without an app.asar (e.g. asar is disabled) there is nothing to store, so it behaves like true. Upgrading from an electron-builder without the finer chunking changes the block boundaries once: the first differential update from an installer built before it re-downloads close to the whole asar, and updates between installers built with it are proportional again.
  • anything else (true, "compressed", unset) — differential-aware, whole package compressed.

Default​

true

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 | string[] | null

The path to NSIS include script to customize installer, or an array of such paths to include multiple scripts. Defaults to build/installer.nsh. See Custom NSIS script.

Each path is resolved relative to the build resources directory first and then relative to the project directory. When an array is provided, all scripts are included in the specified order.

installerDebugLogging?​

readonly optional installerDebugLogging?: boolean

Whether to enable NSIS logging in the installer and uninstaller (LogSet on, which writes install.log to the installation directory). In your custom NSIS scripts, write to the log via ${LogText}.

Requires a log-enabled NSIS: makensis and its stubs compiled with NSIS_CONFIG_LOG=yes. The default toolsets.nsis bundle is not log-enabled, so supply one as a custom toolsets.nsis bundle; the build fails otherwise. Replaces the v26 customNsisBinary.debugLogging.

See​

https://www.electron.build/docs/migration/v27-breaking-changes#nsiscustomnsisbinary-toolsetsnsis

Default​

false

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

Use zip instead of 7z (LZMA) for the embedded app package. Only applies to portable targets and to installers built with differentialPackage: false; ignored (with a warning) when differentialPackage is enabled and for nsis-web, which always use 7z.

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