Add preliminary ngIRCd protocol module for Anope 1.9

[ngircd-alex.git] / doc / Services.txt

diff --git a/doc/Services.txt b/doc/Services.txt
index a16cfc891370b7f73f645cc8576cb2d9f2e30e5d..c2059b246a69a0009df69a710e1fcde3cb4e3443 100644 (file)
--- a/doc/Services.txt
+++ b/doc/Services.txt
@@ -1,9 +1,8 @@
 
                      ngIRCd - Next Generation IRC Server
+                           http://ngircd.barton.de/
 
-                        (c)2001-2008 Alexander Barton,
-                    alex@barton.de, http://www.barton.de/
-
+               (c)2001-2011 Alexander Barton and Contributors.
                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 
@@ -14,9 +13,11 @@ At the moment, ngIRCd doesn't implement a "special IRC services interface".
 But services acting as a "regular server" are supported, either using the IRC
 protocol defined in RFC 1459 or RFC 2812.
 
-Services have been tested using "IRC Services" version 5.x of Andrew Church,
-homepage: <http://www.ircservices.za.net/>. This document describes setting up
-ngIRCd and these services.
+Support for Services has been tested using "IRC Services" version 5.x by
+Andrew Church (<http://achurch.org/services/>), and a Anope 1.9 using a
+preliminary protocol module for ngIRCd (<http://www.anope.org/>).
+
+This document describes setting up ngIRCd and these services.
 
 
 Setting up ngIRCd
@@ -25,7 +26,7 @@ Setting up ngIRCd
 The "pseudo server" handling the IRC services is configured as a regular
 remote server in the ngircd.conf(5). In addition the variable "ServiceMask"
 should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC
-services insted of regular IRC users.
+services instead of regular IRC users.
 
 Example:
 
@@ -36,12 +37,45 @@ Example:
      ServiceMask = *Serv
 
 
+Setting up Anope 1.9.x
+~~~~~~~~~~~~~~~~~~~~~~
+
+Anope 1.9.4 (and above) can be used with ngIRCd using a preliminary "ngircd"
+protocol module contained in our contrib/Anope/ directory. Please see the
+file contrib/Anope/README for installation instructions!
+
+After patching and installing Anope, at least the following configuration
+variables have to be adjusted in data/services.conf, in addition to all the
+settings marked as required:
+
+  uplink
+  {
+       host = "server.irc.net"
+       port = 6667
+       password = "123abc"
+  }
+
+  serverinfo
+  {
+       name = "services.irc.net"
+       type = "ngircd"
+  }
+
+
 Setting up IRC Services 5.1.x
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-IRC Services 5.1.x can be used with ngIRCd using the "rfc1459" protocol
-module. At least the following settings have to be tweaked, in addition to all
-the settings marked as required by IRC Services:
+IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
+protocol module.
+
+Please note that versions up to and including 5.1.3 contain a bug that
+sometimes causes IRC Services to hang on startup. There are two workarounds:
+ a) send the services process a HUP signal ("killall -HUP ircservices")
+ b) apply this patch to the IRC Services source tree:
+    <ftp://ngircd.barton.de/ngircd/contrib/IRCServices513-FlushBuffer.patch>
+
+At least the following settings have to be tweaked, in addition to all the
+settings marked as required by IRC Services:
 
 In ircservices.conf:
 
@@ -57,3 +91,7 @@ In modules.conf:
 
 The documentation of IRC Services can be found here:
 <http://www.ircservices.za.net/docs/>
+
+
+Please let us know if you are successfully using other IRC service packages or
+which problems you encounter, thanks!