Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.54 KB

wix-msi.md

File metadata and controls

49 lines (35 loc) · 1.54 KB
Raw
description
Create an MSI file for your Electron app on Windows using Electron Forge.

WiX MSI

The WiX MSI target builds .msi files, which are "traditional" Windows installer files.

{% hint style="warning" %} We generally recommend using the squirrel.windows.md target over using this one. These MSI files are a worse user experience for installation but sometimes it is necessary to build MSI files to appease large-scale enterprise companies with internal application distribution policies. {% endhint %}

Requirements

You can only build the WiX MSI target on machines with WiX Toolset v3 installed. We recommend pinning your installation of WiX Toolset to a specific version. You can install WiX Toolset on Windows via Chocolatey.

choco install wixtoolset  --version=3.14.0

Installation

npm install --save-dev @electron-forge/maker-wix

Usage

To use @electron-forge/maker-wix, add it to the makers array in your Forge configuration:

module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-wix',
      config: {
        language: 1033,
        manufacturer: 'My Awesome Company'
      }
    }
  ]
};

Configuration options are documented in MakerWixConfig.

Debugging

For advanced debug logging for this maker, add the DEBUG=electron-wix-msi* environment variable.