Openfire is a real time collaboration (RTC) server licensed under the Open Source Apache License. It uses the only widely adopted open protocol for instant messaging, XMPP (also called Jabber). Openfire is incredibly easy to setup and administer, but offers rock-solid security and performance.
Openfire is a XMPP server licensed under the Open Source Apache License.
Only a few users have access for filling bugs in the tracker. New users should:
- Create a Discourse account
- Login to a Discourse account
- Click on the New Topic button
- Choose the Openfire Dev category and provide a detailed description of the bug.
Please search for your issues in the bug tracker before reporting.
- Documentation: http://www.igniterealtime.org/projects/openfire/documentation.jsp
- Community: https://discourse.igniterealtime.org/c/openfire
- Bug Tracker: http://issues.igniterealtime.org/browse/OF
- Nightly Builds: http://www.igniterealtime.org/downloads/nightly_openfire.jsp
Ignite Realtime is an Open Source community composed of end-users and developers around the world who are interested in applying innovative, open-standards-based Real Time Collaboration to their businesses and organizations. We're aimed at disrupting proprietary, non-open standards-based systems and invite you to participate in what's already one of the biggest and most active Open Source communities.
The project uses Maven and as such should import straight in to your favourite Java IDE. The directory structure is fairly straightforward. The code is contained in two key folders:
Openfire/xmppserver- a Maven module representing the core code for Openfire itself
Openfire/plugins- a number of modules for the various plugins available
Other folders are:
Openfire/build- various files use to create installers for different platforms
Openfire/distribution- a Maven module used to bring all the parts together
Openfire/documentation- the documentation hosted at igniterealtime.org
Openfire/i18n- files used for internationalisation of the admin interface
Openfire/starter- a small module that allows Openfire to start in a consistent manner on different platforms
To build the complete project including plugins, run the command
However much of the time it is only necessary to make changes to the core XMPP server itself in which case the command
mvn verify -pl distribution -am
will compile the core server and any dependencies, and then assemble it in to something that can be run.
Testing your changes
- Run -> Edit Configurations... -> Add Application
- fill in following values
- Name: Openfire
- Use classpath of module: starter
- Main class: org.jivesoftware.openfire.starter.ServerStarter
- VM options (adapt accordingly):
-DopenfireHome="-absolute path to your project folder-\distribution\target\distribution-base" -Xverify:none -server -Dlog4j.configurationFile="-absolute path to your project folder-\distribution\target\distribution-base\lib\log4j2.xml" -Dopenfire.lib.dir="-absolute path to your project folder-\distribution\target\distribution-base\lib" -Dfile.encoding=UTF-8
- Working directory: -absolute path to your project folder-
You need to execute
mvn verify before you can launch openfire.
Although your IDE will happily compile the project, unfortunately it's not possible to run Openfire from within the IDE - it must be done at the command line. After building the project using Maven, simply run the shell script or batch file to start Openfire;
-debug as the first parameter to the script will start the server in debug mode, and your IDE should be able
to attach a remote debugger if necessary.
Compiling a plugin
Compiling the complete project will build all the plugins - however to test changes to a plugin it's often quicker to
compile an individual plugin by specifing the
pom.xml for that plugin, for example;
mvn verify -f plugins/broadcast/pom.xml