Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 2.87 KB

README.md

File metadata and controls

46 lines (26 loc) · 2.87 KB
Raw

linuxdeploy-plugin-appimage

Creates AppImages from AppDirs. For use with linuxdeploy.

Usage

As this software is concepted as a plugin for linuxdeploy, it is recommended to use it as such.

Usage with linuxdeploy

When calling linuxdeploy, just add --output appimage to enable the plugin. After completing the bundling process and running e.g., input plugins, linuxdeploy will then call the AppImage plugin to create an AppImage from the AppDir.

For more information, see the official AppImage packaging guide.

Standalone usage

Like all linuxdeploy plugins, linuxdeploy-plugin-appimage is a standalone tool and can be used without linuxdeploy.

Please see the --help test for more information.

Updating the AppImage plugin

The official linuxdeploy AppImage ships with a fairly recent version of the plugin. You can at any time still download the AppImage from the release page, and put it into the same directory as linuxdeploy. Then, linuxdeploy will use the AppImage instead of the bundled version.

For more information on how linuxdeploy's plugin system works, please refer to the documentation.

Optional variables

linuxdeploy-plugin-appimage can be configured using environment variables.

  • LDAI_UPDATE_INFORMATION="...": embed update information in the AppImage, and generate corresponding .zsync file
  • LDAI_GUESS_UPDATE_INFORMATION: make appimagetool try to guess some update information (may or may not work, requires specific workflow and setup)
  • LDAI_SIGN=1: set this variable to any value to enable signing of the AppImage
  • LDAI_SIGN_KEY=key_id: GPG Key ID to use for signing. This environment variable is only used if SIGN is set.
  • LDAI_VERBOSE=1: set this variable to any value to enable verbose output
  • LDAI_OUTPUT=filename: change filename of resulting AppImage
  • LDAI_RUNTIME_FILE: path to custom AppImage runtime appimagetool should use
  • LDAI_NO_APPSTREAM=1: skip checking AppStream metadata for issues
  • LDAI_COMP=...: compression algorithm appimagetool/mksquashfs should use (e.g., xz, gzip), see appimagetool's repository for more information
  • LINUXDEPLOY_OUTPUT_APP_NAME: sets APPIMAGETOOL_APP_NAME to configure appimagetool's autogenerated filename prefix
  • LINUXDEPLOY_OUTPUT_VERSION or LDAI_VERSION: version number to pass to appimagetool (will be included in the root desktop file to be picked up by desktop integration tools and, if $LDAI_OUTPUT is not set, will be included in appimagetool's autogenerated output filename)