How do I bundle a JRE with my Java app using JavaPackager?

Set bundleJre to true in the configuration, and optionally specify jdkPath for the JDK to use with jlink. You can customize the JRE by listing modules in the modules property to include only necessary components, reducing the final package size.

JavaPackager vs jpackage: which is better for packaging Java apps?

JavaPackager offers more installer formats (e.g., MSI, DEB, DMG) and cross-platform packaging from one environment, but requires external tools. jpackage is built into the JDK and simpler but has fewer format options. Choose JavaPackager for professional multi-format installers, jpackage for basic native packages with minimal setup.

Can I generate a Windows installer from a Linux or Mac machine?

Yes, by setting the platform property to 'windows', but note that platform-dependent libraries from your build machine will be copied. Use classifiers for dependencies to avoid this issue, as mentioned in the README warnings.

How to customize the installer icons in JavaPackager?

Place custom icon files (.ico for Windows, .icns for macOS, .png for Linux) in the assetsDir under platform-specific folders (windows/, mac/, linux/). JavaPackager will automatically use these instead of the default icons.

What external tools are needed for Windows packaging with JavaPackager?

For Windows, you need Inno Setup to generate .exe installers and WiX Toolset for .msi installers, with their command-line tools (iscc, candle, light) available in your system PATH, as specified in the generated artifacts table.

Does JavaPackager work with modular Java applications?

Yes, it supports modular apps through the modules property and jlink integration, allowing you to bundle a customized JRE with only the required modules. However, configuration can be complex if dealing with platform-specific module paths.

JavaPackager — Java Native Executable Packager

What is JavaPackager?

JavaPackager is a build tool plugin for Gradle and Maven that packages Java applications into native executables and installers for Windows, macOS, and Linux. It solves the problem of distributing Java apps by creating platform-specific packages that can run without requiring users to install Java separately.

Target Audience

Java developers and educators who need to distribute their applications as native packages, especially those targeting multiple operating systems.

Value Proposition

Developers choose JavaPackager because it consolidates multiple packaging tasks into a single plugin, supports both major build tools (Gradle and Maven), and produces professional-grade installers without requiring deep platform-specific knowledge.

:package: Gradle/Maven plugin to package Java applications as native Windows, MacOS, or Linux executables and create installers for them.

Use Cases

Best For

Creating Windows EXE installers for Java desktop applications
Building macOS DMG disk images from Java projects
Generating Linux DEB/RPM packages for Java software distribution
Bundling a customized JRE with your application for standalone deployment
Packaging Java applications for multiple platforms from a single codebase
Educational settings where students need to distribute their Java projects as executable programs

Not Ideal For

Projects that require zero external tool dependencies, as JavaPackager mandates Inno Setup and WiX Toolset for Windows installers
Teams focused on cloud-native or server-side deployment where native desktop installers are unnecessary
Applications needing advanced post-install scripting, since full support is noted as 'coming soon' in the README
Developers who only need basic JAR distribution or prefer using JDK's built-in jpackage tool for simplicity

Pros & Cons

Pros

Comprehensive Platform Support

Generates native executables and installers for Windows (.exe, .msi), macOS (.dmg, .pkg), and Linux (.deb, .rpm, AppImage), covering all major desktop OSes from a single plugin.

Single-Plugin Simplicity

Consolidates packaging tasks into one hybrid plugin for both Maven and Gradle, eliminating the need for multiple plugins and complex build chains, as highlighted in its educational origins.

JRE Customization and Bundling

Supports embedding a minimal, customized JRE using jlink, with options to specify modules and reduce distribution size, ensuring standalone app compatibility.

High Customizability

Allows replacement of icons and Velocity templates for platform-specific branding, and supports runtime JVM options via .l4j.ini files for flexible configuration.

Cons

External Tool Dependencies

Requires separate installation of Inno Setup and WiX Toolset for Windows installers, with commands needing to be in PATH, adding setup complexity and potential environment issues.

Project Maintenance Risks

The maintainer is actively seeking contributors due to lack of time, which could lead to stalled updates, bug fixes, or feature development, as noted in the README.

Configuration Complexity

With over 30 configurable properties and platform-specific options, it can be overwhelming for simple use cases and prone to misconfiguration, especially for beginners.

Frequently Asked Questions

What is JavaPackager?

Target Audience

Java developers and educators who need to distribute their applications as native packages, especially those targeting multiple operating systems.

Value Proposition

Use Cases

Best For

Creating Windows EXE installers for Java desktop applications
Building macOS DMG disk images from Java projects
Generating Linux DEB/RPM packages for Java software distribution
Bundling a customized JRE with your application for standalone deployment
Packaging Java applications for multiple platforms from a single codebase
Educational settings where students need to distribute their Java projects as executable programs

Not Ideal For

Projects that require zero external tool dependencies, as JavaPackager mandates Inno Setup and WiX Toolset for Windows installers
Teams focused on cloud-native or server-side deployment where native desktop installers are unnecessary
Applications needing advanced post-install scripting, since full support is noted as 'coming soon' in the README
Developers who only need basic JAR distribution or prefer using JDK's built-in jpackage tool for simplicity

Pros & Cons

Pros

Comprehensive Platform Support

Generates native executables and installers for Windows (.exe, .msi), macOS (.dmg, .pkg), and Linux (.deb, .rpm, AppImage), covering all major desktop OSes from a single plugin.

Single-Plugin Simplicity

Consolidates packaging tasks into one hybrid plugin for both Maven and Gradle, eliminating the need for multiple plugins and complex build chains, as highlighted in its educational origins.

JRE Customization and Bundling

Supports embedding a minimal, customized JRE using jlink, with options to specify modules and reduce distribution size, ensuring standalone app compatibility.

High Customizability

Allows replacement of icons and Velocity templates for platform-specific branding, and supports runtime JVM options via .l4j.ini files for flexible configuration.

Cons

External Tool Dependencies

Requires separate installation of Inno Setup and WiX Toolset for Windows installers, with commands needing to be in PATH, adding setup complexity and potential environment issues.

Project Maintenance Risks

The maintainer is actively seeking contributors due to lack of time, which could lead to stalled updates, bug fixes, or feature development, as noted in the README.

Configuration Complexity

With over 30 configurable properties and platform-specific options, it can be overwhelming for simple use cases and prone to misconfiguration, especially for beginners.

Frequently Asked Questions

JavaPackager

What is JavaPackager?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

JavaPackager

What is JavaPackager?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?