- Notifications
You must be signed in to change notification settings - Fork136
📦 Gradle/Maven plugin to package Java applications as native Windows, MacOS, or Linux executables and create installers for them.
License
javapackager/JavaPackager
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
JavaPackager is a hybrid plugin forMaven andGradle which provides an easy way to package Java applications in native Windows, MacOS or GNU/Linux executables, and generate installers for them.
Important
This project has been actively maintained for many years, but due to lack of time, I can no longer dedicate the attention it deserves. To keep it alive and evolving, I’m looking for contributors to help with its maintenance.
Any help is welcome! Thank you for your support.
It was born while teaching to my students how to build and distribute their Java apps, and after seeing that a chain of several plugins was needed to achieve this task, I decided to develop a plugin 💍 to rule them all.
Add the followingplugin tag to yourpom.xml:
<plugin> <groupId>io.github.fvarrui</groupId> <artifactId>javapackager</artifactId> <version>{latest.version}</version> <executions> <execution> <phase>package</phase> <goals> <goal>package</goal> </goals> <configuration><!-- mandatory--> <mainClass>path.to.your.mainClass</mainClass><!-- optional--> <bundleJre>true|false</bundleJre> <generateInstaller>true|false</generateInstaller> <administratorRequired>true|false</administratorRequired> <platform>auto|linux|mac|windows</platform> <additionalResources> <additionalResource>file path</additionalResource> <additionalResource>folder path</additionalResource> <additionalResource>...</additionalResource> </additionalResources> <linuxConfig>...</linuxConfig> <macConfig>...</macConfig> <winConfig>...</winConfig> [...] </configuration> </execution> </executions></plugin>
Tip
SeeMaven plugin configuration samples to know more.
And execute the next command in project's root folder:
mvn package
Apply JavaPackager plugin inbuild.gradle using legacy mode (because at the moment it's only available in Maven Central repository):
buildscript { repositories { mavenCentral() } dependencies { classpath'io.github.fvarrui:javapackager:{latest.version}' }}applyplugin:'io.github.fvarrui.javapackager.plugin'Create your packaging task:
task packageMyApp(type:io.github.fvarrui.javapackager.gradle.PackageTask,dependsOn: build) {// mandatory mainClass='path.to.your.mainClass'// optional bundleJre=true|false generateInstaller=true|false administratorRequired=true|false platform="auto"|"linux"|"mac"|"windows" additionalResources= [ file('file path'), file('folder path'),... ] linuxConfig {... } macConfig {... } winConfig {... }...}
Tip
SeeGradle plugin configuration samples to know more.
And execute the next command in project's root folder:
gradle packageMyApp
By default it will generate next artifacts in${outputDirectory} folder:
| Artifact | Description | Platform | Requires |
|---|---|---|---|
${name} | Directory with native application and other assets. | All | |
${name}-${version}-runnable.jar | Runnable JAR file. | All | |
${name}_${version}.AppImage | AppImage package file. | GNU/Linux | FUSE 2 to run the app. |
${name}_${version}.deb | DEB package file. | All | |
${name}_${version}.rpm | RPM package file. | All | |
${name}_${version}.exe | Setup file. | Windows | Inno Setup (iscc command must be in PATH variable) |
${name}_${version}.msi | MSI installer file. | Windows | WiX Toolset (candle andlight commands must be in PATH variable) |
${name}_${version}.msm | MSI merge module file. | Windows | WiX Toolset ( candle andlight commands must be in PATH variable) |
${name}_${version}.dmg | Disk image file (useshdiutil). | MacOS | |
${name}_${version}.pkg | PKG installer file (usespkgbuild). | MacOS | |
${name}-${version}-${platform}.zip | Zipball containing generated directory${name}. | All | |
${name}-${version}-${platform}.tar.gz | Compressed tarball containing generated directory${name}. | All | |
assets | Directory with all intermediate files generated by JavaPackager. | All |
Tip
Inno Setup andWiX Toolset installationguide.
| Property | Mandatory | Default value | Description |
|---|---|---|---|
additionalModulePaths | ❌ | [] | Additional module paths forjdeps. |
additionalModules | ❌ | [] | Additional modules to the ones identified byjdeps or the specified withmodules property. |
additionalResources | ❌ | [] | Additional files and folders to include in the bundled app. |
arch | ❌ | ${os.arch} | The dependency of some ArtifactGenerator objects in the process of making packages, such as GenerateDeb |
administratorRequired | ❌ | false | App will run as administrator (with elevated privileges). |
assetsDir | ❌ | ${basedir}/assets or${projectdir}/assets | Assets location (icons and custom Velocity templates). |
bundleJre | ❌ | false | Embeds a customized JRE with the app. |
classpath | ❌ | List of additional paths to JVM classpath, separated with; (recommended) or:. | |
copyDependencies | ❌ | true | Bundles all dependencies (JAR files) with the app. |
createTarball | ❌ | false | Bundles app folder in tarball. |
createZipball | ❌ | false | Bundles app folder in zipball. |
customizedJre | ❌ | true | Generates a customized JRE, including only identified or specified modules. Otherwise, all modules will be included. |
description | ❌ | ${project.description} or${displayName} | Project description. |
displayName | ❌ | ${project.name} or${name} | App name to show. |
envPath | ❌ | Defines PATH environment variable in GNU/Linux and MacOS startup scripts. | |
extra | ❌ | Map with extra properties to be used in customized Velocity templates, accesible through$info.extra variable. | |
fileAssociations | ❌ | FileAssociation[] | Associate file extensions or MIME types to the app. |
forceInstaller | ❌ | false | Iftrue, skips operating system check when generating installers. |
generateInstaller | ❌ | true | Generates an installer for the app. |
jdkPath | ❌ | ${java.home} | JDK used to generate a customized JRE. It allows to bundle customized JREs for different platforms. |
jreDirectoryName | ❌ | "jre" | Bundled JRE directory name. |
jreMinVersion | ❌ | JRE minimum version. If an appropriate version cannot be found display error message. Disabled if a JRE is bundled. | |
jrePath | ❌ | "" | Path to JRE folder. If specified, it will bundle this JRE with the app, and won't generate a customized JRE. For Java 8 version or least. |
licenseFile | ❌ | ${project.licenses[0].url} or${basedir}/LICENSE or${projectdir}/LICENSE | Path to project license file. |
mainClass | ✔️ | ${exec.mainClass} | Full path to your app main class. |
manifest | ❌ | Allows adding additional entries to MANIFEST.MF file. | |
modules | ❌ | [] | Modules to customize the bundled JRE. Don't usejdeps to get module dependencies. |
name | ❌ | ${project.name} or${project.artifactId} | App name. |
organizationName | ❌ | ${project.organization.name} or"ACME" | Organization name. |
organizationUrl | ❌ | ${project.organization.url} | Organization website URL. |
organizationEmail | ❌ | Organization email. | |
outputDirectory | ❌ | ${project.build.directory} or${project.builddir} | Output directory (where the artifacts will be generated). |
packagingJdk | ❌ | ${java.home} | JDK used in the execution ofjlink and other JDK tools. |
platform | ❌ | auto | Defines the target platform, which could be different to the execution platform. Possible values:auto,mac,linux,windows. Useauto for using execution platform as target. |
runnableJar | ❌ | Defines your own JAR file to be bundled. If it's ommited, the plugin packages your code in a runnable JAR and bundle it with the app. | |
scripts | ❌ | Specify bootstrap script.Pre and post-install scripts comming soon! | |
url | ❌ | App website URL. | |
useResourcesAsWorkingDir | ❌ | true | Uses app resources folder as default working directory (alwaystrue on MacOS). |
version | ❌ | ${project.version} | App version. |
vmArgs | ❌ | [] | VM arguments. |
Important
Some default values depends on the used building tool.
Platform specific properties
| Property | Mandatory | Description |
|---|---|---|
linuxConfig | ❌ | GNU/Linux specific properties. |
macConfig | ❌ | MacOS specific properties. |
winConfig | ❌ | Windows specific properties. |
Warning
Be careful when using theplatform property if your project uses platform dependent libraries, so the libraries of the current platform will be copied, not those required for the target platform. You can solve this problem usingclassifiers.
Anyasset used by JavaPackager, such as application icons or templates, can be replaced just by placing a file with the same name in${assetsDir} folder organized by platform.
${assetsDir}/├── linux/├── mac/└── windows/If icons are located in${assetsDir} folder, it would not be necessary to use icon properties:
${assetsDir}/├── linux/│ └──${name}.png# on GNU/Linux it has to be a PNG file├── mac/│ └──${name}.icns# on MacOS it has to be a ICNS file└── windows/ └──${name}.ico# on Windows it has to be a ICO file
Warning
If icon is not specified , it will use anicon by default for all platforms.
Velocity templates (.vtl files) are used to generate some artifacts which have to be bundled with the app or needed to generate other artifacts.
It is possible to use your own customized templates. You just have to put one of the following templates in the${assetsDir} folder organized by platform, and the plugin will use these templates instead of default ones:
${assetsDir}/├── linux/| ├── assembly.xml.vtl# maven-assembly-plugin template to generate ZIP/TGZ bundles for GNU/Linux| ├── control.vtl# DEB control template| ├── desktop.vtl# Desktop template| ├── desktop-appimage.vtl# AppImage format Desktop template| ├── mime.xml.vtl# MIME.XML template│ └── startup.sh.vtl# Startup script template├── mac/| ├── assembly.xml.vtl# maven-assembly-plugin template to generate ZIP/TGZ bundles for MacOS| ├── customize-dmg.applescript.vtl# DMG customization Applescript template| ├── Info.plist.vtl# Info.plist template│ └── startup.vtl# Startup script template└── windows/ ├── assembly.xml.vtl# maven-assembly-plugin template to generate ZIP/TGZ bundles for Windows ├── exe.manifest.vtl# exe.manifest template ├── ini.vtl# WinRun4J INI template ├── iss.vtl# Inno Setup Script template ├── msm.wxs.vtl# WiX Toolset WXS template to generate Merge Module ├── startup.vbs.vtl# Startup script template (VB Script) ├── why-ini.vtl# WHY INI template └── wxs.vtl# WiX Toolset WXS template to generate MSI
An object calledinfo of typePackagerSettings is passed to all templates with all plugin properties.
You can usedefault templates as examples to create your own templates, and use theextra map property to add your own properties in the plugin settings to use in your custom templates (e.g.${info.extra["myProperty"]}).
When you build your app, all configuration details are hardcoded into the executable and cannot be changed without recreating or hacking it with a resource editor. JavaPackager introduces a feature that allows to pass additional JVM options at runtime from an.l4j.ini file (likeLaunch4j does, but available for all platforms in the same way). So, you can specify these options in the packager's configuration (packaging time), in INI file (runtime) or in both.
The INI file's name must correspond to${name}.l4j.ini and it has to be located next to the executable on Windows and GNU/Linux, and inResources folder on MacOS.
The options should be separated with spaces or new lines:
# Additional JVM options-Dswing.aatext=true-Dsomevar="%SOMEVAR%"-Xms16m
Important
An VM argument per line.
And then bundle this file with your app:
<additionalResources> <additionalResource>${name}.l4j.ini</additionalResource></additionalResources>
Note
Last property copies${name}.l4j.ini file next to the EXE/binary on Windows/Linux, and inResources folder on MacOS.
Here you can find the uploaded JavaPackager SNAPSHOT versions.
Add the plugin repository to yourpom.xml:
<pluginRepositories> <pluginRepository> <id>nexus</id> <name>nexus-snapshot-repository</name> <url>https://oss.sonatype.org/content/repositories/snapshots</url> <snapshots> <enabled>true</enabled> <updatePolicy>always</updatePolicy> </snapshots> <releases> <enabled>false</enabled> </releases> </pluginRepository></pluginRepositories>
And then you can use the latest SNAPSHOT version:
<plugin> <groupId>io.github.fvarrui</groupId> <artifactId>javapackager</artifactId> <version>{javapackager.version}-SNAPSHOT</version> [...]</plugin>
Or a specific SNAPSHOT version (specifying its timestamp and index):
<plugin> <groupId>io.github.fvarrui</groupId> <artifactId>javapackager</artifactId> <version>{javapackager.version}-{timestamp}-{index}</version> [...]</plugin>
SNAPSHOT version example:
1.7.2-20230505.095442-5.
Add the plugin repository to yourbuild.gradle and use the latest SNAPSHOT version:
buildscript { repositories { maven { url"https://oss.sonatype.org/content/repositories/snapshots" } } dependencies { classpath'io.github.fvarrui:javapackager:{javapackager.version}-SNAPSHOT' }}Or set a specific SNAPSHOT version specifying its timestamp and index:
buildscript { [...] dependencies { classpath'io.github.fvarrui:javapackager:{javapackager.version}-{timestamp}-{index}' }}SNAPSHOT version example:
1.7.2-20230505.095442-5.
Execute next commands in BASH (GNU/Linux or macOS) or CMD (Windows):
- Download source code and change to the project directory:
git clone https://github.com/fvarrui/JavaPackager.git [--branch devel]cd JavaPackager- Compile, package and install the plugin in your local repository (ommit
./on Windows):
./gradlew publishToMavenLocal
Important
It is recommended to build the plugin with Java 19.
Run next command (ommit./ on Windows):
./gradlew publish closeAndReleaseRepository
About
📦 Gradle/Maven plugin to package Java applications as native Windows, MacOS, or Linux executables and create installers for them.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.