Skip to main content

Interface: DebOptions

Desktop-entry and runtime fields shared by all Linux targets and all snap core strategies.

Fields set under linux.* in your build config (i.e. on LinuxConfiguration) are automatically cascaded into each snap core's options by LinuxTargetHelper.getSnapCore(). You do not need to duplicate them under snapcraft.core24.*, snapcraft.core22.*, etc. Per-core values always take precedence when both are set.

Extends​

Properties​

afterInstall?​

readonly optional afterInstall?: string | null

File path to script to be passed to FPM for --after-install arg.

Inherited from​

LinuxTargetSpecificOptions.afterInstall

afterRemove?​

readonly optional afterRemove?: string | null

File path to script to be passed to FPM for --after-remove arg.

Inherited from​

LinuxTargetSpecificOptions.afterRemove

appArmorProfile?​

readonly optional appArmorProfile?: string | null

File path to custom AppArmor profile (Ubuntu 24+)

Inherited from​

LinuxTargetSpecificOptions.appArmorProfile

artifactName?​

readonly optional artifactName?: string | null

The artifact file name template.

Inherited from​

LinuxTargetSpecificOptions.artifactName

category?​

readonly optional category?: string | null

The application category.

Inherited from​

LinuxTargetSpecificOptions.category

compression?​

readonly optional compression?: "gz" | "bzip2" | "xz" | "zst" | null

Default​

xz

Overrides​

LinuxTargetSpecificOptions.compression

depends?​

readonly optional depends?: string[] | null

Package dependencies. 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.

Use the "default" keyword to extend the default list instead of replacing it: ["default", "my-extra-lib"] appends my-extra-lib to the defaults. The resulting list is deduplicated.

Default​

["libgtk-3-0", "libnotify4", "libnss3", "libxss1", "libxtst6", "xdg-utils", "libatspi2.0-0", "libuuid1", "libsecret-1-0"]

Overrides​

LinuxTargetSpecificOptions.depends

description?​

readonly optional description?: string | null

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

Inherited from​

LinuxTargetSpecificOptions.description

desktop?​

readonly optional desktop?: LinuxDesktopFile | null

The Desktop file

Inherited from​

LinuxTargetSpecificOptions.desktop

executableArgs?​

readonly optional executableArgs?: string[] | null

The executable parameters. Pass to executableName

Inherited from​

LinuxTargetSpecificOptions.executableArgs

fpm?​

readonly optional fpm?: string[] | null

Advanced only The fpm options.

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

Inherited from​

LinuxTargetSpecificOptions.fpm

icon?​

readonly optional icon?: string

Inherited from​

LinuxTargetSpecificOptions.icon

maintainer?​

readonly optional maintainer?: string | null

Inherited from​

LinuxTargetSpecificOptions.maintainer

mimeTypes?​

readonly optional mimeTypes?: string[] | null

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​

LinuxTargetSpecificOptions.mimeTypes

packageCategory?​

readonly optional packageCategory?: string | null

The package category.

Overrides​

LinuxTargetSpecificOptions.packageCategory

packageName?​

readonly optional packageName?: string | null

The name of the package.

Inherited from​

LinuxTargetSpecificOptions.packageName

priority?​

readonly optional priority?: string | null

The Priority attribute.

publish?​

optional publish?: Publish

Inherited from​

LinuxTargetSpecificOptions.publish

recommends?​

readonly optional recommends?: string[] | null

The recommended package dependencies.

Default​

["libappindicator3-1"]

synopsis?​

readonly optional synopsis?: string | null

The short description.

Inherited from​

LinuxTargetSpecificOptions.synopsis

vendor?​

readonly optional vendor?: string | null

Inherited from​

LinuxTargetSpecificOptions.vendor