ngIRCd Release 27

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

diff --git a/doc/Services.txt b/doc/Services.txt
index 26d1d7e6d17987e6ebbf106f58d94c7ef639fb4b..f945bbf195c883534b35fdccef98a9fd73f2a902 100644 (file)
--- a/doc/Services.txt
+++ b/doc/Services.txt
@@ -9,13 +9,13 @@
                               -- 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
- - Anope 1.9.4 or later (<http://www.anope.org/>)
- - Atheme 7.0.2 or later (<http://www.atheme.net>)
+ - Anope 1.9.8 or later (<http://www.anope.org/>)
+ - Atheme 7.0.2 or later (<https://atheme.org/>)
  - "IRC Services" 5.1.x by Andrew Church (<http://achurch.org/services/>)
 
 This document describes setting up ngIRCd and these services.
@@ -34,6 +34,10 @@ services instead of regular IRC users.
 
 Example:
 
+  [GLOBAL]
+     Name = server.irc.net
+     Ports = 6667
+
   [SERVER]
      Name = services.irc.net
      MyPassword = 123abc
@@ -41,16 +45,22 @@ Example:
      ServiceMask = *Serv
 
 
-Setting up Anope 1.9.x
-~~~~~~~~~~~~~~~~~~~~~~
+Setting up Anope 1.9.x & 2.x
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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:
 
-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!
+In conf/services.conf:
 
-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:
+  define
+  {
+       name = "services.host"
+       value = "services.irc.net"
+  }
 
   uplink
   {
@@ -59,23 +69,49 @@ 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
+Atheme 7.0.2 or later (<https://atheme.org/>) may be used with ngIRCd using
 the "ngircd" protocol module.
 
 The following settings need to be in atheme.conf:
 
   loadmodule "modules/protocol/ngircd";
 
+  serverinfo {
+       name = "services.irc.net";
+  }
+
   uplink "server.irc.net" {
        password = "123abc";
        port = 6667;
@@ -95,7 +131,7 @@ 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>
+    <http://arthur.barton.de/pub/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: