#pragma section-numbers 2
= Mercurial Jabber notification extension =

This is in fact an in-process hook for notifying developers of the project about server activity by using the Jabber (XMPP) messaging protocol.

<<TableOfContents>>

== Status ==

'''This extension is not distributed with Mercurial.'''

''Author:'' ''Kamyar Inanloo''

Project home: https://bitbucket.org/kamyar1979/hgxmpp

Repository: https://bitbucket.org/kamyar1979/hgxmpp

== Overview ==
This is a tiny Python package working as a Mercurial in-process hook. It works using xmpppy package for sending messages to developers (Jabber users) when one pushes/commits/... the project. You must install xmpppy as a requirement:

{{{
pip install xmpppy
}}}

or
{{{
easy_install xmpppy
}}}

Then extract the extension to Python package folder (e.g. site-packages)

== Configuration ==
Configure your .hgrc to enable the extension by adding following lines:

{{{
[hooks]
changegroup = python:hgxmpp.hook

[jabber]
userid = mercurial@mydomain.com
password = mercurialpassword
MyProject = user1@mydomain.com, user2@mydomian.com
}}}

The last line tells the extension to send notification to `user1` and `user2` when the repository `MyProject` changes.
----
CategoryExtensionsByOthers