Debian: require "telnet" or "telnet-ssl" for building

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

diff --git a/doc/Services.txt b/doc/Services.txt
index 67053b16a93155e5315ca03e19fef9c709fd4f7a..944afd4807c87cd4dc366c810cf791fe689379c9 100644 (file)
--- a/doc/Services.txt
+++ b/doc/Services.txt
@@ -1,9 +1,8 @@
 
                      ngIRCd - Next Generation IRC Server
 
                      ngIRCd - Next Generation IRC Server

+                           http://ngircd.barton.de/

 
 

-                        (c)2001-2008 Alexander Barton,
-                    alex@barton.de, http://www.barton.de/
-
+               (c)2001-2011 Alexander Barton and Contributors.

                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 
                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 


@@ -14,9 +13,12 @@ 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.
 
 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 by Andrew Church,
-homepage: <http://www.ircservices.za.net/>. This document describes setting up
-ngIRCd and these services.
+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.
+
+This document describes setting up ngIRCd and these services.

 
 
 Setting up ngIRCd
 
 
 Setting up ngIRCd


@@ -36,6 +38,31 @@ Example:
      ServiceMask = *Serv
 
 
      ServiceMask = *Serv
 
 

+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!
+
+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:
+
+  uplink
+  {
+       host = "server.irc.net"
+       port = 6667
+       password = "123abc"
+  }
+
+  serverinfo
+  {
+       name = "services.irc.net"
+       type = "ngircd"
+  }
+
+

 Setting up IRC Services 5.1.x
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Setting up IRC Services 5.1.x
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 


@@ -66,5 +93,25 @@ In modules.conf:
 The documentation of IRC Services can be found here:
 <http://www.ircservices.za.net/docs/>
 
 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!
 Please let us know if you are successfully using other IRC service packages or
 which problems you encounter, thanks!