# Clustering Plugin Readme

## Overview

The clustering plugin adds support for running multiple redundant Openfire servers together in a cluster. By running Openfire in a cluster, you can distribute the load amongst a number of servers, as well as having some form of redundency in the event that one of your servers dies. This plugin requires a valid Oracle Coherence license.

## Installation

Follow steps 1 through 4 for adding Oracle Coherence libraries to Openfire. Step 5 explains how to add this plugin to your Openfire setup.

1. Get Oracle Coherence for Java Version.
2. Unzip the coherence file and locate coherence.jar, coherence-work.jar and tangosol.jar in folder coherence/lib.
3. Copy coherence.jar, coherence-work.jar and tangosol.jar to [openfire_home]/lib.
4. Restart Openfire server.
5. Copy clustering.jar into the plugins directory of your Openfire installation. The plugin will then be automatically deployed.

This plugin has been tested with Oracle Coherence Version 3.3.1/389. To upgrade to a new Oracle Coherence version follow steps 1 through 4 as explained above. To upgrade to a new version of the plugin just get the latest version from igniterealtime.org and follow step 5.

## Upgrading from Openfire Enterprise

To upgrade from Enterprise, you will need to shut down your server, remove the enterprise.jar file and enterprise directory from the plugins directory in your Openfire install root, and then follow the steps outlined in the Installation section above.

## Configuration

To enable clustering or monitor the cluster go to: Server --> Server Manager --> Clustering

## Compiling from source code

If you want to modify or maintain this plugin you will need to get its source code and compile it. Source code of this plugin is now available in the list of plugins that you get when you download the Openfire's source code. Follow these steps to have a working environment:

1. Get Openfire's source code.
2. Get Oracle Coherence for Java Version.
3. Unzip the coherence file and locate coherence.jar, coherence-work.jar and tangosol.jar in folder coherence/lib.
4. Copy coherence.jar, coherence-work.jar and tangosol.jar to [openfire]/build/lib.
5. Add coherence.jar, coherence-work.jar and tangosol.jar to your build path.