Merge b5573c1db2 into 7d01aa0417

2026-02-06 13:57:16 +00:00 · 2026-02-05 10:18:41 -05:00 · 2026-02-05 10:18:41 -05:00 · 89ae1a11e1
commit 89ae1a11e1
parent 7d01aa0417 b5573c1db2
8 changed files with 422 additions and 7 deletions
--- a/crates/tauri-bundler/src/bundle/linux/appimage/mod.rs
+++ b/crates/tauri-bundler/src/bundle/linux/appimage/mod.rs
@ -10,9 +10,19 @@ use std::{
 use crate::Settings;

 mod linuxdeploy;
+mod sharun;

+// TODO: Consider auto fallback to linuxdeploy on unsupported systems.
 pub fn bundle_project(settings: &Settings) -> crate::Result<Vec<PathBuf>> {
-  linuxdeploy::bundle_project(settings)
+  if std::env::var("TAURI_BUNDLER_NEW_APPIMAGE_FORMAT").is_ok_and(|v| v == "true" || v == "1")
+    || settings.appimage().use_new_format
+  {
+    sharun::bundle_project(settings)
+  } else {
+    // TODO: update link with whatever it will be
+    log::warn!("Using the deprecated AppImage bundler. Please visit https://v2.tauri.app/distribute/appimage/#new-version and try the new implementation.");
+    linuxdeploy::bundle_project(settings)
+  }
 }

 fn write_and_make_executable(path: &Path, data: Vec<u8>) -> std::io::Result<()> {
--- a/crates/tauri-bundler/src/bundle/linux/appimage/sharun.rs
+++ b/crates/tauri-bundler/src/bundle/linux/appimage/sharun.rs
@ -0,0 +1,292 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use std::{
+  fs,
+  path::{Path, PathBuf},
+  process::Command,
+};
+
+use anyhow::Context;
+
+use crate::{
+  bundle::{linux::debian, settings::Arch},
+  utils::{fs_utils, http_utils::download, CommandExt},
+  Settings,
+};
+
+use super::write_and_make_executable;
+
+// TODO: Test if bundling xdg-mime makes sense (eg does it even work if it's not on the host system?)
+// TODO: Monitor TLS support / certificates - seems to be working in initial tests
+pub fn bundle_project(settings: &Settings) -> crate::Result<Vec<PathBuf>> {
+  // for backwards compat we keep the amd64 and i386 rewrites in the filename
+  let appimage_arch = match settings.binary_arch() {
+    Arch::X86_64 => "amd64",
+    //Arch::X86 => "i386",
+    Arch::AArch64 => "aarch64",
+    //Arch::Armhf => "armhf",
+    target => {
+      return Err(crate::Error::ArchError(format!(
+        "Unsupported architecture: {target:?}"
+      )));
+    }
+  };
+  let tools_arch = settings.target().split('-').next().unwrap();
+
+  let output_path = settings.project_out_directory().join("bundle/appimage");
+  if output_path.exists() {
+    fs::remove_dir_all(&output_path)?;
+  }
+
+  let tools_path = settings
+    .local_tools_directory()
+    .map(|d| d.join(".tauri"))
+    .unwrap_or_else(|| {
+      dirs::cache_dir().map_or_else(|| output_path.to_path_buf(), |p| p.join("tauri"))
+    });
+
+  fs::create_dir_all(&tools_path)?;
+
+  let (sharun_aio, uruntime, uruntime_lite) =
+    prepare_tools(&tools_path, tools_arch, settings.appimage().squashfs)?;
+
+  let package_dir = settings
+    .project_out_directory()
+    .join("bundle/appimage_deb/");
+
+  let main_binary = settings.main_binary()?;
+  let product_name = settings.product_name();
+
+  let mut settings = settings.clone();
+  if main_binary.name().contains(' ') {
+    let main_binary_path = settings.binary_path(main_binary);
+    let project_out_dir = settings.project_out_directory();
+
+    let main_binary_name_kebab = heck::AsKebabCase(main_binary.name()).to_string();
+    let new_path = project_out_dir.join(&main_binary_name_kebab);
+    fs::copy(main_binary_path, new_path)?;
+
+    let main_binary = settings.main_binary_mut()?;
+    main_binary.set_name(main_binary_name_kebab);
+  }
+
+  let upinfo = std::env::var("UPINFO")
+    .ok()
+    .or(settings.appimage().update_information.clone());
+
+  // generate deb_folder structure
+  let (data_dir, icons) = debian::generate_data(&settings, &package_dir)
+    .with_context(|| "Failed to build data folders and files")?;
+  fs_utils::copy_custom_files(&settings.appimage().files, &data_dir)
+    .with_context(|| "Failed to copy custom files")?;
+
+  fs::create_dir_all(&output_path)?;
+  let app_dir_path = output_path.join(format!("{}.AppDir", settings.product_name()));
+  let appimage_filename = format!(
+    "{}_{}_{appimage_arch}.AppImage",
+    settings.product_name(),
+    settings.version_string()
+  );
+  let appimage_path = output_path.join(&appimage_filename);
+
+  fs::create_dir_all(&tools_path)?;
+  let larger_icon = icons
+    .iter()
+    .filter(|i| i.width == i.height)
+    .max_by_key(|i| i.width)
+    .expect("couldn't find a square icon to use as AppImage icon");
+  let larger_icon_path = larger_icon
+    .path
+    .strip_prefix(package_dir.join("data"))
+    .unwrap()
+    .to_string_lossy()
+    .to_string();
+
+  log::info!(action = "Bundling"; "{} ({})", appimage_filename, appimage_path.display());
+
+  fs_utils::copy_dir(&data_dir, &app_dir_path)?;
+
+  let app_dir_share = &app_dir_path.join("share/");
+
+  fs_utils::copy_dir(&data_dir.join("usr/share/"), app_dir_share)?;
+
+  // The appimage spec allows a symlink but sharun doesn't
+  fs::copy(
+    app_dir_share.join(format!("applications/{product_name}.desktop")),
+    app_dir_path.join(format!("{product_name}.desktop")),
+  )?;
+
+  // This could be a symlink as well (supported by sharun as far as i can tell)
+  fs::copy(
+    app_dir_path.join(larger_icon_path.strip_prefix("usr/").unwrap()),
+    app_dir_path.join(format!("{product_name}.png")),
+  )?;
+
+  std::os::unix::fs::symlink(
+    app_dir_path.join(format!("{product_name}.png")),
+    app_dir_path.join(".DirIcon"),
+  )?;
+
+  let verbosity = match settings.log_level() {
+    log::Level::Error => "-q", // errors only
+    log::Level::Info => "",    // errors + "normal logs" (mostly rpath)
+    log::Level::Trace => "-v", // You can expect way over 1k lines from just lib4bin on this level
+    _ => "",
+  };
+
+  // TODO: Maybe missing alsa, pipewire, whatever?
+  // TODO: Test on fedora & arch, currently errors out on Ubuntu
+  let gst = if settings.appimage().bundle_media_framework {
+    format!(
+      r#"
+/usr/lib/{tools_arch}-linux-gnu/libpulsecommon* \
+/usr/lib/{tools_arch}-linux-gnu/gstreamer-1.0/* \
+/usr/lib/{tools_arch}-linux-gnu/gstreamer1.0/gstreamer-1.0/* \
+"#
+    )
+  } else {
+    "".to_string()
+  };
+
+  let bins = settings.copy_binaries(&app_dir_path.join("usr/bin/"))?;
+  let bins = bins
+    .iter()
+    .map(|b| format!(" \"{}\"", b.to_string_lossy()))
+    .collect::<String>();
+
+  let xvfb = if which::which("xvfb-run").is_ok() {
+    "xvfb-run -a -- "
+  } else {
+    log::warn!("xvfb-run not found but heavily recommended! In headless mode the bundler will likely miss some required libraries.");
+    ""
+  };
+
+  // TODO: Check if we can make parts of the opengl (incl. libvulkan) deps optional
+  Command::new("/bin/sh")
+    .current_dir(&app_dir_path)
+    .args([
+      "-c",
+      &format!(
+        r#"{}"{}" l -p {verbosity} -e -s -k "{}" {} \
+/usr/lib/{tools_arch}-linux-gnu/libwebkit2gtk-4.1* \{gst}
+/usr/lib/{tools_arch}-linux-gnu/gdk-pixbuf-*/*/*/* \
+/usr/lib/{tools_arch}-linux-gnu/gio/modules/* \
+/usr/lib/{tools_arch}-linux-gnu/libnss*.so* \
+/usr/lib/{tools_arch}-linux-gnu/libGL* \
+/usr/lib/{tools_arch}-linux-gnu/libEGL* \
+/usr/lib/{tools_arch}-linux-gnu/libvulkan* \
+/usr/lib/{tools_arch}-linux-gnu/dri/* \
+/usr/lib/{tools_arch}-linux-gnu/gbm/*
+"#,
+        xvfb,
+        sharun_aio.to_string_lossy(),
+        &app_dir_path
+          .join(format!("usr/bin/{}", main_binary.name()))
+          .to_string_lossy(),
+        bins
+      ),
+    ])
+    .output_ok()
+    .context("lib4bin command failed to run.")?;
+
+  fs_utils::remove_dir_all(&app_dir_path.join("usr/"))?;
+
+  let sharun = app_dir_path.join("sharun");
+  fs::copy(&sharun, app_dir_path.join("AppRun"))?;
+
+  Command::new(sharun)
+    .current_dir(&app_dir_path)
+    .arg("-g")
+    .output_ok()
+    .context("Failed to generate library path for AppDir.")?;
+
+  if let Some(upinfo) = upinfo.as_deref() {
+    Command::new(&uruntime_lite)
+      .current_dir(&app_dir_path)
+      .args([
+        "--appimage-addupdinfo",
+        &upinfo.replace("$ARCH", tools_arch),
+      ])
+      .output_ok()
+      .context("Failed to add update info.")?;
+  }
+
+  // TODO: verbosity - uruntime doesn't expose any settings and doesn't log much
+  Command::new(&uruntime)
+    .env("ARCH", tools_arch)
+    // TODO: check if needed like in our old bundler. May not work on the addupinfo call above.
+    // .env("APPIMAGE_EXTRACT_AND_RUN", "1")
+    .args([
+      "--appimage-mkdwarfs",
+      "-f",
+      "--set-owner",
+      "0",
+      "--set-group",
+      "0",
+      "--no-history",
+      "--no-create-timestamp",
+      "--compression",
+      "zstd:level=22",
+      "-S26",
+      "-B8",
+      "--header",
+      &uruntime_lite.to_string_lossy(),
+      "-i",
+      &app_dir_path.to_string_lossy(),
+      "-o",
+      &appimage_path.to_string_lossy(),
+    ])
+    .output_ok()
+    .context("Failed to generate AppImage from AppDir.")?;
+
+  {
+    use std::os::unix::fs::PermissionsExt;
+    fs::set_permissions(&appimage_path, fs::Permissions::from_mode(0o770))?;
+  }
+
+  if upinfo.is_some() {
+    Command::new("zsyncmake")
+      .args([
+        &appimage_path.to_string_lossy(),
+        "-u",
+        &appimage_path.to_string_lossy(),
+      ])
+      .output_ok()
+      .context("Failed to create .zsync file.")?;
+  }
+
+  fs::remove_dir_all(package_dir)?;
+  Ok(vec![appimage_path])
+}
+
+// TODO: mirror
+fn prepare_tools(
+  tools_path: &Path,
+  arch: &str,
+  squashfs: bool,
+) -> crate::Result<(PathBuf, PathBuf, PathBuf)> {
+  let fstype = if squashfs { "squashfs" } else { "dwarfs" };
+  let uruntime = tools_path.join(format!("uruntime-appimage-{fstype}-{arch}"));
+  if !uruntime.exists() {
+    let data = download(&format!("https://github.com/VHSgunzo/uruntime/releases/download/v0.5.6/uruntime-appimage-{fstype}-{arch}"))?;
+    write_and_make_executable(&uruntime, data)?;
+  }
+
+  let uruntime_lite = tools_path.join(format!("uruntime-appimage-{fstype}-lite-{arch}"));
+  if !uruntime_lite.exists() {
+    let data = download(&format!("https://github.com/VHSgunzo/uruntime/releases/download/v0.5.6/uruntime-appimage-{fstype}-lite-{arch}"))?;
+    write_and_make_executable(&uruntime_lite, data)?;
+  }
+
+  let sharun_aio = tools_path.join(format!("sharun-{arch}-aio"));
+  if !sharun_aio.exists() {
+    let data = download(&format!(
+      "https://github.com/VHSgunzo/sharun/releases/download/v0.7.9/sharun-{arch}-aio"
+    ))?;
+    write_and_make_executable(&sharun_aio, data)?;
+  }
+
+  Ok((sharun_aio, uruntime, uruntime_lite))
+}
--- a/crates/tauri-bundler/src/bundle/settings.rs
+++ b/crates/tauri-bundler/src/bundle/settings.rs
@ -224,6 +224,32 @@ pub struct AppImageSettings {
  pub bundle_media_framework: bool,
  /// Whether to include the `xdg-open` binary.
  pub bundle_xdg_open: bool,
+  /// Use the new AppImage bundler based on sharun and uruntime instead of linuxdeploy.
+  ///
+  /// Enabling this is strongly recommended as it will produce truly portable
+  /// AppImages that allow you to build on newer distros while still supporting
+  /// older distros. The produced AppImage also has fewer general issues and
+  /// supports Wayland without forcing the use of XWayland.
+  ///
+  /// The drawbacks of this option is that the AppImage will be larger, only supports
+  /// x86_64 and aarch64, and currently can only be built on Debian/Ubuntu based systems.
+  /// For Ubuntu it requires at least 24.04 and above.
+  pub use_new_format: bool,
+  /// Make the AppImage use squashfs instead of dwarfs.
+  ///
+  /// Enabling this option will improve compatibility with AppImage integration
+  /// tools but will also increase the file size.
+  ///
+  /// Ignored if `use_new_format` is disabled.
+  pub squashfs: bool,
+  /// Update information to forward to the AppImage tooling according to <https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information>.
+  /// Can also be provided via the `UPINFO` env var.
+  ///
+  /// When enabled, the generated AppImage or the .zsync file must not be renamed
+  /// to keep the update mechanism working.
+  ///
+  /// Requires `zsyncmake` to be installed on the build system.
+  pub update_information: Option<String>,
 }

 /// The RPM bundle settings.
--- a/crates/tauri-cli/config.schema.json
+++ b/crates/tauri-cli/config.schema.json
@ -95,7 +95,10 @@
        "linux": {
          "appimage": {
            "bundleMediaFramework": false,
-            "files": {}
+            "files": {},
+            "squashfs": false,
+            "updateInformation": null,
+            "useNewFormat": false
          },
          "deb": {
            "files": {}
@ -2225,7 +2228,10 @@
          "default": {
            "appimage": {
              "bundleMediaFramework": false,
-              "files": {}
+              "files": {},
+              "squashfs": false,
+              "updateInformation": null,
+              "useNewFormat": false
            },
            "deb": {
              "files": {}
@ -3131,7 +3137,10 @@
          "description": "Configuration for the AppImage bundle.",
          "default": {
            "bundleMediaFramework": false,
-            "files": {}
+            "files": {},
+            "squashfs": false,
+            "updateInformation": null,
+            "useNewFormat": false
          },
          "allOf": [
            {
@ -3182,6 +3191,24 @@
          "additionalProperties": {
            "type": "string"
          }
+        },
+        "useNewFormat": {
+          "description": "Use the new AppImage bundler based on sharun and uruntime instead of linuxdeploy.\n\n Enabling this is strongly recommended as it will produce truly portable\n AppImages that allow you to build on newer distros while still supporting\n older distros. The produced AppImage also has fewer general issues and\n supports Wayland without forcing the use of XWayland.\n\n The drawbacks of this option is that the AppImage will be larger, only supports\n x86_64 and aarch64, and currently can only be built on Debian/Ubuntu based systems.\n For Ubuntu it requires at least 24.04 and above.",
+          "default": false,
+          "type": "boolean"
+        },
+        "squashfs": {
+          "description": "Make the AppImage use squashfs instead of dwarfs.\n\n Enabling this option will improve compatibility with AppImage integration\n tools but will also increase the file size.\n\n Ignored if `use_new_format` is disabled.",
+          "default": false,
+          "type": "boolean"
+        },
+        "updateInformation": {
+          "description": "Update information to forward to the AppImage tooling according to <https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information>.\n Can also be provided via the `UPINFO` env var.\n\n When enabled, the generated AppImage or the .zsync file must not be renamed\n to keep the update mechanism working.\n\n Requires `zsyncmake` to be installed on the build system.",
+          "default": null,
+          "type": [
+            "string",
+            "null"
+          ]
        }
      },
      "additionalProperties": false
--- a/crates/tauri-cli/src/interface/rust.rs
+++ b/crates/tauri-cli/src/interface/rust.rs
@ -1561,6 +1561,9 @@ fn tauri_config_to_bundle_settings(
      files: appimage_files,
      bundle_media_framework: config.linux.appimage.bundle_media_framework,
      bundle_xdg_open: false,
+      use_new_format: config.linux.appimage.use_new_format,
+      squashfs: config.linux.appimage.squashfs,
+      update_information: config.linux.appimage.update_information,
    },
    rpm: RpmSettings {
      depends: if depends_rpm.is_empty() {
--- a/crates/tauri-schema-generator/schemas/config.schema.json
+++ b/crates/tauri-schema-generator/schemas/config.schema.json
@ -95,7 +95,10 @@
        "linux": {
          "appimage": {
            "bundleMediaFramework": false,
-            "files": {}
+            "files": {},
+            "squashfs": false,
+            "updateInformation": null,
+            "useNewFormat": false
          },
          "deb": {
            "files": {}
@ -2225,7 +2228,10 @@
          "default": {
            "appimage": {
              "bundleMediaFramework": false,
-              "files": {}
+              "files": {},
+              "squashfs": false,
+              "updateInformation": null,
+              "useNewFormat": false
            },
            "deb": {
              "files": {}
@ -3131,7 +3137,10 @@
          "description": "Configuration for the AppImage bundle.",
          "default": {
            "bundleMediaFramework": false,
-            "files": {}
+            "files": {},
+            "squashfs": false,
+            "updateInformation": null,
+            "useNewFormat": false
          },
          "allOf": [
            {
@ -3182,6 +3191,24 @@
          "additionalProperties": {
            "type": "string"
          }
+        },
+        "useNewFormat": {
+          "description": "Use the new AppImage bundler based on sharun and uruntime instead of linuxdeploy.\n\n Enabling this is strongly recommended as it will produce truly portable\n AppImages that allow you to build on newer distros while still supporting\n older distros. The produced AppImage also has fewer general issues and\n supports Wayland without forcing the use of XWayland.\n\n The drawbacks of this option is that the AppImage will be larger, only supports\n x86_64 and aarch64, and currently can only be built on Debian/Ubuntu based systems.\n For Ubuntu it requires at least 24.04 and above.",
+          "default": false,
+          "type": "boolean"
+        },
+        "squashfs": {
+          "description": "Make the AppImage use squashfs instead of dwarfs.\n\n Enabling this option will improve compatibility with AppImage integration\n tools but will also increase the file size.\n\n Ignored if `use_new_format` is disabled.",
+          "default": false,
+          "type": "boolean"
+        },
+        "updateInformation": {
+          "description": "Update information to forward to the AppImage tooling according to <https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information>.\n Can also be provided via the `UPINFO` env var.\n\n When enabled, the generated AppImage or the .zsync file must not be renamed\n to keep the update mechanism working.\n\n Requires `zsyncmake` to be installed on the build system.",
+          "default": null,
+          "type": [
+            "string",
+            "null"
+          ]
        }
      },
      "additionalProperties": false
--- a/crates/tauri-utils/src/config.rs
+++ b/crates/tauri-utils/src/config.rs
@ -326,6 +326,35 @@ pub struct AppImageConfig {
  /// The files to include in the Appimage Binary.
  #[serde(default)]
  pub files: HashMap<PathBuf, PathBuf>,
+  /// Use the new AppImage bundler based on sharun and uruntime instead of linuxdeploy.
+  ///
+  /// Enabling this is strongly recommended as it will produce truly portable
+  /// AppImages that allow you to build on newer distros while still supporting
+  /// older distros. The produced AppImage also has fewer general issues and
+  /// supports Wayland without forcing the use of XWayland.
+  ///
+  /// The drawbacks of this option is that the AppImage will be larger, only supports
+  /// x86_64 and aarch64, and currently can only be built on Debian/Ubuntu based systems.
+  /// For Ubuntu it requires at least 24.04 and above.
+  #[serde(default, alias = "use-new-format")]
+  pub use_new_format: bool,
+  /// Make the AppImage use squashfs instead of dwarfs.
+  ///
+  /// Enabling this option will improve compatibility with AppImage integration
+  /// tools but will also increase the file size.
+  ///
+  /// Ignored if `use_new_format` is disabled.
+  #[serde(default)]
+  pub squashfs: bool,
+  /// Update information to forward to the AppImage tooling according to <https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information>.
+  /// Can also be provided via the `UPINFO` env var.
+  ///
+  /// When enabled, the generated AppImage or the .zsync file must not be renamed
+  /// to keep the update mechanism working.
+  ///
+  /// Requires `zsyncmake` to be installed on the build system.
+  #[serde(default, alias = "update-information")]
+  pub update_information: Option<String>,
 }

 /// Configuration for Debian (.deb) bundles.
--- a/package.json
+++ b/package.json
@ -38,6 +38,7 @@
    },
    "onlyBuiltDependencies": [
      "esbuild",
+      "sharp",
      "workerd"
    ]
  }