linuxdeployqt
A tool to make Linux applications self-contained by bundling required libraries and plugins, and optionally generate AppImages.
What is linuxdeployqt?
linuxdeployqt is a Linux deployment tool that packages compiled applications (C, C++, Qt, etc.) into self-contained bundles by copying all required libraries and plugins. It solves the problem of dependency hell on Linux, ensuring applications run reliably across different distributions. The tool can also generate AppImages, portable single-file executables that don't require installation.
Developers and maintainers of Linux desktop applications, especially those using Qt or compiled languages, who need to distribute binaries that work across multiple distributions without requiring users to install dependencies.
It automates the tedious process of bundling dependencies and creating portable Linux packages, saving developers time and reducing support issues. Unlike manual packaging, it ensures all necessary libraries are included, and its integration with CI/CD pipelines enables automated release builds.
Overview
Makes Linux applications self-contained by copying in the libraries and plugins that the application uses, and optionally generates an AppImage. Can be used for Qt and other applications
Use Cases
Best For
- Packaging Qt applications for distribution on multiple Linux distributions
- Creating portable AppImages from existing desktop applications
- Automating deployment in CI/CD pipelines (e.g., Travis CI, GitHub Actions)
- Bundling C/C++ applications with their shared library dependencies
- Ensuring binary compatibility across different Linux environments
- Simplifying Linux software distribution for end-users
Not Ideal For
- Projects using interpreted languages like Python or Node.js that rely on system packages or virtual environments
- Developers on modern Linux distributions unwilling to set up older build environments for compatibility
- Applications without a graphical user interface or desktop entry, as it's optimized for GUI apps with .desktop files
- Teams seeking actively maintained tools, given the project's deprecation in favor of go-appimage
Pros & Cons
Pros
Uses ldd internally to automatically copy required Qt libraries and plugins into the bundle, eliminating manual dependency tracking as described in the 'Checking library inclusion' section.
Supports generating AppImages with the -appimage flag, creating single-file executables that run on most Linux distributions without installation, simplifying distribution for end-users.
Integrates with CMake, qmake, make, autotools, and meson, with README examples showing how to handle DESTDIR or INSTALL_ROOT for different build systems.
Encourages building on the oldest supported Ubuntu LTS to ensure binaries work on newer systems, maximizing user reach and reducing dependency hell.
Cons
The author has stopped active development as of 2024, redirecting users to go-appimage, which may lead to unresolved bugs or lack of future updates.
Refuses to work on systems newer than the oldest Ubuntu LTS, forcing developers to use outdated build environments, which can be inconvenient and limit modern tooling.
Primarily tailored for Qt applications, with specific handling for Qt plugins and libraries, making it less versatile for non-Qt or non-C++ projects.
Requires a specific AppDir structure and desktop file, which can be error-prone for applications without a GUI or those with custom deployment needs, as outlined in the 'Simplest example'.
Frequently Asked Questions
Related Projects
go-appimagetoolGo implementation of AppImage tools
linuxdeployAppDir creation and maintenance tool. Featuring flexible plugin system.
XojoToAppImageA tool for turning compiled Xojo Linux programs into the extremely portable and compatible AppImage!
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.