install.txt

   1 = Forge installation instructions =
   2
   3 irker and irkerhook.py are intended to be installed on forge sites
   4 such as SourceForge, GitHub, Gitorious, Gna, and Savannah.  This
   5 file explains the theory of operation, how to install the code,
   6 and how to test it.
   7
   8 == Installing irker installation ==
   9
  10 irker needs to run constantly, watching for TCP and UDP traffic on
  11 port 6659.  Install it accordingly.
  12
  13 You should *not* make irker visible from outside the site firewall, as
  14 it can be used to spam IRC channels while masking the source address.
  15
  16 == Installing irkerhook.py ==
  17
  18 irkerhook.py should be called from the post-commit hook of each
  19 repository.  See its header comment for detailed installation
  20 instructions.
  21
  22 You should set the server and either repository or project variables
  23 from the command line in your post-commit hook.  The server variable
  24 should be set to the inside-the-firewall host running your irker
  25 instance.
  26
  27 A git invocation line should look something like this:
  28
  29 /usr/local/bin/irkerhook.py project=foobar server=internal.foobar.net
  30
  31 A Subversion invocation should look something like this:
  32
  33 REPOSITORY=$1
  34 REV=$2
  35 irkerhook.py repository=$REPOSITORY commit=$REV server=internal.foobar.net
  36
  37 Note that the basename of the repository will be used as the project
  38 name.
  39
  40 == Testing ==
  41
  42 Go to a project repo and call