2008-12-02 15:41:57 +01:00
|
|
|
|
|
|
|
ngIRCd - Next Generation IRC Server
|
2011-07-10 14:20:48 +02:00
|
|
|
http://ngircd.barton.de/
|
2008-12-02 15:41:57 +01:00
|
|
|
|
2011-07-10 14:20:48 +02:00
|
|
|
(c)2001-2011 Alexander Barton and Contributors.
|
2008-12-02 15:41:57 +01:00
|
|
|
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.
|
|
|
|
|
2011-07-10 14:20:48 +02:00
|
|
|
Support for Services has been tested using "IRC Services" version 5.x by
|
2012-04-29 19:36:10 +02:00
|
|
|
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.
|
2011-07-10 14:20:48 +02:00
|
|
|
|
|
|
|
This document describes setting up ngIRCd and these services.
|
2008-12-02 15:41:57 +01:00
|
|
|
|
|
|
|
|
|
|
|
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
|
2008-12-04 11:14:26 +01:00
|
|
|
services instead of regular IRC users.
|
2008-12-02 15:41:57 +01:00
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
[SERVER]
|
|
|
|
Name = services.irc.net
|
|
|
|
MyPassword = 123abc
|
|
|
|
PeerPassword = 123abc
|
|
|
|
ServiceMask = *Serv
|
|
|
|
|
|
|
|
|
2011-07-10 14:20:48 +02:00
|
|
|
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"
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2008-12-02 15:41:57 +01:00
|
|
|
Setting up IRC Services 5.1.x
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
2008-12-04 11:14:26 +01:00
|
|
|
IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
|
|
|
|
protocol module.
|
|
|
|
|
|
|
|
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>
|
|
|
|
|
|
|
|
At least the following settings have to be tweaked, in addition to all the
|
|
|
|
settings marked as required by IRC Services:
|
2008-12-02 15:41:57 +01:00
|
|
|
|
|
|
|
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/>
|
2008-12-04 11:14:26 +01:00
|
|
|
|
2011-07-10 14:20:48 +02:00
|
|
|
|
2012-04-29 19:36:10 +02:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
2008-12-04 11:14:26 +01:00
|
|
|
Please let us know if you are successfully using other IRC service packages or
|
|
|
|
which problems you encounter, thanks!
|