X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=doc%2FServices.txt;h=56c81425a56908cf1972ddb12a534ef2d5824d9a;hp=944afd4807c87cd4dc366c810cf791fe689379c9;hb=HEAD;hpb=3a2fcc32cd60822bf08c8e3e75061791e0abbf9d

diff --git a/doc/Services.txt b/doc/Services.txt
index 944afd48..f945bbf1 100644
--- a/doc/Services.txt
+++ b/doc/Services.txt
@@ -9,17 +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/>), Anope 1.9 using a
-preliminary protocol module for ngIRCd (<http://www.anope.org/>), and
-Atheme 7.0.2 or later.
+Support for Services has been tested using
+ - 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.
 
+Please let us know if you are successfully using other IRC service packages or
+which problems you encounter -- thanks!
+
 
 Setting up ngIRCd
 ~~~~~~~~~~~~~~~~~
@@ -31,6 +34,10 @@ services instead of regular IRC users.
 
 Example:
 
+  [GLOBAL]
+     Name = server.irc.net
+     Ports = 6667
+
   [SERVER]
      Name = services.irc.net
      MyPassword = 123abc
@@ -38,16 +45,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.
 
-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:
+At least the following settings have to be tweaked, in addition to all the
+settings marked as required by Anope:
+
+In conf/services.conf:
+
+  define
+  {
+	name = "services.host"
+	value = "services.irc.net"
+  }
 
   uplink
   {
@@ -56,13 +69,58 @@ settings marked as required:
 	password = "123abc"
   }
 
-  serverinfo
+  # Load ngIRCd protocol module
+  module
+  {
+	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 = "services.irc.net"
-	type = "ngircd"
+	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 (<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;
+  };
+
+The documentation of Atheme can be found in the doc/ directory of the
+Atheme source distribution.
+
+
 Setting up IRC Services 5.1.x
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -73,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:
@@ -92,26 +150,3 @@ In modules.conf:
 
 The documentation of IRC Services can be found here:
 <http://www.ircservices.za.net/docs/>
-
-
-Setting up Atheme 7.0.2 or later
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Atheme 7.0.2 or later 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.
-
-
-Please let us know if you are successfully using other IRC service packages or
-which problems you encounter, thanks!