Skip to content

msix.md

Latest commit

 

History

History
61 lines (43 loc) · 2 KB

msix.md

File metadata and controls

61 lines (43 loc) · 2 KB
description Create a MSIX package that can be shipped as a direct download or to the Microsoft Store for your Electron app, using Electron Forge.

MSIX

{% hint style="info" %}

MSIX support was added in Electron Forge v7.10 and is currently experimental. Breaking changes to the configuration may be introduced between releases.

{% endhint %}

The MSIX target builds .msix packages, which can be directly distributed to end user or to the Microsoft Store.

Requirements

You can only build the MSIX target on Windows 10 or 11 machines with the Windows SDK installed. Check the electron-windows-msix docs for more information on platform requirements.

Installation

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

Usage

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

{% code title="forge.config.js" %}

module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-msix',
      config: {
        manifestVariables: {
          publisher: 'Electron Dev'
        },
        windowsSignOptions: {
          certificateFile: 'C:\\devcert.pfx',
          certificatePassword: '122345'
        }
      }
    }
  ]
};

{% endcode %}

Configuration options are documented in MakerMSIXConfig.

For advanced code-signing use-cases, this maker utilizes @electron/windows-sign via the windowsSignOptions property. see the windows-sign README for more details.

Debugging

For advanced debug logging for this maker, add the DEBUG=electron-windows-msix* environment variable or set the logLevel to debug in the maker config.