XWiki provide easy way to setup clustered instances of XWiki based on network events distribution.


  • events synchronization between XWiki instances
  • multiple clustering channels
  • possibility to start stop clustering channel at runtime


Enable event distribution

To enable event distribution in a XWiki instance go to file and set the property observation.remote.enabled to true.

Setup communication channels

Then you need to create a JGroups configuration file for each different cluster group you want to setup.

For this go to /WEB-INF/observation/remote/jgroups folder and add one xml file by clustering group. Generally there is only one for a simple cluster.

You can look at for a good documentation on how to setup JGroups configuration files.

Start communication channels

The name of the xml file matches the identifier of the channel.

To indicate which channels to start when XWiki starts list the in the property observation.remote.channels of the file

Choose network adaptor implementation to use

By default only jgroups implementation is provided but it's possible to add more. See RemoteObservationModule for more details.


See RemoteObservationModule for more details of event distribution features and extension capabilities.

Follow Clustering_localhosttcptuto for a complete tutorial of how to setup a simple cluster between two instances of XWiki on the same server.


Get Connected