irkerd.xml

   1 <!DOCTYPE refentry PUBLIC
   2    "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3    "docbook/docbookx.dtd">
   4 <refentry id='irkerd.8'>
   5 <refmeta>
   6 <refentrytitle>irkerd</refentrytitle>
   7 <manvolnum>8</manvolnum>
   8 <refmiscinfo class='date'>Aug 27 2012</refmiscinfo>
   9 <refmiscinfo class='source'>irker</refmiscinfo>
  10 <refmiscinfo class='product'>irker</refmiscinfo>
  11 <refmiscinfo class='manual'>Commands</refmiscinfo>
  12 </refmeta>
  13 <refnamediv id='name'>
  14 <refname>irkerd</refname>
  15 <refpurpose>relay for shipping notifications to IRC servers</refpurpose>
  16 </refnamediv>
  17 <refsynopsisdiv id='synopsis'>
  18
  19 <cmdsynopsis>
  20   <command>irkerd</command>
  21      <arg>-d <replaceable>debuglevel</replaceable></arg>
  22      <arg>-V</arg>
  23 </cmdsynopsis>
  24 </refsynopsisdiv>
  25
  26 <refsect1 id='description'><title>DESCRIPTION</title>
  27
  28 <para><application>irkerd</application> is a specialized write-only IRC
  29 client intended to be used for shipping notification messages to IRC
  30 channels. The use case in mind when it was designed was broadcasting
  31 notifications from commit hooks in version-control systems.</para>
  32
  33 <para><application>irkerd</application> is a socket server that
  34 listens on for UDP or TCP packets on port 6659 for textual request
  35 lines containing JSON objects and terminated by a newline. Each JSON
  36 object must have two members: "to" specifying a destination or
  37 destination list, and "privmsg" specifying the message text.
  38 Examples:
  39
  40 <programlisting>
  41 {"to":"irc://chat.freenode.net/git-ciabot", "privmsg":"Hello, world!"}
  42 {"to":["irc://chat.freenode.net/#git-ciabot","irc://chat.freenode.net/#gpsd"],"privmsg":"Multichannel test"}
  43 {"to":"irc://chat.hypothetical.net:6668/git-ciabot", "privmsg":"Hello, world!"}
  44 </programlisting></para>
  45
  46 <para>If the channel part of the URL does not have one of the prefix
  47 characters <quote>#</quote>, <quote>&amp;</quote>, or
  48 <quote>+</quote>, a <quote>#</quote> will be prepended to it before
  49 shipping - <emphasis>unless</emphasis>the channel part has the suffix
  50 ",isnick" (which is unconditionally removed).</para>
  51
  52 <para>The host part of the URL may have a port-number suffix separated by a
  53 colon, as shown in the third example; otherwise
  54 <application>irkerd</application> sends messages to the the default 6667 IRC
  55 port of each server.</para>
  56
  57 <para>An empty message is legal and will cause
  58 <application>irkerd</application> to join the target channels without
  59 actually emitting a message.  This may be useful for advertising that
  60 an instance is up and running.</para>
  61 </refsect1>
  62
  63 <refsect1 id='options'><title>OPTIONS</title>
  64
  65 <para><application>irkerd</application> takes the following options:</para>
  66
  67 <variablelist>
  68 <varlistentry>
  69 <term>-d</term>
  70 <listitem><para>Takes a following value, setting the debugging level from
  71 it. This option will generally only be of interest to developers;
  72 consult the source code for details.</para></listitem>
  73 </varlistentry>
  74 <varlistentry>
  75 <term>-V</term>
  76 <listitem><para>Write the program version to stdout and
  77 terminate.</para></listitem>
  78 </varlistentry>
  79 </variablelist>
  80
  81 </refsect1>
  82
  83 <refsect1 id='limitations'><title>LIMITATIONS</title>
  84 <para>Requests via UDP optimizes for lowest latency and network load
  85 by avoiding TCP connection setup time; the cost is that delivery is
  86 not reliable in the face of packet loss.</para>
  87
  88 <para>An <application>irkerd</application> instance with a
  89 publicly-accessible request socket could complicate blocking of IRC
  90 spam by making it easy for spammers to submit while hiding their IP
  91 addresses; the better way to deploy, then, is on places like
  92 project-hosting sites where the <application>irkerd</application>
  93 socket can be visible from commit-hook code but not exposed to the
  94 outside world. Priming your firewall with blocklists of IP addresses
  95 known to spew spam is always a good idea.</para>
  96
  97 <para>The absence of any option to set the service port is deliberate.
  98 If you think you need to do that, you have a problem better solved at
  99 your firewall.</para>
 100
 101 <para>IRC has a message length limit of 510 bytes generate your privmsg attribute values with appropriate care.</para>
 102
 103 <para>IRC ignores any text after an embedded newline. Be aware that
 104 <application>irkerd</application> will turn payload strings with
 105 embedded newlines into multiple IRC sends to avoid having message data
 106 discarded. </para>
 107 </refsect1>
 108
 109 <refsect1 id='see_also'><title>SEE ALSO</title>
 110 <para>
 111 <citerefentry><refentrytitle>irkerhook</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 112 </para>
 113 </refsect1>
 114
 115 <refsect1 id='authors'><title>AUTHOR</title>
 116 <para>Eric S. Raymond <email>esr@snark.thyrsus.com</email>.  See the
 117 project page at <ulink
 118 url='http://www.catb.org/~esr/irker'>http://www.catb.org/~esr/irker</ulink>
 119 for updates and other resources, including an installable repository
 120 hook script. The implementation uses the Python IRC library by Joe
 121 Rosdahl and Jason R. Coombs.</para>
 122 </refsect1>
 123 </refentry>
 124