I2P JPackage
** This is work in progress. Even this readme may change rapidly. **
This project aims to contain scripts and code necessary to build all-in-one installers for Windows and Mac using the JPackage tool.
Requirements
You need JDK 14 or newer installed on your system. On Windows you also need the Wix tool and a bash-like environment like Cygwin or GitBash.
Building
- Set the
JAVA_HOME
variable to point to the installation of the JDK - Clone the i2p.i2p module as a sibling to this module.
- Build it using
ant clean pkg
- Run
build.sh
How does it work
The I2P router expects to find some resources in specific places. The legacy I2P installer deployes those resources where they are exxpected to be. However with installers built with JPackage, and more specifically with Mac AppBundles it is not possible to execute arbitrary code during installation. The way to get around this is:
- Create a .jar file containing the following resources
- All router certificates
- GeoIP database
- Custom Launcher
- Enumerate these resources and generate a file called
resources.csv
. The format is CSV file where the first entry is the path that the classloader will use to locate the file, and the second entry is the path under the preferences directory where the resource should be copied. Add this file in the .jar built in step 1. - Use a custom main class
net.i2p.router.PackageLauncher
which reads the above list and copies each resource to the appropriate path under the current user's preferences directory, which is OS-dependent. - The custom main class will also set any system properties necessary for I2P to work, then invoke the "real" main class
net.i2p.router.RouterLaunch
. - The compiled custom main class gets added to the .jar as well.
JPackage gets invoked and pointed to the custom main class. It's operation can be customized by editing the following files:
File | Purpose | Example |
---|---|---|
jlink.modules | Modules to forcibly include | jdk.crypto.ec,jdk.unsupported |
jpackage.mac | Custom JPackage options for Mac | --mac-sign --mac-package-name I2P |
jpackage.win | Same but for windows | ?? |