Services.txt: Update information for Anope 2.x

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

diff --git a/doc/Services.txt b/doc/Services.txt
index c2059b246a69a0009df69a710e1fcde3cb4e3443..2cef7781e81072b3650242991db3a59c4a790dc8 100644 (file)
--- a/doc/Services.txt
+++ b/doc/Services.txt
@@ -9,16 +9,20 @@
                               -- Services.txt --
 
 
-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.
+ngIRCd doesn't implement a "special IRC services interface", but services
+acting as a "regular servers" ("pseudo servers") are supported, either
+using the IRC protocol as defined in RFC 1459 or RFC 2812.
 
-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/>).
+Support for Services has been tested using
+ - Anope 1.9.8 or later (<http://www.anope.org/>)
+ - Atheme 7.0.2 or later (<http://www.atheme.net>)
+ - "IRC Services" 5.1.x by Andrew Church (<http://achurch.org/services/>)
 
 This document describes setting up ngIRCd and these services.
 
+Please let us know if you are successfully using other IRC service packages or
+which problems you encounter -- thanks!
+
 
 Setting up ngIRCd
 ~~~~~~~~~~~~~~~~~
@@ -37,16 +41,22 @@ Example:
      ServiceMask = *Serv
 
 
-Setting up Anope 1.9.x
-~~~~~~~~~~~~~~~~~~~~~~
+Setting up Anope 1.9.x & 2.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!
+Anope 1.9.8 or later (<http://www.anope.org/>) can be used with ngIRCd using
+the "ngircd" protocol module.
+
+At least the following settings have to be tweaked, in addition to all the
+settings marked as required by Anope:
 
-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:
+In conf/services.conf:
+
+  define
+  {
+       name = "services.host"
+       value = "services.irc.net"
+  }
 
   uplink
   {
@@ -55,12 +65,53 @@ settings marked as required:
        password = "123abc"
   }
 
-  serverinfo
+  # Load ngIRCd protocol module
+  module
   {
-       name = "services.irc.net"
-       type = "ngircd"
+       name = "ngircd"
   }
 
+  networkinfo
+  {
+       # Must be set to the "MaxNickLength" setting of ngIRCd!
+       nicklen = 9
+
+       # When not using "strict mode", which is the default:
+       userlen = 20
+
+       chanlen = 50
+  }
+
+In conf/nickserv.conf:
+
+  module
+  {
+       name = "nickserv"
+
+       # not required if you are running ngIRCd with a higher nickname limit
+       # ("MaxNickLength") than 11 characters, but REQUIRED by default!
+       guestnickprefix = "G-"
+  }
+
+
+Setting up Atheme 7.0.2 or later
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Atheme 7.0.2 or later (<http://www.atheme.net>) may be used with ngIRCd using
+the "ngircd" protocol module.
+
+The following settings need to be in atheme.conf:
+
+  loadmodule "modules/protocol/ngircd";
+
+  uplink "server.irc.net" {
+       password = "123abc";
+       port = 6667;
+  };
+
+The documentation of Atheme can be found in the doc/ directory of the
+Atheme source distribution.
+
 
 Setting up IRC Services 5.1.x
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -91,7 +142,3 @@ 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!