From c6e4348a7499bb8b6da62ec80e2e5973bd123de2 Mon Sep 17 00:00:00 2001 From: "Eric S. Raymond" Date: Fri, 17 May 2013 09:10:56 -0400 Subject: [PATCH] Dcumentation update. --- NEWS | 3 +++ install.txt | 21 +++++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/NEWS b/NEWS index 9f3ff4c..a9c3dc4 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,8 @@ irker history +1.21 @ + An email delivery method, suitable for use on SourceForge. + 1.20 @ 2013-05-17 Compatibility back to Python 2.4 (provided simplejson is present). Increased anti-flood delay to avoid trouble with freenode. diff --git a/install.txt b/install.txt index 048d512..75ca4e7 100644 --- a/install.txt +++ b/install.txt @@ -16,6 +16,17 @@ humans watching irkerd's output, are mere spam). 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 @@ -30,6 +41,10 @@ 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 ; use version 3.4 or later. +Some irclib versions after 5.0 may produce problems if you try to ship +non-ASCII Unicode through them; this is not an irker bug, and should be +kicked upstrean to the irclib maintainer. + 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. @@ -50,6 +65,12 @@ with this: /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, -- 2.26.2