002
2008-12-02
alex
ngIRCd - Next Generation IRC Server
003
2011-07-10
alex
http://ngircd.barton.de/
005
2011-07-10
alex
(c)2001-2011 Alexander Barton and Contributors.
006
2008-12-02
alex
ngIRCd is free software and published under the
007
2008-12-02
alex
terms of the GNU General Public License.
009
2008-12-02
alex
-- Services.txt --
012
2012-11-10
alex
ngIRCd doesn't implement a "special IRC services interface", but services
013
2012-11-10
alex
acting as a "regular servers" ("pseudo servers") are supported, either
014
2012-11-10
alex
using the IRC protocol as defined in RFC 1459 or RFC 2812.
016
2012-11-04
alex
Support for Services has been tested using
017
2013-03-13
alex
- Anope 1.9.8 or later (<http://www.anope.org/>)
018
2020-08-04
alex
- Atheme 7.0.2 or later (<https://atheme.org/>)
019
2012-11-04
alex
- "IRC Services" 5.1.x by Andrew Church (<http://achurch.org/services/>)
021
2011-07-10
alex
This document describes setting up ngIRCd and these services.
023
2012-11-04
alex
Please let us know if you are successfully using other IRC service packages or
024
2012-11-04
alex
which problems you encounter -- thanks!
027
2008-12-02
alex
Setting up ngIRCd
028
2008-12-02
alex
~~~~~~~~~~~~~~~~~
030
2008-12-02
alex
The "pseudo server" handling the IRC services is configured as a regular
031
2008-12-02
alex
remote server in the ngircd.conf(5). In addition the variable "ServiceMask"
032
2008-12-02
alex
should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC
033
2008-12-04
alex
services instead of regular IRC users.
035
2008-12-02
alex
Example:
037
2017-02-20
alex
[GLOBAL]
038
2017-02-20
alex
Name = server.irc.net
039
2017-02-20
alex
Ports = 6667
041
2008-12-02
alex
[SERVER]
042
2008-12-02
alex
Name = services.irc.net
043
2008-12-02
alex
MyPassword = 123abc
044
2008-12-02
alex
PeerPassword = 123abc
045
2008-12-02
alex
ServiceMask = *Serv
048
2014-02-02
alex
Setting up Anope 1.9.x & 2.x
049
2014-02-02
alex
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
051
2013-03-13
alex
Anope 1.9.8 or later (<http://www.anope.org/>) can be used with ngIRCd using
052
2013-03-13
alex
the "ngircd" protocol module.
054
2012-11-10
alex
At least the following settings have to be tweaked, in addition to all the
055
2012-11-10
alex
settings marked as required by Anope:
057
2012-11-10
alex
In conf/services.conf:
061
2012-11-10
alex
name = "services.host"
062
2012-11-10
alex
value = "services.irc.net"
067
2011-07-10
alex
host = "server.irc.net"
068
2011-07-10
alex
port = 6667
069
2011-07-10
alex
password = "123abc"
072
2012-11-10
alex
# Load ngIRCd protocol module
075
2014-02-02
alex
name = "ngircd"
078
2012-11-10
alex
networkinfo
080
2012-11-10
alex
# Must be set to the "MaxNickLength" setting of ngIRCd!
081
2012-11-10
alex
nicklen = 9
083
2014-02-02
alex
# When not using "strict mode", which is the default:
084
2014-02-02
alex
userlen = 20
086
2012-11-10
alex
chanlen = 50
089
2012-11-10
alex
In conf/nickserv.conf:
093
2014-02-02
alex
name = "nickserv"
095
2012-11-10
alex
# not required if you are running ngIRCd with a higher nickname limit
096
2012-11-10
alex
# ("MaxNickLength") than 11 characters, but REQUIRED by default!
097
2012-11-10
alex
guestnickprefix = "G-"
101
2012-11-04
alex
Setting up Atheme 7.0.2 or later
102
2012-11-04
alex
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
2020-08-04
alex
Atheme 7.0.2 or later (<https://atheme.org/>) may be used with ngIRCd using
105
2012-11-04
alex
the "ngircd" protocol module.
107
2012-11-04
alex
The following settings need to be in atheme.conf:
109
2012-11-04
alex
loadmodule "modules/protocol/ngircd";
111
2017-02-20
alex
serverinfo {
112
2017-02-20
alex
name = "services.irc.net";
115
2012-11-04
alex
uplink "server.irc.net" {
116
2012-11-04
alex
password = "123abc";
117
2012-11-04
alex
port = 6667;
120
2012-11-04
alex
The documentation of Atheme can be found in the doc/ directory of the
121
2012-11-04
alex
Atheme source distribution.
124
2008-12-02
alex
Setting up IRC Services 5.1.x
125
2008-12-02
alex
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127
2008-12-04
alex
IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
128
2008-12-04
alex
protocol module.
130
2008-12-04
alex
Please note that versions up to and including 5.1.3 contain a bug that
131
2008-12-04
alex
sometimes causes IRC Services to hang on startup. There are two workarounds:
132
2008-12-04
alex
a) send the services process a HUP signal ("killall -HUP ircservices")
133
2008-12-04
alex
b) apply this patch to the IRC Services source tree:
134
2014-03-25
alex
<http://arthur.barton.de/pub/ngircd/contrib/IRCServices513-FlushBuffer.patch>
136
2008-12-04
alex
At least the following settings have to be tweaked, in addition to all the
137
2008-12-04
alex
settings marked as required by IRC Services:
139
2008-12-02
alex
In ircservices.conf:
141
2008-12-02
alex
Variable Example value
143
2008-12-02
alex
RemoteServer server.irc.net 6667 "123abc"
144
2008-12-02
alex
ServerName "services.irc.net"
145
2008-12-02
alex
LoadModule protocol/rfc1459
147
2008-12-02
alex
In modules.conf:
149
2008-12-02
alex
Module protocol/rfc1459
151
2008-12-02
alex
The documentation of IRC Services can be found here:
152
2008-12-02
alex
<http://www.ircservices.za.net/docs/>