Add instructions for setting up Atheme.
authorWilliam Pitcock <nenolod@dereferenced.org>
Sun, 29 Apr 2012 17:36:10 +0000 (17:36 +0000)
committerAlexander Barton <alex@barton.de>
Sun, 29 Apr 2012 17:48:48 +0000 (19:48 +0200)
doc/Services.txt

index c2059b246a69a0009df69a710e1fcde3cb4e3443..944afd4807c87cd4dc366c810cf791fe689379c9 100644 (file)
@@ -14,8 +14,9 @@ But services acting as a "regular server" are supported, either using the IRC
 protocol 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/>), and a Anope 1.9 using a
-preliminary protocol module for ngIRCd (<http://www.anope.org/>).
+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.
 
@@ -93,5 +94,24 @@ 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!