win key contains set of options instructing electron-builder on how it should build Windows targets. These options are applicable for any Windows target.
Common Questions
How to delegate code signing?
Use thesign option. Please also see why sign.js is called 8 times.
customSign.js in the project root directory:
How to use a custom verify function to enable NSIS signature verification alternatives?
Use theverifyUpdateCodeSignature interface:
How to create Parallels Windows 10 Virtual Machine?
You don’t need to have Windows 10 license. Free is provided (expire after 90 days, but it is not a problem because no additional setup is required).- Open Parallels Desktop.
- File → New.
- Select “Modern.IE” in the “Free Systems”.
- Continue, Continue, Accept software license agreement.
- Select “Microsoft Edge on Windows 10”.
- The next steps are general, see Installing Windows on your Mac using Parallels Desktop from “Step 6: Specify a name and location”.
How to create VirtualBox Windows 10 Virtual Machine?
If you are not on macOS or don’t want to buy Parallels Desktop, you can use free VirtualBox.- Open Download virtual machines.
- Select “MSEdge on Win10 (x64) Stable”.
- Select “VirtualBox” platform.
- Download. See installation instructions.
Passw0rd!.
VirtualBox is not supported by electron-builder for now, so, you need to setup build environment on Windows if you want to use VirtualBox to build AppX (and other Windows-only tasks).
Configuration
The target package type: list of
nsis, nsis-web (Web installer), portable (portable app without installation), appx, msi, msi-wrapped, squirrel, 7z, zip, tar.xz, tar.lz, tar.gz, tar.bz2, dir.AppX package can be built only on Windows 10.To use Squirrel.Windows please install electron-builder-squirrel-windows dependency.The path to application icon.
The trademarks and registered trademarks.
Options for usage with signtool.exe. Cannot be used in conjunction with
azureSignOptions, signing will default to Azure Trusted Signing.Options for usage of Azure Trusted Signing service. Cannot be used in conjunction with
signtoolOptions, signing will default to Azure Trusted Signing.Whether to verify the signature of an available update before installation. The publisher name will be used for the signature verification.
requestedExecutionLevel
'asInvoker' | 'highestAvailable' | 'requireAdministrator'
default:"asInvoker"
The security level at which the application requests to be executed. Cannot be specified per target, allowed only in the
win.Whether to sign and add metadata to executable. Metadata includes information about the app name/description/version, publisher, copyright, etc. This property also is responsible for adding the app icon and setting execution level. (Advanced option leveraging
rcedit)Explicit file name/extensions (
str.endsWith) to also sign. Advanced option. Supports negative patterns, e.g. example that excludes .appx files: ["somefilename", ".dll", "!.appx"].Inherited Properties
The following properties are inherited from Common Configuration:artifactNamepublishfilesextraResourcesextraFilesasarUnpackfileAssociationsprotocols