See the security.txt document for a detailed discussion of security
and DoS vulnerabilities related to irker.
+== Prerequisites ==
+
+You will need either
+
+1. Python at version 2.6 or later, which has JSON built in
+
+2. Python at version no older than 2.4, and a version of the
+ simplejson library installed that it can use. Some newer
+ versions of simplejson discard 2.4 compatibility; 2.0.9
+ is known to work.
+
== Installing irkerd ==
irker needs to run constantly, watching for TCP and UDP traffic on
-port 6659. Install it accordingly.
+port 6659. Install it accordingly. It has no config file; you can
+just start it up with no arguments. If you want to see what it's
+doing, give it command-line options -d 1 for sparse messages and -d 2
+to show all traffic with IRC servers.
You should *not* make irker visible from outside the site firewall, as
it can be used to spam IRC channels while masking the source address.
-You will need to have Jason Coombs's irc library where Python can see
-it. See <http://pypi.python.org/pypi/irc/>; use version 3.0, not the
-older code from SourceForge.
-
The file org.catb.irkerd.plist is a Mac OS/X plist that can be
installed to launch irkerd as a boot-time service on that system.
/path/to/irkerhook.py --refname=${refname} $(git rev-list ${oldhead}..${newhead} | tac)
+SourceForge is a special case: see
+
+https://github.com/AI0867/sf-git-irker-pipeline
+
+for tools and instructions on how to work around its limitations.
+
== Testing ==
To verify that your repo produces well-formed JSON notifications,