electron-winstaller

property appDirectory

appDirectory: string;

• The folder path of your Electron app

property authors

authors?: string;

• The authors value for the nuget package metadata.

  Defaults to the author field from your app's package.json file when unspecified.

property certificateFile

certificateFile?: string;

• The path to an Authenticode Code Signing Certificate.

  This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the "windowsSign" parameter.

property certificatePassword

certificatePassword?: string;

• The password to decrypt the certificate given in certificateFile

  This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the "windowsSign" parameter.

property copyright

copyright?: string;

• The copyright value for the nuget package metadata.

  Defaults to a generated copyright with authors or owners.

property description

description?: string;

• The description value for the nuget package metadata.

  Defaults to the description field from your app's package.json file when unspecified.

property exe

exe?: string;

• The name of your app's main .exe file.

  This uses the name field in your app's package.json file with an added .exe extension when unspecified.

property fixUpPaths

fixUpPaths?: boolean;

property frameworkVersion

frameworkVersion?: string;

property iconUrl

iconUrl?: string;

• A publicly accessible, fully qualified HTTP(S) URL to an ICO file, used as the application icon displayed in Control Panel ➡ Programs and Features. The icon is retrieved at install time. Example: http://example.com/favicon.ico

  Does not accept file: URLs.

  Defaults to the Electron icon.

property loadingGif

loadingGif?: string;

• The local path to a .gif file to display during install.

property name

name?: string;

• Windows Application Model ID (appId).

  Defaults to the name field in your app's package.json file.

property noDelta

noDelta?: boolean;

• Should Squirrel.Windows delta packages? (disable only if necessary, they are a Good Thing)

property noMsi

noMsi?: boolean;

• Should Squirrel.Windows create an MSI installer?

property nuspecTemplate

nuspecTemplate?: string;

• The path to the .nuspectemplate file used by Squirrel.exe.

  Defaults to the bundled template.nuspectemplate.

property outputDirectory

outputDirectory?: string;

• The folder path to create the .exe installer in.

  Defaults to the installer folder at the project root.

property owners

owners?: string;

• The owners value for the nuget package metadata.

  Defaults to the authors field when unspecified.

property remoteReleases

remoteReleases?: string;

• A URL to your existing updates. If given, these will be downloaded to create delta updates

property remoteToken

remoteToken?: string;

• Authentication token for remote updates

property setupExe

setupExe?: string;

• The name to use for the generated Setup.exe file

property setupIcon

setupIcon?: string;

• The ICO file to use as the icon for the generated Setup.exe

property setupMsi

setupMsi?: string;

• The name to use for the generated Setup.msi file

property signWithParams

signWithParams?: string;

• Params to pass to signtool.

  Overrides certificateFile and certificatePassword.

  This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the "windowsSign" parameter.

property skipUpdateIcon

skipUpdateIcon?: boolean;

property title

title?: string;

• The title value for the nuget package metadata.

  Defaults to the productName field and then the name field from your app's package.json file when unspecified.

property usePackageJson

usePackageJson?: boolean;

property version

version?: string;

• The version value for the nuget package metadata.

  Defaults to the version field from your app's package.json file when unspecified.

property windowsSign

windowsSign?: SignToolOptions;

• Requires Node.js 18 or newer.

  Sign your app with @electron/windows-sign, allowing for full customization of the code-signing process - and supports more complicated scenarios like cloud-hosted EV certificates, custom sign pipelines, and per-file overrides. It also supports all existing "simple" codesigning scenarios, including just passing a certificate file and password.

  Please see https://github.com/@electron/windows-sign for all possible configuration options.

property appDirectory

appDirectory: string;

• The folder path of your Electron app

property authors

authors?: string;

• The authors value for the nuget package metadata.

  Defaults to the author field from your app's package.json file when unspecified.

property certificateFile

certificateFile?: string;

• The path to an Authenticode Code Signing Certificate.

  This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the "windowsSign" parameter.

property certificatePassword

certificatePassword?: string;

• The password to decrypt the certificate given in certificateFile

  This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the "windowsSign" parameter.

property copyright

copyright?: string;

• The copyright value for the nuget package metadata.

  Defaults to a generated copyright with authors or owners.

property description

description?: string;

• The description value for the nuget package metadata.

  Defaults to the description field from your app's package.json file when unspecified.

property exe

exe?: string;

• The name of your app's main .exe file.

  This uses the name field in your app's package.json file with an added .exe extension when unspecified.

property fixUpPaths

fixUpPaths?: boolean;

property frameworkVersion

frameworkVersion?: string;

property iconUrl

iconUrl?: string;

• A publicly accessible, fully qualified HTTP(S) URL to an ICO file, used as the application icon displayed in Control Panel ➡ Programs and Features. The icon is retrieved at install time. Example: http://example.com/favicon.ico

  Does not accept file: URLs.

  Defaults to the Electron icon.

property loadingGif

loadingGif?: string;

• The local path to a .gif file to display during install.

property name

name?: string;

• Windows Application Model ID (appId).

  Defaults to the name field in your app's package.json file.

property noDelta

noDelta?: boolean;

• Should Squirrel.Windows delta packages? (disable only if necessary, they are a Good Thing)

property noMsi

noMsi?: boolean;

• Should Squirrel.Windows create an MSI installer?

property nuspecTemplate

nuspecTemplate?: string;

• The path to the .nuspectemplate file used by Squirrel.exe.

  Defaults to the bundled template.nuspectemplate.

property outputDirectory

outputDirectory?: string;

• The folder path to create the .exe installer in.

  Defaults to the installer folder at the project root.

property owners

owners?: string;

• The owners value for the nuget package metadata.

  Defaults to the authors field when unspecified.

property remoteReleases

remoteReleases?: string;

• A URL to your existing updates. If given, these will be downloaded to create delta updates

property remoteToken

remoteToken?: string;

• Authentication token for remote updates

property setupExe

setupExe?: string;

• The name to use for the generated Setup.exe file

property setupIcon

setupIcon?: string;

• The ICO file to use as the icon for the generated Setup.exe

property setupMsi

setupMsi?: string;

• The name to use for the generated Setup.msi file

property signWithParams

signWithParams?: string;

• Params to pass to signtool.

  Overrides certificateFile and certificatePassword.

  This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the "windowsSign" parameter.

property skipUpdateIcon

skipUpdateIcon?: boolean;

property title

title?: string;

• The title value for the nuget package metadata.

  Defaults to the productName field and then the name field from your app's package.json file when unspecified.

property usePackageJson

usePackageJson?: boolean;

property version

version?: string;

• The version value for the nuget package metadata.

  Defaults to the version field from your app's package.json file when unspecified.

property windowsSign

windowsSign?: SignToolOptions;

• Requires Node.js 18 or newer.

  Sign your app with @electron/windows-sign, allowing for full customization of the code-signing process - and supports more complicated scenarios like cloud-hosted EV certificates, custom sign pipelines, and per-file overrides. It also supports all existing "simple" codesigning scenarios, including just passing a certificate file and password.

  Please see https://github.com/@electron/windows-sign for all possible configuration options.