Appimage: Difference between revisions

(10 intermediate revisions by 6 users not shown)

Line 4:

[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.

== Usage ==

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

== ~~Usage~~ ==

=== Run ===

~~=== Running an AppImage file on NixOS ===~~

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 system libraries in hardcoded paths.

</translate>

$ nix-shell -p appimage-run

$ appimage-run ~~$AppImageFile~~

$ appimage-run path/to/application.AppImage

</syntaxhighlight>

=== Packaging ===

=== Packaging ===

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.

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.

Following example is a derivation for the program Quba, which is also distributed as AppImage.

</translate>

{

lib,

appimageTools,

fetchurl,

}:

let

version = "1.4.0";

pname = "quba";

src = fetchurl {

url = "https://github.com/ZUGFeRD/quba-viewer/releases/download/v${version}/Quba-${version}.AppImage";

hash = "sha256-EsTF7W1np5qbQQh3pdqsFe32olvGK3AowGWjqHPEfoM=";

};

appimageContents = appimageTools.extractType1 { inherit name src; };

in

appimageTools.wrapType2 rec {

inherit pname version src;

== ~~Configuration =~~=

extraInstallCommands = ''

substituteInPlace $out/share/applications/${pname}.desktop \

--replace-fail 'Exec=AppRun' 'Exec=${meta.mainProgram}'

'';

=== ~~Register AppImage files as a binary type to binfmt_misc~~ ===<~~!--T:4--~~>

meta = {

description = "Viewer for electronic invoices";

homepage = "https://github.com/ZUGFeRD/quba-viewer";

downloadPage = "https://github.com/ZUGFeRD/quba-viewer/releases";

license = lib.licenses.asl20;

sourceProvenance = with lib.sourceTypes; [ binaryNativeCode ];

maintainers = with lib.maintainers; [ onny ];

platforms = [ "x86_64-linux" ];

};

}

</syntaxhighlight>

~~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.~~

== Configuration ==

=== Register AppImage files as a binary type to binfmt_misc ===

~~Since [https://nixos.org/manual/nixos/stable/release-notes#sec-release-24.05-new-services NixOS 24.05], there is a binfmt option:~~

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:

</translate>

Line 45:

Line 83:

</translate>

[[Category:Software~~{{#translation:}}~~]]

[[Category:Software]]

@@ Line 4: / Line 4: @@
 [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.
-<!--T:2-->
+== Usage == <!--T:10-->
-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>.
-== Usage ==
+=== Run === <!--T:2-->
-=== Running an AppImage file on NixOS ===<!--T:3-->
+<!--T:3-->
+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 system libraries in hardcoded paths.
 </translate>
 <syntaxhighlight lang="shell">
 $ nix-shell -p appimage-run
-$ appimage-run $AppImageFile
+$ appimage-run path/to/application.AppImage
 </syntaxhighlight>
 <translate>
-=== Packaging ===<!--T:8-->
+=== Packaging === <!--T:8-->
 <!--T:9-->
-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.
+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.
+Following example is a derivation for the program Quba, which is also distributed as AppImage.
+</translate>
+<syntaxhighlight lang="nix">
+{
+  lib,
+  appimageTools,
+  fetchurl,
+}:
+let
+  version = "1.4.0";
+  pname = "quba";
+  src = fetchurl {
+    url = "https://github.com/ZUGFeRD/quba-viewer/releases/download/v${version}/Quba-${version}.AppImage";
+    hash = "sha256-EsTF7W1np5qbQQh3pdqsFe32olvGK3AowGWjqHPEfoM=";
+  };
+  appimageContents = appimageTools.extractType1 { inherit name src; };
+in
+appimageTools.wrapType2 rec {
+  inherit pname version src;
-== Configuration ==
+  extraInstallCommands = ''
+    substituteInPlace $out/share/applications/${pname}.desktop \
+      --replace-fail 'Exec=AppRun' 'Exec=${meta.mainProgram}'
+  '';
-=== Register AppImage files as a binary type to binfmt_misc ===<!--T:4-->
+  meta = {
+    description = "Viewer for electronic invoices";
+    homepage = "https://github.com/ZUGFeRD/quba-viewer";
+    downloadPage = "https://github.com/ZUGFeRD/quba-viewer/releases";
+    license = lib.licenses.asl20;
+    sourceProvenance = with lib.sourceTypes; [ binaryNativeCode ];
+    maintainers = with lib.maintainers; [ onny ];
+    platforms = [ "x86_64-linux" ];
+  };
+}
+</syntaxhighlight>
-<!--T:5-->
+<translate>
-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.
+== Configuration == <!--T:16-->
-<!--T:6-->
+=== Register AppImage files as a binary type to binfmt_misc === <!--T:4-->
-Since [https://nixos.org/manual/nixos/stable/release-notes#sec-release-24.05-new-services NixOS 24.05], there is a binfmt option:
+<!--T:5-->
+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:
 </translate>
 <syntaxhighlight lang="nixos">
@@ Line 45: / Line 83: @@
 </translate>
-[[Category:Software{{#translation:}}]]
+[[Category:Software]]