Appimage/en: Difference between revisions

(One intermediate revision by the same user not shown)

Line 10:

$ nix-shell -p appimage-run

$ appimage-run ~~$AppImageFile~~

$ appimage-run path/to/application.AppImage

</syntaxhighlight>

===== Additional Packages =====

Some appimages still have issues, so you can override for additional pkgs such as

<syntaxhighlight lang="nix">programs.appimage.enable = true;

programs.appimage.binfmt = true;

programs.appimage.package = pkgs.appimage-run.override

{

extraPkgs = pkgs:

[

pkgs.icu

pkgs.libxcrypt-legacy

pkgs.python312

pkgs.python312Packages.torch

];

};

</syntaxhighlight>

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

Line 27:

Line 46:

version = "1.4.0";

pname = "quba";

~~name = "${pname}-${version}";~~

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

appimageTools.wrapType2 rec {

inherit ~~name~~ src;

inherit pname version src;

extraInstallCommands = ''

~~mv $out/bin/${name} $out/bin/${pname}~~

~~install -m 444 -D ${appimageContents}/${pname}.desktop -t $out/share/applications~~

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

--replace-fail 'Exec=AppRun' 'Exec=${~~pname~~}'

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

~~cp -r ${appimageContents}/usr/share/icons $out/share~~

'';

meta = {

description = "Viewer for electronic invoices";

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

Line 58:

Line 73:

}

</syntaxhighlight>

== Configuration ==

Line 63:

Line 79:

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

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

Line 74:

Line 88:

</syntaxhighlight>

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

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

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

[[Category:Software]]

@@ Line 10: / Line 10: @@
 <syntaxhighlight lang="shell">
 $ nix-shell -p appimage-run
-$ appimage-run $AppImageFile
+$ appimage-run path/to/application.AppImage
 </syntaxhighlight>
+===== Additional Packages =====
+Some appimages still have issues, so you can override for additional pkgs such as
+<syntaxhighlight lang="nix">programs.appimage.enable = true;
+programs.appimage.binfmt = true;
+programs.appimage.package = pkgs.appimage-run.override
+{
+  extraPkgs = pkgs:
+  [
+    pkgs.icu
+    pkgs.libxcrypt-legacy
+    pkgs.python312
+    pkgs.python312Packages.torch
+  ];
+};
+</syntaxhighlight>
 === 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.
@@ Line 27: / Line 46: @@
    version = "1.4.0";
    pname = "quba";
-  name = "${pname}-${version}";
-src = fetchurl {
+  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; };
+  appimageContents = appimageTools.extractType1 { inherit name src; };
 in
-appimageTools.wrapType1 {
+appimageTools.wrapType2 rec {
-   inherit name src;
+   inherit pname version src;
-extraInstallCommands = ''
+  extraInstallCommands = ''
-    mv $out/bin/${name} $out/bin/${pname}
-    install -m 444 -D ${appimageContents}/${pname}.desktop -t $out/share/applications
      substituteInPlace $out/share/applications/${pname}.desktop \
-       --replace-fail 'Exec=AppRun' 'Exec=${pname}'
+       --replace-fail 'Exec=AppRun' 'Exec=${meta.mainProgram}'
-    cp -r ${appimageContents}/usr/share/icons $out/share
    '';
-meta = {
+  meta = {
      description = "Viewer for electronic invoices";
      homepage = "https://github.com/ZUGFeRD/quba-viewer";
@@ Line 58: / Line 73: @@
 }
 </syntaxhighlight>
 == Configuration ==
@@ Line 63: / Line 79: @@
 === 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.
+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">
@@ Line 74: / Line 88: @@
 </syntaxhighlight>
-This way AppImage files can be invoked directly as if they were normal programs
+This way AppImage files can be invoked directly as if they were normal programs.
-[[Category:Software{{#translation:}}]]
+[[Category:Software]]