Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SquirrelWindowsOptions

Hierarchy

  • SquirrelWindowsOptions

Index

Properties

Properties

appDirectory

appDirectory: string

The folder path of your Electron app

Optional 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.

Optional 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.

Optional 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.

Optional copyright

copyright?: string

The copyright value for the nuget package metadata.

Defaults to a generated copyright with authors or owners.

Optional 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.

Optional 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.

Optional fixUpPaths

fixUpPaths?: boolean

Optional frameworkVersion

frameworkVersion?: string

Optional 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.

Optional loadingGif

loadingGif?: string

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

Optional name

name?: string

Windows Application Model ID (appId).

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

Optional noDelta

noDelta?: boolean

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

Optional noMsi

noMsi?: boolean

Should Squirrel.Windows create an MSI installer?

Optional nuspecTemplate

nuspecTemplate?: string

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

Defaults to the bundled template.nuspectemplate.

Optional outputDirectory

outputDirectory?: string

The folder path to create the .exe installer in.

Defaults to the installer folder at the project root.

Optional owners

owners?: string

The owners value for the nuget package metadata.

Defaults to the authors field when unspecified.

Optional remoteReleases

remoteReleases?: string

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

Optional remoteToken

remoteToken?: string

Authentication token for remote updates

Optional setupExe

setupExe?: string

The name to use for the generated Setup.exe file

Optional setupIcon

setupIcon?: string

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

Optional setupMsi

setupMsi?: string

The name to use for the generated Setup.msi file

Optional 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.

Optional skipUpdateIcon

skipUpdateIcon?: boolean

Optional 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.

Optional usePackageJson

usePackageJson?: boolean

Optional 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.

Optional 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.