[[PageOutline(2-5,Contents,pullout)]]

= Announce Trac changes to IRC via Irker

== Description

This is a plugin to announce Trac changes via [http://www.catb.org/~esr/irker/ Irker]. Irker is an IRC client that runs as a daemon accepting notification requests as JSON objects presented to a listening socket.

== Bugs/Feature Requests

Please use [https://github.com/Southen/trac-irker-plugin/issues GitHub] for any issues you have with this plugin.

== Download

Download the zipped source from [https://github.com/Southen/trac-irker-plugin/archive/master.zip here].

== Source

You can clone from [https://github.com/Southen/trac-irker-plugin.git here] using git, or [https://github.com/Southen/trac-irker-plugin browse the source] on GitHub.

== Installation

Deploy to a specific Trac environment:
{{{#!sh
cd /path/to/pluginsource
python setup.py bdist_egg
cp dist/*.egg /path/to/projenv/plugins
}}}

Enable plugin in your `trac.ini` file:
{{{#!ini
[components]
irker_notification.* = enabled
}}}

Configuration in trac.ini:
{{{#!ini
[irker]
host = localhost
port = 6659
target = irc://localhost/#commits
}}}

For more information, please follow the [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin documentation] on how to install Trac plugins.

== Author/Contributors

'''Author:''' [wiki:Southen] [[BR]]
'''Maintainer:''' [wiki:Southen] [[BR]]
'''Contributors:'''