JavaPackager is a Maven plugin which provides an easy way to package Java applications in native Windows, Mac OS X, or GNU/Linux executables, and generates installers for them.
SNAPSHOT versions are not published at Maven Central, so you have to install them manually.
Add the following plugin tag to your pom.xml:
<plugin>
<groupId>io.github.fvarrui</groupId>
<artifactId>javapackager</artifactId>
<version>1.0.2|1.0.3-SNAPSHOT</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>See plugin configuration samples to know more.
Execute next command in project's root folder:
mvn packageAnd by default it will generate next artifacts in target folder:
| Artifact | Description |
|---|---|
${name} |
Directory with the native application and other needed assets. |
${name}-${version}-runnable.jar |
Runnable JAR file. |
${name}_${version}.deb |
DEB package file if it's executed on GNU/Linux (requires dpkg-deb). |
${name}_${version}.rpm |
RPM package file if it's executed on GNU/Linux (requires rpmbuild). |
${name}_${version}.exe |
Setup file if it's executed on Windows (requires Inno Setup). |
${name}_${version}.msi |
MSI installer file if it's executed on Windows (requires WiX Toolset). |
${name}_${version}.dmg |
Disk image file if it's executed on Mac OS X (requires hdiutil). |
${name}_${version}.pkg |
PKG installer file if it's executed on Mac OS X (requires pkgbuild) |
${name}-${version}-${platform}.zip |
Zipball containing generated directory ${name}. |
${name}-${version}-${platform}.tar |
Tarball containing generated directory ${name}. |
${name}-${version}-${platform}.tar.gz |
Compressed tarball containing generated directory ${name}. |
⚠️ DEB, RPM, EXE installer and DMG files generation will be ommited if target platform is different from current platform (seeplatformproperty).
| Property | Mandatory | Default value | Description |
|---|---|---|---|
additionalModules |
❌ | [] |
Additional modules to the ones identified by jdeps or the specified with modules property. |
additionalResources |
❌ | [] |
Additional files and folders to include in the bundled app. |
administratorRequired |
❌ | false |
App will run as administrator (with elevated privileges). |
bundleJre |
❌ | false |
Embeds a customized JRE with the app. |
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 |
❌ | null |
Defines PATH environment variable in GNU/Linux and Mac OS X startup scripts. |
extra |
❌ | null |
Map with extra properties to be used in customized Velocity templates, accesible through $info.extra variable. |
generateInstaller |
❌ | true |
Generates an installer for the app. |
iconFile |
❌ | null |
Path to the app icon file (PNG, XPM, ICO or ICNS). |
jreDirectoryName |
❌ | "jre" |
Bundled JRE directory name. |
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 ${project.basedir}/LICENSE |
Path to project license file. |
mainClass |
✔️ | ${exec.mainClass} |
Full path to your app main class. |
modules |
❌ | [] |
Defines modules to customize the bundled JRE. Don't use jdeps 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 |
❌ | null |
Organization email. |
platform |
❌ | auto |
Defines the target platform, which could be different to the execution platform. Possible values: auto, mac, linux, windows. Use auto for using execution platform as target. |
runnableJar |
❌ | null |
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. |
url |
❌ | null |
App website URL. |
useResourcesAsWorkingDir |
❌ | true |
Uses app resources folder as default working directory. |
version |
❌ | ${project.version} |
Project version. |
vmArgs |
❌ | [] |
Adds VM arguments. |
Platform specific properties
| Property | Mandatory | Default | Description |
|---|---|---|---|
linuxConfig |
❌ | null |
GNU/Linux specific properties. |
macConfig |
❌ | null |
Mac OS X specific properties. |
winConfig |
❌ | null |
Windows specific properties. |
See Older documentation for previous versions properties.
⚠️ Be careful when using theplatformproperty 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. Also, customized JRE and intallers generation will be ommited.
Some assets, such as application icons and Velocity templates, could be placed in assets folder organized by platform.
<project>/
└── assets/
├── linux/
├── mac/
└── windows/
If icons are located in assets folders, it would not be necessary to specify the iconFile property:
<project>/
└── assets/
├── linux/
│ ├── ${name}.png # on GNU/Linux it has to be a PNG file for DEB package
│ └── ${name}.xpm # and XPM file for RPM package
├── mac/
│ └── ${name}.icns # on Mac OS X it has to be a ICNS file
└── windows/
└── ${name}.ico # on Windows it has to be a ICO file
⚠️ IficonFileplugin property is not specified and it can't find the correct icon inassetsfolder, it will use an icon by default for all platforms.
Velocity templates (.vtl files) are used to generate some artifacts which have to be bundled with the app.
It is possible to use your own customized templates. You just have to put one of the following templates in the assets folder organized by platform, and the plugin will use these templates instead of default ones:
<project>/
└── assets/
├── linux/
| ├── control.vtl # DEB control template
| ├── desktop.vtl # Desktop template
│ └── startup.sh.vtl # Startup script template
├── mac/
| ├── customize-dmg.applescript.vtl # Applescript template
| ├── Info.plist.vtl # Info.plist template
│ └── startup.vtl # Startup script template
├── windows/
| ├── exe.manifest.vtl # exe.manifest template
│ └── iss.vtl # Inno Setup Script template
└── assembly.xml.vtl # template for maven-assembly-plugin
Use default templates as examples.
An object called info is passed to all templates with all plugin properties.
Useful to try SNAPSHOT versions.
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
cd JavaPackager- Compile, package and install the plugin in your local repository:
mvn installmvn clean release:clean
mvn release:prepare
mvn release:performRelated guide.
Check the TO-DO list to know the features we plan to add to JavaPackager.