Only convert to unicode when needed

[irker.git] / install.txt

diff --git a/install.txt b/install.txt
index fe550d3153b5d29538eaababbaf41c2dfb701e1c..d68182da69d62b13171a00ffff9f419e98d4c573 100644 (file)
--- a/install.txt
+++ b/install.txt
@@ -16,27 +16,37 @@ 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
-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.
-
-For higher performance, also install the eventlet library from
-<http://pypi.python.org/pypi/eventlet/>.  This merges in a cooperative
-threading implementation that is faster and has much lower space
-overhead than system threads, making irkerd more resistant to
-potential DoS attacks.
+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 upstream 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.
 
+irkerd no longer requires irclib as it did in the 1.x versions.
+
 == Installing irkerhook.py ==
 
 Under git, a call to irkerhook.py should be installed in the update 
@@ -54,6 +64,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,
@@ -64,6 +80,9 @@ to an irkerd instance.
 Then, start irkerd and call irkerhook.py while watching the freenode
 #commits channel.
 
+The 'irk' script is a little test tool that takes two arguments,
+a channel and a message, and does what you'd expect.
+
 If you need help, there's a project chat channel at 
 
    irc://chat.freenode.net/#irker