AppImage

Configuration options for building AppImage packages with electron-builder

The top-level appImage key contains set of options instructing electron-builder on how it should build AppImage.

Desktop Integration

Since electron-builder 21 desktop integration is not a part of produced AppImage file. AppImageLauncher is the recommended way to integrate AppImages.

Configuration

license · string

The path to EULA license file. Defaults to license.txt or eula.txt (or uppercase variants). Only plain text is supported.

synopsis · string

The short description.

description · string

As description from application package.json, but allows you to specify different for Linux.

category · string

The application category.

mimeTypes · string[]

The mime types in addition to specified in the file associations. Use it if you don’t want to register a new mime type, but reuse existing.

desktop · LinuxDesktopFile

The Desktop file

Show properties

desktop.entry · Record<string, string>

[Desktop Entry] metadata entries (name to value). Overwrites default values calculated by electron-builder.

Example Spec: freedesktop.org Desktop Entry Specification

desktop.desktopActions · Record<string, any>

[Desktop Actions <ActionName>] metadata entries (name to value).

desktopActions: {
  NewWindow: {
    Name: 'New Window',
    Exec: 'app --new-window',
  }
}

executableArgs · string[]

The executable parameters. Pass to executableName