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: The Openfire build process is based on Apache Maven. Visit the Maven website for more information.

This documentation is divided into three sections:

  1. Source -- get te Openfire source code.
  2. Setup -- how to setup your environment for Openfire development.
  3. Build Phases -- tasks that can be performed using the build program.

1. Get the Openfire Source

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.

2. Setup Your Environment

Getting your machine ready for development requires a few steps. Wherever possible, instructions are provided for both Unix/Linux and Windows users.

Configure Java for Openfire

Install the Maven Build Tool

The Openfire build process uses Maven, so that tool must be installed and configured on your computer. First download Maven from: Next, follow the usage instructions.

Test the Build


3. Build Phases

Openfire conforms to the standard Maven build process. For a full list of the commands please review the Apache Maven documentation. For more complete help on several commands, read the documentation below.

To execute a build pahse, type mvn "phase" where "phase" is one of the keywords listed below:

Note that you can combine several phases, for example: mvn clean package. When a phase is given, Maven will execute every phase in the sequence up to and including the one defined. For example, when the 'package' phase is executed, the 'compile' and 'test' phases are also executed (but the 'clean' phase is not, unless specified explicitly). Please refer to the Maven documentation for more details.