doc/Services.txt

   1
   2                      ngIRCd - Next Generation IRC Server
   3                            http://ngircd.barton.de/
   4
   5                (c)2001-2011 Alexander Barton and Contributors.
   6                ngIRCd is free software and published under the
   7                    terms of the GNU General Public License.
   8
   9                               -- Services.txt --
  10
  11
  12 At the moment, ngIRCd doesn't implement a "special IRC services interface".
  13 But services acting as a "regular server" are supported, either using the IRC
  14 protocol defined in RFC 1459 or RFC 2812.
  15
  16 Support for Services has been tested using
  17  - Anope 1.9.4 or later (<http://www.anope.org/>)
  18  - Atheme 7.0.2 or later (<http://www.atheme.net>)
  19  - "IRC Services" 5.1.x by Andrew Church (<http://achurch.org/services/>)
  20
  21 This document describes setting up ngIRCd and these services.
  22
  23 Please let us know if you are successfully using other IRC service packages or
  24 which problems you encounter -- thanks!
  25
  26
  27 Setting up ngIRCd
  28 ~~~~~~~~~~~~~~~~~
  29
  30 The "pseudo server" handling the IRC services is configured as a regular
  31 remote server in the ngircd.conf(5). In addition the variable "ServiceMask"
  32 should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC
  33 services instead of regular IRC users.
  34
  35 Example:
  36
  37   [SERVER]
  38      Name = services.irc.net
  39      MyPassword = 123abc
  40      PeerPassword = 123abc
  41      ServiceMask = *Serv
  42
  43
  44 Setting up Anope 1.9.x
  45 ~~~~~~~~~~~~~~~~~~~~~~
  46
  47 Anope 1.9.4 (and above) can be used with ngIRCd using a preliminary "ngircd"
  48 protocol module contained in our contrib/Anope/ directory. Please see the
  49 file contrib/Anope/README for installation instructions!
  50
  51 After patching and installing Anope, at least the following configuration
  52 variables have to be adjusted in data/services.conf, in addition to all the
  53 settings marked as required:
  54
  55   uplink
  56   {
  57         host = "server.irc.net"
  58         port = 6667
  59         password = "123abc"
  60   }
  61
  62   serverinfo
  63   {
  64         name = "services.irc.net"
  65         type = "ngircd"
  66   }
  67
  68
  69 Setting up Atheme 7.0.2 or later
  70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71
  72 Atheme 7.0.2 or later (<http://www.atheme.net>) may be used with ngIRCd using
  73 the "ngircd" protocol module.
  74
  75 The following settings need to be in atheme.conf:
  76
  77   loadmodule "modules/protocol/ngircd";
  78
  79   uplink "server.irc.net" {
  80         password = "123abc";
  81         port = 6667;
  82   };
  83
  84 The documentation of Atheme can be found in the doc/ directory of the
  85 Atheme source distribution.
  86
  87
  88 Setting up IRC Services 5.1.x
  89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  90
  91 IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
  92 protocol module.
  93
  94 Please note that versions up to and including 5.1.3 contain a bug that
  95 sometimes causes IRC Services to hang on startup. There are two workarounds:
  96  a) send the services process a HUP signal ("killall -HUP ircservices")
  97  b) apply this patch to the IRC Services source tree:
  98     <ftp://ngircd.barton.de/ngircd/contrib/IRCServices513-FlushBuffer.patch>
  99
 100 At least the following settings have to be tweaked, in addition to all the
 101 settings marked as required by IRC Services:
 102
 103 In ircservices.conf:
 104
 105   Variable              Example value
 106
 107   RemoteServer          server.irc.net 6667 "123abc"
 108   ServerName            "services.irc.net"
 109   LoadModule            protocol/rfc1459
 110
 111 In modules.conf:
 112
 113   Module                protocol/rfc1459
 114
 115 The documentation of IRC Services can be found here:
 116 <http://www.ircservices.za.net/docs/>