2 ngIRCd - Next Generation IRC Server
3 http://ngircd.barton.de/
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.
12 ngIRCd doesn't implement a "special IRC services interface", but services
13 acting as a "regular servers" ("pseudo servers") are supported, either
14 using the IRC protocol as defined in RFC 1459 or RFC 2812.
16 Support for Services has been tested using
17 - Anope 1.9.8 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/>)
21 This document describes setting up ngIRCd and these services.
23 Please let us know if you are successfully using other IRC service packages or
24 which problems you encounter -- thanks!
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.
38 Name = services.irc.net
44 Setting up Anope 1.9.x
45 ~~~~~~~~~~~~~~~~~~~~~~
47 Anope 1.9.8 or later (<http://www.anope.org/>) can be used with ngIRCd using
48 the "ngircd" protocol module.
50 At least the following settings have to be tweaked, in addition to all the
51 settings marked as required by Anope:
53 In conf/services.conf:
57 name = "services.host"
58 value = "services.irc.net"
63 host = "server.irc.net"
68 # Load ngIRCd protocol module
69 module { name = "ngircd" }
73 # Must be set to the "MaxNickLength" setting of ngIRCd!
79 In conf/nickserv.conf:
83 # not required if you are running ngIRCd with a higher nickname limit
84 # ("MaxNickLength") than 11 characters, but REQUIRED by default!
85 guestnickprefix = "G-"
89 Setting up Atheme 7.0.2 or later
90 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 Atheme 7.0.2 or later (<http://www.atheme.net>) may be used with ngIRCd using
93 the "ngircd" protocol module.
95 The following settings need to be in atheme.conf:
97 loadmodule "modules/protocol/ngircd";
99 uplink "server.irc.net" {
104 The documentation of Atheme can be found in the doc/ directory of the
105 Atheme source distribution.
108 Setting up IRC Services 5.1.x
109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111 IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
114 Please note that versions up to and including 5.1.3 contain a bug that
115 sometimes causes IRC Services to hang on startup. There are two workarounds:
116 a) send the services process a HUP signal ("killall -HUP ircservices")
117 b) apply this patch to the IRC Services source tree:
118 <ftp://ngircd.barton.de/ngircd/contrib/IRCServices513-FlushBuffer.patch>
120 At least the following settings have to be tweaked, in addition to all the
121 settings marked as required by IRC Services:
125 Variable Example value
127 RemoteServer server.irc.net 6667 "123abc"
128 ServerName "services.irc.net"
129 LoadModule protocol/rfc1459
133 Module protocol/rfc1459
135 The documentation of IRC Services can be found here:
136 <http://www.ircservices.za.net/docs/>