Building from Source

After retrieving the source code the build can be done with Maven as easy as calling:

mvn install

After the build has finished successfully, the KickStar executable jar can be found in target directory.

Installation

The Installation can be done anywhere wanted. On Unix like System an installation directory like /opt/JavaApp is suitable. Within this directory place the kickstart.jar and the KickStart.properties file (beware of small and capital letters in Unix OS). Additionally, some directories need to be added to place the actual libraries into it. A recommendation is to create the following sub-directories:

All directory naming is meant to be inside the installation directory of the KickStart framework.

Starting an Application

After a successful installation of KickStart and the needed libraries, KickStart can be started a normal JRE as easy as:

java -jar kickstart-1.0.0.jar MainClassName parameter1 parameter2 ...

The version information needs to be adapted. MainClassName is to be replaced with the actual main class containing the main method for startup. The parameters for the application follow afterwards as usual.

Additional System Configuration

In the next sections some information is given beyond the normal KickStart setup to include the Java application more deeply into the OS.

PATH Variable

On Unix one adds KickStart to a global PATH variable by changing /etc/profile , /etc/profile , /etc/bash.bashrc or /etc/bash.bashrc.local . The location depends on the System used. For user related changes the files ~/.profile or ~/.bashrc should be checked.

For Windows in the System Control Panel the path can be adjusted.

Usage in Cron

To add the KickStart bin directory into the Cron PATH variable modify /etc/crontab and add a line like PATH=/usr/bin:/usr/sbin:/sbin:/bin:/usr/lib/news/bin .

Fork me on GitHub