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.

Base Linux Configuration

Electron-Builder / app-builder-lib / LinuxConfiguration

Extends

• CommonLinuxOptions.PlatformSpecificBuildOptions

Properties

icon?

readonly optional 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.

Overrides

PlatformSpecificBuildOptions.icon

---

maintainer?

readonly optional maintainer: null | string

The maintainer. Defaults to author.

---

target?

readonly optional target: TargetConfigType

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.

Default

AppImage

Overrides

PlatformSpecificBuildOptions.target

---

vendor?

readonly optional vendor: null | string

The vendor. Defaults to author.

Debian Package Options

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

Electron-Builder / app-builder-lib / DebOptions

Extends

• LinuxTargetSpecificOptions

Properties

depends?

readonly optional depends: null | string[]

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.

Overrides

LinuxTargetSpecificOptions.depends

---

packageCategory?

readonly optional packageCategory: null | string

The package category.

Overrides

LinuxTargetSpecificOptions.packageCategory

---

priority?

readonly optional priority: null | string

The Priority attribute.

---

recommends?

readonly optional recommends: null | string[]

The recommended package dependencies..

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.

Electron-Builder / app-builder-lib / LinuxTargetSpecificOptions

Extends

• CommonLinuxOptions.TargetSpecificOptions

Extended by

• DebOptions

Properties

afterInstall?

readonly optional afterInstall: null | string

---

afterRemove?

readonly optional afterRemove: null | string

---

compression?

readonly optional compression: null | "gz" | "bzip2" | "xz" | "lzo"

The compression type.

Default

xz

---

depends?

readonly optional depends: null | string[]

Package dependencies.

---

fpm?

readonly optional fpm: null | string[]

Advanced only The fpm options.

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

---

icon?

readonly optional icon: string

---

maintainer?

readonly optional maintainer: null | string

---

packageCategory?

readonly optional packageCategory: null | string

The package category.

---

packageName?

readonly optional packageName: null | string

The name of the package.

---

vendor?

readonly optional vendor: null | string