probonopd edited this page Nov 6, 2016 · 20 revisions

Welcome to the AppImageKit wiki. Check the right-hand side "Pages" menu to see the wiki pages.

For users

What is an AppImage?

An AppImage is a downloadable file for Linux that contains an application and everything the application needs to run (e.g., libraries, icons, fonts, translations, etc.) that cannot be reasonably expected to be part of each target system.

How do I run an AppImage?

Make it executable and double-click it.

How can I integrate AppImages with the system?

Using the optional appimaged daemon, you can easily integrate AppImages with the system. The daemon puts AppImages into the menus, registers MIME types, icons, all on the fly. You can download it from this repository. But it is entirely optional.

Where can I download AppImages?

See the "repository" of upstream-generated AppImages.

Where do I store my AppImages?

If you don't want to leave them in $HOME/Downloads, then $HOME/.local/bin and $HOME/bin are good choices:

  • On CentOS/RHEL and Fedora: When you login, the script $HOME/.bash_profile is executed and this script adds $HOME/.local/bin:$HOME/bin to your path.
  • On Ubuntu: When you login, the script $HOME/.profile is executed and this script adds PATH="$HOME/bin:$HOME/.local/bin" to your path.

Besides, every other location works, e.g., a USB thumbdrive, a network location, or a CD-ROM, but then the AppImages won't be on your path, which means that you cannot simply type their name into a terminal but have to use the full path.

Where can I request AppImages?

If there is no AppImage of your favorite application available, please request it from the author(s) of the application, e.g., as a feature request in the issue tracker of the application. For example, if you would like to see an AppImage of Mozilla Firefox, then please leave a comment at https://bugzilla.mozilla.org/show_bug.cgi?id=1249971. The more people request an AppImage from the upstream authors, the more likely is that an AppImage will be provided.

Where do I get support?

Please visit http://discourse.appimage.org/. You can log in using your existing Google or GitHub account, no sign-up needed.

For application developers

Why should I bundle my application as an AppImage?

By bundling your application as an AppImage, you can provide an official download for Linux like you would do for Windows and macOS where you as the application author can control the end-to-end user experience with no intermediaries between you as the author and your end user. With just one AppImage you can reach users of most Linux distributions. You can provide new download links as often as you like, e.g., for each continuous build.

Also, doing an AppImage has these advantages:

  • Just one format for all major distributions
  • Works out of the box, no installation of runtimes needed
  • No root needed
  • One app = one file = super simple for users
  • Optional(!) desktop integration with appimaged
  • Binary delta updates, e.g., for continuous builds (only download the binary diff) using AppImageUpdate
  • Can GPG2-sign your AppImages (inside the file)

How do I bundle my application as an AppImage?

There are different ways to generate an AppImage of your application:

  1. Convert existing binary packages, or
  2. Bundle your Travis CI builds as AppImages, or
  3. Run linuxdeployqt on your Qt application, or
  4. Use electron-builder, or
  5. Write your own

See https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages for more information and examples.

How do I get support in bundling my app as an AppImage?

We try to help upstream application authors as good as we can, please open an issue in this project. If you are not an upstream application author, then please contact the upstream application author(s) first before you open an issue here.

For AppImage developers

How can I contribute?

Curious about AppImage development? Want to contribute? We welcome pull requests addressing any of the open issues and/or other bugfixes and/or feature additions. In the case of complex feature additions, it is best to contact us first, before you spend much time. See our list of issues and get in touch with us in #AppImage on irc.freenode.net.