doc/Services.txt

   1
   2                      ngIRCd - Next Generation IRC Server
   3
   4                         (c)2001-2008 Alexander Barton,
   5                     alex@barton.de, http://www.barton.de/
   6
   7                ngIRCd is free software and published under the
   8                    terms of the GNU General Public License.
   9
  10                               -- Services.txt --
  11
  12
  13 At the moment, ngIRCd doesn't implement a "special IRC services interface".
  14 But services acting as a "regular server" are supported, either using the IRC
  15 protocol defined in RFC 1459 or RFC 2812.
  16
  17 Services have been tested using "IRC Services" version 5.x by Andrew Church,
  18 homepage: <http://www.ircservices.za.net/>. This document describes setting up
  19 ngIRCd and these services.
  20
  21
  22 Setting up ngIRCd
  23 ~~~~~~~~~~~~~~~~~
  24
  25 The "pseudo server" handling the IRC services is configured as a regular
  26 remote server in the ngircd.conf(5). In addition the variable "ServiceMask"
  27 should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC
  28 services instead of regular IRC users.
  29
  30 Example:
  31
  32   [SERVER]
  33      Name = services.irc.net
  34      MyPassword = 123abc
  35      PeerPassword = 123abc
  36      ServiceMask = *Serv
  37
  38
  39 Setting up IRC Services 5.1.x
  40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  41
  42 IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
  43 protocol module.
  44
  45 Please note that versions up to and including 5.1.3 contain a bug that
  46 sometimes causes IRC Services to hang on startup. There are two workarounds:
  47  a) send the services process a HUP signal ("killall -HUP ircservices")
  48  b) apply this patch to the IRC Services source tree:
  49     <ftp://ngircd.barton.de/ngircd/contrib/IRCServices513-FlushBuffer.patch>
  50
  51 At least the following settings have to be tweaked, in addition to all the
  52 settings marked as required by IRC Services:
  53
  54 In ircservices.conf:
  55
  56   Variable              Example value
  57
  58   RemoteServer          server.irc.net 6667 "123abc"
  59   ServerName            "services.irc.net"
  60   LoadModule            protocol/rfc1459
  61
  62 In modules.conf:
  63
  64   Module                protocol/rfc1459
  65
  66 The documentation of IRC Services can be found here:
  67 <http://www.ircservices.za.net/docs/>
  68
  69 Please let us know if you are successfully using other IRC service packages or
  70 which problems you encounter, thanks!