| Config Name | Description |
|---|---|
| appDirectory | The authors value for the nuget package metadata. Defaults to the author field from your app's package.json file when unspecified. |
| owners | The owners value for the nuget package metadata. Defaults to the authors field when unspecified. |
| exe | 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. |
| description | The description value for the nuget package metadata. Defaults to the description field from your app's package.json file when unspecified. |
| version | The version value for the nuget package metadata. Defaults to the version field from your app's package.json file when unspecified. |
| title | 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. |
| name | Windows Application Model ID (appId). Defaults to the name field in your app's package.json file. |
| certificateFile | The path to an Authenticode Code Signing Certificate |
| certificatePassword | The password to decrypt the certificate given in certificateFile |
| signWithParams | Params to pass to signtool. Overrides certificateFile and certificatePassword. |
| iconUrl | A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Atom icon. |
| setupIcon | The ICO file to use as the icon for the generated Setup.exe |
| setupExe | The name to use for the generated Setup.exe file |
| setupMsi | The name to use for the generated Setup.msi file |
| noMsi | Should Squirrel.Windows create an MSI installer? |
| remoteReleases | A URL to your existing updates. If given, these will be downloaded to create delta updates |
| remoteToken | Authentication token for remote updates |
Module to generate Windows installers for Electron apps - 4.0.1 - a TypeScript package on npm - Libraries.io.
NPM module that builds Windows installers for Electron apps using Squirrel. Need for speed most wanted installation code.
Installing
Usage
Require the package:
Then do a build like so.
After running you will have an .nupkg, a RELEASES file, and a .exe installer file in the outputDirectory folder for each multi task target given under the config entry. Ministry of sound annual spring 2004.
- Windows installer: It provides an electron-winstaller that creates a windows installer to install your desktop application. Why Build Desktop Apps with React 'Learn once, write everywhere' 'Build once, compose everywhere' React Native's slogan is 'Learn once, write anywhere'.
- Tools, electron, deploy, windows, desktop One of the ways that an Electron app can be packaged for distribution is by using Electron Forge. For Windows, there are currently two options for the kind of installer that Electron Forge can make, WiX and Squirrel.Windows.
- For building Windows Installers for Electron apps, the most popular choice is the Squirrel-based electron-winstaller npm module. However, electron-winstaller does not allow custom parameters for the produced installer or executing elevated PowerShell; as a result, we chose to use WiX Toolset (specifically, we chose the npm module wixtoolset.
There are several configuration settings supported:
| Config Name | Required | Description |
|---|---|---|
appDirectory | Yes | The folder path of your Electron app |
outputDirectory | No | The folder path to create the .exe installer in. Defaults to the installer folder at the project root. |
loadingGif | No | The local path to a .gif file to display during install. |
authors | Yes | The authors value for the nuget package metadata. Defaults to the author field from your app's package.json file when unspecified. |
owners | No | The owners value for the nuget package metadata. Defaults to the authors field when unspecified. |
exe | No | 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. |
description | No | The description value for the nuget package metadata. Defaults to the description field from your app's package.json file when unspecified. |
version | No | The version value for the nuget package metadata. Defaults to the version field from your app's package.json file when unspecified. |
title | No | 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. |
certificateFile | No | The path to an Authenticode Code Signing Certificate |
certificatePassword | No | The password to decrypt the certificate given in certificateFile |
signWithParams | No | Params to pass to signtool. Overrides certificateFile and certificatePassword. |
iconUrl | No | A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Atom icon. |
setupIcon | No | The ICO file to use as the icon for the generated Setup.exe |
setupExe | No | The name to use for the generated Setup.exe file |
noMsi | No | Should Squirrel.Windows create an MSI installer? |
remoteReleases | No | A URL to your existing updates. If given, these will be downloaded to create delta updates |
remoteToken | No | Authentication token for remote updates |
Sign your installer or else bad things will happen
Electron-winstaller Npm
For development / internal use, creating installers without a signature is okay, but for a production app you need to sign your application. Internet Explorer's SmartScreen filter will block your app from being downloaded, and many anti-virus vendors will consider your app as malware unless you obtain a valid cert.
Any certificate valid for 'Authenticode Code Signing' will work here, but if you get the right kind of code certificate, you can also opt-in to Windows Error Reporting. This MSDN page has the latest links on where to get a WER-compatible certificate. The 'Standard Code Signing' certificate is sufficient for this purpose.
Handling Squirrel Events
Squirrel will spawn your app with command line flags on first run, updates, and uninstalls. it is very important that your app handle these events as early as possible, and quit immediately after handling them. Squirrel will give your app a short amount of time (~15sec) to apply these operations and quit.
The electron-squirrel-startup module will handle the most common events for you, such as managing desktop shortcuts. Just add the following to the top of your main.js and you're good to go:
You should handle these events in your app's main entry point with something such as:
Debugging this package
Electron App Tutorial
You can get debug messages from this package by running with the environment variable DEBUG=electron-windows-installer:main e.g.
Current Tags
- 4.0.0 .. latest (4 years ago)
Electron Installer
50 Versions
Electronic Installer
- 4.0.0 .. 4 years ago
- 3.1.0 .. 4 years ago
- 3.0.0 .. 4 years ago
- 2.11.7 .. 4 years ago
- 2.11.6 .. 4 years ago
- 2.11.5 .. 4 years ago
- 2.11.4 .. 4 years ago
- 2.11.3 .. 4 years ago
- 2.11.1 .. 4 years ago
- 2.11.0 .. 4 years ago
- 2.10.2 .. 4 years ago
- 2.10.1 .. 4 years ago
- 2.10.0 .. 4 years ago
- 2.9.6 .. 5 years ago
- 2.9.5 .. 5 years ago
- 2.9.4 .. 5 years ago
- 2.9.3 .. 5 years ago
- 2.9.2 .. 5 years ago
- 2.9.1 .. 5 years ago
- 2.9.0 .. 5 years ago
- 2.8.3 .. 5 years ago
- 2.8.2 .. 5 years ago
- 2.8.1 .. 5 years ago
- 2.8.0 .. 5 years ago
- 2.7.1 .. 5 years ago
- 2.7.0 .. 5 years ago
- 2.6.2 .. 5 years ago
- 2.6.1 .. 5 years ago
- 2.6.0 .. 5 years ago
- 2.5.0 .. 5 years ago
- 2.4.0-beta.1 .. 5 years ago
- 2.4.0-beta.0 .. 5 years ago
- 2.3.0-beta.4 .. 5 years ago
- 2.3.0-beta.3 .. 5 years ago
- 2.3.0-beta.2 .. 5 years ago
- 2.3.0-beta.1 .. 5 years ago
- 2.3.0-beta.0 .. 5 years ago
- 2.2.1-beta.0 .. 5 years ago
- 2.0.6-beta.8 .. 5 years ago
- 2.0.6-beta.7 .. 5 years ago
- 2.0.6-beta.6 .. 5 years ago
- 2.0.6-beta.5 .. 5 years ago
- 2.0.6-beta.4 .. 5 years ago
- 2.0.6-beta.3 .. 5 years ago
- 2.0.6-beta.2 .. 5 years ago
- 2.0.6-beta.1 .. 5 years ago
- 2.0.6-beta.0 .. 5 years ago
- 2.0.5-beta.7 .. 5 years ago
- 2.0.5-beta.5 .. 5 years ago
- 2.0.5-beta.4 .. 5 years ago
