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