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