doc/Services.txt: document using ngIRCd with IRC Services.

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 394c89b0e5fded42fffeb734efe4f7a3a9197ada..eba97d9e5df08dad06af96c6d903473ec6a35ac3 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,6 +1,6 @@
 #
 # ngIRCd -- The Next Generation IRC Daemon
-# Copyright (c)2001-2008 by Alexander Barton (alex@barton.de)
+# Copyright (c)2001-2008 Alexander Barton (alex@barton.de)
 #
 # Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
 # der GNU General Public License (GPL), wie von der Free Software Foundation
@@ -13,7 +13,8 @@
 SUBDIRS = src
 
 EXTRA_DIST = FAQ.txt GIT.txt Protocol.txt Platforms.txt README-AUX.txt \
-       README-BeOS.txt RFC.txt SSL.txt Zeroconf.txt sample-ngircd.conf
+       README-BeOS.txt RFC.txt Services.txt SSL.txt Zeroconf.txt \
+       sample-ngircd.conf
 
 maintainer-clean-local:
        rm -f Makefile Makefile.in

diff --git a/doc/Services.txt b/doc/Services.txt
new file mode 100644 (file)
index 0000000..a16cfc8
--- /dev/null
+++ b/doc/Services.txt
@@ -0,0 +1,59 @@
+
+                     ngIRCd - Next Generation IRC Server
+
+                        (c)2001-2008 Alexander Barton,
+                    alex@barton.de, http://www.barton.de/
+
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
+
+                              -- 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.
+
+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.
+
+
+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.
+
+Example:
+
+  [SERVER]
+     Name = services.irc.net
+     MyPassword = 123abc
+     PeerPassword = 123abc
+     ServiceMask = *Serv
+
+
+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:
+
+In ircservices.conf:
+
+  Variable             Example value
+
+  RemoteServer         server.irc.net 6667 "123abc"
+  ServerName           "services.irc.net"
+  LoadModule           protocol/rfc1459
+
+In modules.conf:
+
+  Module               protocol/rfc1459
+
+The documentation of IRC Services can be found here:
+<http://www.ircservices.za.net/docs/>