Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.33 KB

snapcraft.md

File metadata and controls

47 lines (35 loc) · 1.33 KB
description
Create a Snap package for your Electron app using Electron Forge.

Snapcraft

The Snapcraft target builds .snap files, which is the packaging format created and sponsored by Canonical, the company behind Ubuntu. It is a sandboxed package format that lets users of various Linux distributions install your application in an isolated environment on their machine.

Requirements

You can only build the Snapcraft target on Linux systems with the snapcraft package installed.

Installation

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

Usage

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

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

module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-snap',
      config: {
        features: {
          audio: true,
          mpris: 'com.example.mpris',
          webgl: true
        },
        summary: 'Pretty Awesome'
      }
    }
  ]
};

{% endcode %}

Configuration options are documented in MakerSnapConfig.

Debugging

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