Skip to content

AppImage

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

Electron-Builder / app-builder-lib / AppImageOptions

Extends

Properties

artifactName?

readonly optional artifactName: null | string

The artifact file name template.

Inherited from

TargetSpecificOptions.artifactName


category?

readonly optional category: null | string

The application category.

Inherited from

CommonLinuxOptions.category


description?

readonly optional description: null | string

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

Inherited from

CommonLinuxOptions.description


desktop?

readonly optional desktop: null | LinuxDesktopFile

The Desktop file

Inherited from

CommonLinuxOptions.desktop


executableArgs?

readonly optional executableArgs: null | string[]

The executable parameters. Pass to executableName

Inherited from

CommonLinuxOptions.executableArgs


license?

readonly optional license: null | string

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


mimeTypes?

readonly optional mimeTypes: null | 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.

Inherited from

CommonLinuxOptions.mimeTypes


publish?

optional publish: Publish

Inherited from

TargetSpecificOptions.publish


synopsis?

readonly optional synopsis: null | string

The short description.

Inherited from

CommonLinuxOptions.synopsis