This document provides detailed information for developers that wish to compile and make changes to the Openfire source code.
For additional developer resources, please visit: http://www.igniterealtime.org. The Openfire build process is based on Ant. Visit the Ant website for more information. There is no need to download and install Ant - a version of it is included in this distribution.
This documentation is divided into three sections:
You can get the Openfire source code by downloading a source distribution or by checking out the source code from CVS. Instructions for both options can be found on the source page.
Getting your machine ready for development requires a few steps. Wherever possible, instructions are provided for both Unix/Linux and Windows users.
Important! -- the Openfire build tool needs to know where Java is installed on your system. You must configure the "JAVA_HOME" environment variable to point to the correct directory. Instructions on how to set this variable for various platforms are as follows:
The value "/usr/local/jdk1.5" should be replaced with your actual Java directory. Be sure there are no spaces after the end of the directory name. Do not add an extra slash after the directory name.
The JAVA_HOME variable should now be configured correctly.
The value "c:\jdk1.5" should be replaced with your actual Java directory. Be sure there are no spaces between the "=" sign or after the end of the directory name. Do not add an extra slash after the directory name.
Linux/Unix users only:You must make the ant script
executable. From the build directory, type:
Now, invoke the build tool to compile the Openfire source code
If the build tool is invoked correctly and Openfire compiles, you've correctly configured your copy of the Openfire source distribution.
The list of common build tasks is below. All build commands should be
run from the "build" directory of your Openfire distribution.
For a full list of the commands and a brief description from the command line, type
ant -projecthelp. For more complete help on several commands,
read the documentation below.
To execute a build task, type
ant [options] targetname where "targetname" is
one of the targets listed below:
Each task is documented with a syntax guide and description. Optional paramaters for each task are enclosed with braces. If you would like to permanently set the value of a property, add it to build/build.xml file.
Description:Builds Openfire into the target/openfire directory. You can then launch Openfire using the scripts in target/openfire/bin.
Description:Builds all plugins into the target/openfire/plugins directory.
Description:Cleans all artifacts of the build process.