Electron Forge
  • Getting Started
  • Importing an Existing Project
  • CLI
  • Core Concepts
    • Why Electron Forge?
    • Build Lifecycle
  • Configuration
    • Configuration Overview
    • TypeScript Setup
    • Plugins
      • Webpack Plugin
      • Vite Plugin
      • Electronegativity Plugin
      • Auto Unpack Native Modules Plugin
      • Local Electron Plugin
      • Fuses Plugin
    • Makers
      • AppX
      • deb
      • DMG
      • Flatpak
      • pkg
      • RPM
      • Snapcraft
      • Squirrel.Windows
      • WiX MSI
      • ZIP
    • Publishers
      • Bitbucket
      • Electron Release Server
      • GitHub
      • Google Cloud Storage
      • Nucleus
      • S3
      • Snapcraft
    • Hooks
  • Built-in Templates
    • Webpack
    • Webpack + Typescript
    • Vite
    • Vite + TypeScript
  • Guides
    • Code Signing
      • Signing a Windows app
      • Signing a macOS app
    • Custom App Icons
    • Framework Integration
      • React
      • React with TypeScript
      • Vue 3
    • Developing with WSL
  • Advanced
    • Auto Update
    • Debugging
    • Extending Electron Forge
      • Writing Plugins
      • Writing Templates
      • Writing Makers
      • Writing Publishers
    • API Docs
Powered by GitBook
On this page
Edit on GitHub
  1. Configuration
  2. Makers

WiX MSI

Create an MSI file for your Electron app on Windows using Electron Forge.

PreviousSquirrel.WindowsNextZIP

Last updated 1 year ago

Was this helpful?

CtrlK
  • Requirements
  • Installation
  • Usage
  • Debugging

Was this helpful?

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

We generally recommend using the Squirrel.Windows 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.

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.