Skip to content

Any Linux Target

The top-level linux key contains set of options instructing electron-builder on how it should build Linux targets. These options applicable for any Linux target.

  • target = AppImage String | TargetConfiguration - Target package type: list of AppImage, flatpak, snap, deb, rpm, freebsd, pacman, p5p, apk, 7z, zip, tar.xz, tar.lz, tar.gz, tar.bz2, dir.

    electron-builder docker image can be used to build Linux targets on any platform.

    Please do not put an AppImage into another archive like a .zip or .tar.gz.

  • maintainer String | “undefined” - The maintainer. Defaults to author.

  • vendor String | “undefined” - The vendor. Defaults to author.

  • icon String - The path to icon set directory or one png file, relative to the build resources or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon. By default will be generated automatically based on the macOS icns file.

  • synopsis String | “undefined” - The short description.

  • description String | “undefined” - As description from application package.json, but allows you to specify different for Linux.

  • category String | “undefined” - The application category.

  • mimeTypes Array<String> | “undefined” - 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 any | “undefined” - The Desktop file entries (name to value).

  • executableArgs Array<String> | “undefined” - The executable parameters. Pass to executableName

And all common platform-specific options.

Debian Package Options

The top-level deb key contains set of options instructing electron-builder on how it should build Debian package.

  • depends Array<String> | “undefined” - Package dependencies. Defaults to ["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]. If need to support Debian, libappindicator1 should be removed, it is deprecated in Debian. If need to support KDE, gconf2 and gconf-service should be removed as it’s no longer used by GNOME](https://packages.debian.org/bullseye/gconf2).
  • recommends Array<String> | “undefined” - The recommended package dependencies…
  • packageCategory String | “undefined” - The package category.
  • priority String | “undefined” - The Priority attribute.

All LinuxTargetSpecificOptions can be also specified in the deb to customize Debian package.

LinuxTargetSpecificOptions APK, FreeBSD, Pacman, P5P and RPM Options

The top-level apk, freebsd, pacman, p5p and rpm keys contains set of options instructing electron-builder on how it should build corresponding Linux target.

  • depends Array<String> | “undefined” - Package dependencies.

  • compression = xz “gz” | “bzip2” | “xz” | “lzo” | “undefined” - The compression type.

  • icon String

  • packageCategory String | “undefined” - The package category.

  • packageName String | “undefined” - The name of the package.

  • vendor String | “undefined”

  • maintainer String | “undefined”

  • afterInstall String | “undefined”

  • afterRemove String | “undefined”

  • fpm Array<String> | “undefined” - Advanced only The fpm options.

    Example: ["--before-install=build/deb-preinstall.sh", "--after-upgrade=build/deb-postinstall.sh"]

Inherited from CommonLinuxOptions:

  • synopsis String | “undefined” - The short description.
  • description String | “undefined” - As description from application package.json, but allows you to specify different for Linux.
  • category String | “undefined” - The application category.
  • mimeTypes Array<String> | “undefined” - 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 any | “undefined” - The Desktop file entries (name to value).
  • executableArgs Array<String> | “undefined” - The executable parameters. Pass to executableName

Inherited from TargetSpecificOptions: