Appimage: Difference between revisions

From NixOS Wiki
imported>Harärmat
Write first version explaining what they are, how to run them, and how they are packaged
 
Jopejoe1 (talk | contribs)
appimage also needs to be enabled for binfmt to work
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[https://appimage.org/ AppImage] is a monolithic packaging format for linux applications. It contains all dependencies in one file that is composed of an executable with a tacked on filesystem.
[https://appimage.org/ AppImage] is a monolithic packaging format for linux applications. It contains all dependencies in one file that is composed of an executable with a tacked on filesystem.


On most distros, all one has to do is download the <code>.AppImage</code> file, make it executable <code>chmod +x $AppImage</code>, and execute it. This doesn't work in nixOS out of the box though (can someone explain why?)
On most distros, all one has to do is download the <code>.AppImage</code> file, make it executable <code>chmod +x $AppImage</code>, and execute it. This doesn't work in NixOS out of the box though, as AppImage files usually (if not always) depend on certain libraries commonly found on other Linux distributions to exist on certain paths; such as <code>/lib64/ld-linux-x86-64.so.2</code>.
 


== Running an AppImage file on NixOS ==
== Running an AppImage file on NixOS ==
Line 11: Line 10:
</syntaxhighlight>
</syntaxhighlight>


== Register AppImage files as a binary type to binfmt_misc ==
You can tell the Linux kernel to use an interpreter (e.g. <code>appimage-run</code>) when executing certain binary files through the use of [https://en.wikipedia.org/wiki/Binfmt_misc#External_links binfmt_misc], either by filename extension or magic number matching. Below NixOS configuration registers AppImage files (ELF files with magic number "AI" + 0x02) to be run with <code>appimage-run</code> as interpreter.
Since [https://nixos.org/manual/nixos/stable/release-notes#sec-release-24.05-new-services NixOS 24.05], there is a binfmt option:
<syntaxhighlight lang="nixos">
programs.appimage = {
  enable = true;
  binfmt = true;
};
</syntaxhighlight>
This way AppImage files can be invoked directly as if they were normal programs


== How AppImage files are packaged by NixOS ==
== How AppImage files are packaged by NixOS ==


See the [https://nixos.org/manual/nixpkgs/stable/#ssec-pkgs-appimageTools-wrapping nixpkgs manual on wrapping AppImage]. Basically what is done is the AppImage is extracted and the dependencies are added as nix build dependencies.
See the [https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-appimageTools nixpkgs manual on wrapping AppImage packages]. In short, the AppImage is extracted and any dependencies are added as nix build dependencies.
 
[[Category:Software]]

Revision as of 19:09, 21 June 2024

AppImage is a monolithic packaging format for linux applications. It contains all dependencies in one file that is composed of an executable with a tacked on filesystem.

On most distros, all one has to do is download the .AppImage file, make it executable chmod +x $AppImage, and execute it. This doesn't work in NixOS out of the box though, as AppImage files usually (if not always) depend on certain libraries commonly found on other Linux distributions to exist on certain paths; such as /lib64/ld-linux-x86-64.so.2.

Running an AppImage file on NixOS

$ nix-shell -p appimage-run
$ appimage-run $AppImageFile

Register AppImage files as a binary type to binfmt_misc

You can tell the Linux kernel to use an interpreter (e.g. appimage-run) when executing certain binary files through the use of binfmt_misc, either by filename extension or magic number matching. Below NixOS configuration registers AppImage files (ELF files with magic number "AI" + 0x02) to be run with appimage-run as interpreter.

Since NixOS 24.05, there is a binfmt option:

programs.appimage = {
  enable = true;
  binfmt = true;
};

This way AppImage files can be invoked directly as if they were normal programs

How AppImage files are packaged by NixOS

See the nixpkgs manual on wrapping AppImage packages. In short, the AppImage is extracted and any dependencies are added as nix build dependencies.