Add preliminary ngIRCd protocol module for Anope 1.9
[ngircd-alex.git] / 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 "IRC Services" version 5.x by
17 Andrew Church (<http://achurch.org/services/>), and a Anope 1.9 using a
18 preliminary protocol module for ngIRCd (<http://www.anope.org/>).
19
20 This document describes setting up ngIRCd and these services.
21
22
23 Setting up ngIRCd
24 ~~~~~~~~~~~~~~~~~
25
26 The "pseudo server" handling the IRC services is configured as a regular
27 remote server in the ngircd.conf(5). In addition the variable "ServiceMask"
28 should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC
29 services instead of regular IRC users.
30
31 Example:
32
33   [SERVER]
34      Name = services.irc.net
35      MyPassword = 123abc
36      PeerPassword = 123abc
37      ServiceMask = *Serv
38
39
40 Setting up Anope 1.9.x
41 ~~~~~~~~~~~~~~~~~~~~~~
42
43 Anope 1.9.4 (and above) can be used with ngIRCd using a preliminary "ngircd"
44 protocol module contained in our contrib/Anope/ directory. Please see the
45 file contrib/Anope/README for installation instructions!
46
47 After patching and installing Anope, at least the following configuration
48 variables have to be adjusted in data/services.conf, in addition to all the
49 settings marked as required:
50
51   uplink
52   {
53         host = "server.irc.net"
54         port = 6667
55         password = "123abc"
56   }
57
58   serverinfo
59   {
60         name = "services.irc.net"
61         type = "ngircd"
62   }
63
64
65 Setting up IRC Services 5.1.x
66 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67
68 IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
69 protocol module.
70
71 Please note that versions up to and including 5.1.3 contain a bug that
72 sometimes causes IRC Services to hang on startup. There are two workarounds:
73  a) send the services process a HUP signal ("killall -HUP ircservices")
74  b) apply this patch to the IRC Services source tree:
75     <ftp://ngircd.barton.de/ngircd/contrib/IRCServices513-FlushBuffer.patch>
76
77 At least the following settings have to be tweaked, in addition to all the
78 settings marked as required by IRC Services:
79
80 In ircservices.conf:
81
82   Variable              Example value
83
84   RemoteServer          server.irc.net 6667 "123abc"
85   ServerName            "services.irc.net"
86   LoadModule            protocol/rfc1459
87
88 In modules.conf:
89
90   Module                protocol/rfc1459
91
92 The documentation of IRC Services can be found here:
93 <http://www.ircservices.za.net/docs/>
94
95
96 Please let us know if you are successfully using other IRC service packages or
97 which problems you encounter, thanks!