From: Alexander Barton <alex@barton.de>
Date: Sat, 10 Nov 2012 20:24:55 +0000 (+0100)
Subject: doc/Services.txt: Update documentation for Anope 1.9.8
X-Git-Tag: rel-20-rc1~9
X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=commitdiff_plain;h=c7db2f8429c161835f6a9ed4523f45c23918892b

doc/Services.txt: Update documentation for Anope 1.9.8

Starting with Anope 1.9.8, the ngIRCd protocol module is rewritten from
scratch by "DukePyrolator" and included in the Anope distribution. So no
patching is required any more, yeah!

Drawback: Anope 1.9.8 is in development and not yet released ...
---

diff --git a/doc/Services.txt b/doc/Services.txt
index 26d1d7e6..f51bd488 100644
--- a/doc/Services.txt
+++ b/doc/Services.txt
@@ -9,12 +9,12 @@
                               -- 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/>)
+ - Anope 1.9.8 or later (<http://www.anope.org/>; unreleased!)
  - Atheme 7.0.2 or later (<http://www.atheme.net>)
  - "IRC Services" 5.1.x by Andrew Church (<http://achurch.org/services/>)
 
@@ -44,13 +44,21 @@ Example:
 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!
+Anope 1.9.8 or later (<http://www.anope.org/>; unreleased as of 2012-11-10)
+may be used with ngIRCd using the "ngircd" protocol module.
+Until Anope 1.9.8 is released, you have to use the sources from the Anope
+development GIT tree, see <http://sourceforge.net/projects/anope/develop/>!
 
-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
   {
@@ -59,10 +67,24 @@ 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
+
+	chanlen = 50
+  }
+
+In conf/nickserv.conf:
+
+  nickserv
   {
-	name = "services.irc.net"
-	type = "ngircd"
+	# not required if you are running ngIRCd with a higher nickname limit
+	# ("MaxNickLength") than 11 characters, but REQUIRED by default!
+	guestnickprefix = "G-"
   }