From: Eric S. Raymond Date: Mon, 1 Oct 2012 15:26:24 +0000 (-0400) Subject: Documentation improvements. X-Git-Tag: 1.4~14 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=cb3b3f2d2fe980414c11a87d3112dc5fdf80b367;p=irker.git Documentation improvements. --- diff --git a/README b/README index 844a4e4..f4d931c 100644 --- a/README +++ b/README @@ -19,7 +19,7 @@ Due to the abrupt death of cia.vc on September 24 2012 the initial release of this software was a bit rushed. See the file BUGS for known problems. -Please read the file hacking.txt before modifying this code. +Please read the files security.txt and hacking.txt before modifying this code. Eric S. Raymond August 2012 diff --git a/install.txt b/install.txt index 9850f06..f7f73f6 100644 --- a/install.txt +++ b/install.txt @@ -5,6 +5,17 @@ such as SourceForge, GitHub, Gitorious, Gna, and Savannah. This file explains the theory of operation, how to install the code, and how to test it. +== Theory of operation == + +irkerhook.py creates JSON notification requests and ships them to +irkerd's listener socket. irkerd run as a daemon in order to maintain +all the client state required to post multiple notifications while generating +minimum of join/leave messages (which, from the point of view of +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. + == Installing irker == irker needs to run constantly, watching for TCP and UDP traffic on @@ -17,6 +28,12 @@ You will need to have Jason Coombs's irc library where Python can see it. See ; use version 3.0, not the older code from SourceForge. +For higher performance, also install the eventlet library from +. 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. + == Installing irkerhook.py == irkerhook.py should be called from the post-commit hook of each @@ -53,7 +70,3 @@ mine stuff out of. Go to a project repo and call irkerhook.py as indicated above while watching the freenode #commits channel. -== Security considerations == - -See the security.txt document for a detailed discussion of security -and DoS vulnerabilities related to irker.