[ViewVC] Annotation of: cvs/cvsroot/ermyth/doc/IRCD

IRCD-specific notes
-------------------

asuka
-----

You need U:lines for services on all servers on the network.

You must enable join_chans as P10 is designed for services to work that way.

P10 does not support logout, so users are killed (from the services server)
when they log out. It is suggested that the logout module is not loaded.
Users dropping their account will be killed; this cannot be avoided.
Furthermore, Atheme assumes it is the only entity on the network sending
ACCOUNT messages.

Asuka's +N (no notices/wallchops) mode is turned off whenever a
notice/wallchops is to be sent to a channel (it should not block notices from
remotes or wallchops, really). If you want a channel to be +N always, leave
verbose disabled.

For host hiding (umode +x, <account>.<suffix>) to work, the hosthidesuffix
in serverinfo{} must be correct (same value as F:HIDDEN_HOST in ircd.conf).

SETHOST (umode +h [ident@]host) is supported. When changing the ident via +h,
atheme will not restore the ident on -h. This can be worked around by never
changing ident with +h, never doing -h or doing a +h with the original ident@
before -h.

bahamut
-------

You need U:lines/super{} entries for services on all servers on the network.

Bahamut is designed for services not joining channels, not having the ability
to prevent services being kicked/deopped and the like. If you want to use
fantasy commands, you will have to enable join_chans anyway; beware of bots
fighting with chanserv.

Do not use the "services hub" server type.

bircd
-----

You need U:lines for services on all servers on the network.

You must enable join_chans as P10 is designed for services to work that way.

P10 does not support logout, so users are killed (from the services server)
when they log out. It is suggested that the logout module is not loaded.
Users dropping their account will be killed; this cannot be avoided.
Furthermore, Atheme assumes it is the only entity on the network sending
ACCOUNT messages.

For host hiding (umode +x, <account>.<suffix>) to work, the hosthidesuffix
in serverinfo{} must be correct.

charybdis
---------

You will need a service{} block on all servers.

If you want to use akills, you need shared{} blocks for services on all servers
on the network.

Atheme supports both TS5 and TS6 protocol. It is recommended to use TS6
as it reduces ghosts/desyncs and propagates user IP addresses. Although
Atheme does not support IPv6 connections itself, user IPv6 addresses will
be properly stored and logged.

dreamforge
----------

You need U:lines for services on all servers on the network. If a server lacks
U:lines, a storm of mode changes may result.

Dreamforge is designed for services not joining channels, not having the
ability to prevent services being kicked/deopped and the like. If you want to
use fantasy commands, you will have to enable join_chans anyway; beware of bots
fighting with chanserv.

The TOPIC and TOPICAPPEND commands cannot be used to change topics as
dreamforge does not allow services to set newer topics. KEEPTOPIC and
TOPICLOCK can be used, however.

Dreamforge is a dated IRCd, you should probably upgrade to a more
modern one.

hyperion
--------

The channel mode +D is not supported and will be ignored. Bans with forward
channels will not be recognized properly. This may lead to problems like users
still being banned after a chanserv unban command.

There are two methods to allow services to remember users after a netsplit or
restart and to enable things like channels only accessible for registered
users. The traditional dancer method is umode +e; it only works if the user is
logged in to the nick they are currently using. The new hyperion method using
SVSLOGIN and SIGNON does not have this restriction. It also allows changing
nick/ident/host at the same time, but Atheme does not use that yet.
Consequently, NOIDPREFIX is not supported in a useful way.

Atheme will always set +e appropriately; if SVSLOGIN support is available, it
will be used (this assumes the whole network has it). SVSLOGIN support can
also be disabled with a simple source file change.

The wallops option will report via +s server notices.

Although Atheme does not support IPv6 connections itself, user IPv6 addresses
will be properly stored and logged.

inspircd
--------

You should use inspircd11 for inspircd 1.1.x. InspIRCd 1.0.x support 
(inspircd10) has been dropped.

You need <uline> tags for services on all servers on the network.

Several of the modes supported by Atheme are in optional modules. It should
usually not be a problem if those modules are not loaded. The exceptions to
this are the m_globops.so and m_services_account.so modules, which must be
loaded at all times on your inspircd servers if you wish to use this version of
atheme. If the servers are protocol 1102 or newer, m_globops.so is not
required, although it will be used if loaded.

The inspircd support is developed in cooperation with the inspircd
developers.

ircnet
------

Atheme links as a server (C:, N:, H: lines), not as a service. IRCnet-style
services cannot do enough (like manipulating channel modes).

Nick delay will lock any nicks killed, so /ns ghost is worthless; it is
probably best to use userserv instead of nickserv.

Only # channels are supported.

Tklines are used for /os akill but this only works on the server
Atheme is directly linked to.

It is recommended to enable join_chans, otherwise many things will be sent
from the server (possibly generating nasty server notices) or chanserv will
join and part to do the action. Alternatively, disable it and avoid commands
that cause Atheme to kick as much as possible.

Jupes will use SIDs numerically following services's SID, make sure to
leave plenty of space.

nefarious
---------

You need U:lines for services on all servers on the network.

You must enable join_chans as P10 is designed for services to work that way.

Atheme assumes it is the only entity on the network sending ACCOUNT messages.
Login-on-connect is not supported.

For host hiding (umode +x, <account>.<suffix>) to work, the hosthidesuffix
in serverinfo{} must be correct (same value as F:HIDDEN_HOST in ircd.conf).
Only F:HOST_HIDING_STYLE:1 (<account>.<suffix>) is supported,
F:HOST_HIDING_STYLE:2 (scrambled hostname/IP) is not.

SETHOST (umode +h [ident@]host) is supported. When changing the ident via +h,
atheme will not restore the ident on -h. This can be worked around by never
changing ident with +h, never doing -h or doing a +h with the original ident@
before -h.

Ban exceptions are supported, although some Nefarious versions have bugs where
they are not sent properly.

officeirc
---------

Unlike other IRCds, OfficeIRC server names do not necessarily have a period in
them; this may cause some warnings about the config file which can safely be
ignored.

plexus
------

PleXusIRCd 3 is the only version supported.

If you want services to function properly, you will need a shared { } 
block for services, without any usermask entries, tagged for services:

shared
{
     name = "services.int";
     type = all, services;
};

The above block should do the trick.

ptlink
------

Atheme's server name must match ServicesServer in network.dconf (on all
servers on the network).

The following options/features are not recommended: HideServerOnWhois (not
effective), SecureModes (Atheme does not set channels +r), RestrictedChans (not
implemented by Atheme), user mode +H (various bugs and tricks allow users to
see the oper status anyway), stealth mode (highly unethical and various bugs
and tricks allow users to get around it).

PTlink ircd allows services to do various special things like restarting the
server; write a module if you want to use those.

By default, Atheme assumes cmode +a (channel admin/protect, AdminWithDot in
network.dconf) and cmode +h (halfops, compile time option) are enabled. If
this is not the case, compile and load the ircd_noprotect and/or
ircd_nohalfops modules from contrib.

Although Atheme does not support IPv6 connections itself, user IPv6 addresses
will be properly stored and logged.

ratbox
------

If you want to use operserv kline, you need shared{} blocks or U:lines
for services on all servers on the network. Note that only hybrid 7.1
and ratbox support remote unkline, although it may appear to sort of
work in hybrid 7.0.

If you use ratbox 2.1.x or newer, it is recommended to compile with
ratbox-services support as this will allow remembering logged-in state
across netsplits and services restarts, prevent deopping/kicking chanserv,
etc. You will need a service{} block on all servers.

Hybrid 6.x or csircd should also work but they are not recommended; you
must leave join_chans enabled for full functionality.

Atheme supports both TS5 and TS6 protocol. It is recommended to use TS6
as it reduces ghosts/desyncs and propagates user IP addresses. Although
Atheme does not support IPv6 connections itself, user IPv6 addresses will
be properly stored and logged.

shadowircd
----------

Atheme does not support the "modern" ShadowIRCd protocol,
revisions 3400 and 4000. You will need to use compatibility mode
with Atheme. Proper care has been taken to ensure that Atheme
complies with all requirements necessary for compatibility mode.

Note that only ShadowIRCd 3.2 and later properly support the removal
of AKILLs, although it may appear to sort of work in earlier versions.

sorcery
-------

You need U:lines for services on all servers on the network. If a server lacks
U:lines, a storm of mode changes may result.

ircd-sor is designed for services not joining channels, not having the
ability to prevent services being kicked/deopped and the like. If you want to
use fantasy commands, you will have to enable join_chans anyway; beware of bots
fighting with chanserv.

The TOPIC and TOPICAPPEND commands cannot be used to change topics as
ircd-sor does not allow services to set newer topics. KEEPTOPIC and
TOPICLOCK can be used, however.

ultimate3
---------

You will need U:lines for services on all services on the network.

undernet
--------

You need U:lines for services on all servers on the network.

You must enable join_chans as P10 is designed for services to work that way.

P10 does not support logout, so users are killed (from the services server)
when they log out. It is suggested that the logout module is not loaded.
Users dropping their account will be killed; this cannot be avoided.
Furthermore, Atheme assumes it is the only entity on the network sending
ACCOUNT messages.

For host hiding (umode +x, <account>.<suffix>) to work, the hosthidesuffix
in serverinfo{} must be correct (same value as F:HIDDEN_HOST in ircd.conf).

Atheme does not support IPv6 (neither IPv6 connections nor IPv6 IPs in P10
protocol). IPs of IPv6 clients will not be stored or logged.

Atheme does not support oplevels; they should be disabled.

chanserv::changets can be used with ircu version 2.10.12.06 or newer; if any
server on the network is 2.10.11.x, netsplits will occur whenever Atheme tries
to lower TS.

unreal
------

You need ulines{} for services on all servers on the network. If a server lacks
U:lines, a storm of mode changes may result.
Revision:	1.2
Committed:	Thu Jul 19 12:35:04 2007 UTC (19 years, 2 months ago) by pippijn
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.1:	+0 -0 lines
State:	*FILE REMOVED*
Log Message:	convert documentation to POD and use this for the website
#	User	Rev	Content
1	pippijn	1.1	IRCD-specific notes
2			-------------------
3
4			asuka
5			-----
6
7			You need U:lines for services on all servers on the network.
8
9			You must enable join_chans as P10 is designed for services to work that way.
10
11			P10 does not support logout, so users are killed (from the services server)
12			when they log out. It is suggested that the logout module is not loaded.
13			Users dropping their account will be killed; this cannot be avoided.
14			Furthermore, Atheme assumes it is the only entity on the network sending
15			ACCOUNT messages.
16
17			Asuka's +N (no notices/wallchops) mode is turned off whenever a
18			notice/wallchops is to be sent to a channel (it should not block notices from
19			remotes or wallchops, really). If you want a channel to be +N always, leave
20			verbose disabled.
21
22			For host hiding (umode +x, <account>.<suffix>) to work, the hosthidesuffix
23			in serverinfo{} must be correct (same value as F:HIDDEN_HOST in ircd.conf).
24
25			SETHOST (umode +h [ident@]host) is supported. When changing the ident via +h,
26			atheme will not restore the ident on -h. This can be worked around by never
27			changing ident with +h, never doing -h or doing a +h with the original ident@
28			before -h.
29
30			bahamut
31			-------
32
33			You need U:lines/super{} entries for services on all servers on the network.
34
35			Bahamut is designed for services not joining channels, not having the ability
36			to prevent services being kicked/deopped and the like. If you want to use
37			fantasy commands, you will have to enable join_chans anyway; beware of bots
38			fighting with chanserv.
39
40			Do not use the "services hub" server type.
41
42			bircd
43			-----
44
45			You need U:lines for services on all servers on the network.
46
47			You must enable join_chans as P10 is designed for services to work that way.
48
49			P10 does not support logout, so users are killed (from the services server)
50			when they log out. It is suggested that the logout module is not loaded.
51			Users dropping their account will be killed; this cannot be avoided.
52			Furthermore, Atheme assumes it is the only entity on the network sending
53			ACCOUNT messages.
54
55			For host hiding (umode +x, <account>.<suffix>) to work, the hosthidesuffix
56			in serverinfo{} must be correct.
57
58			charybdis
59			---------
60
61			You will need a service{} block on all servers.
62
63			If you want to use akills, you need shared{} blocks for services on all servers
64			on the network.
65
66			Atheme supports both TS5 and TS6 protocol. It is recommended to use TS6
67			as it reduces ghosts/desyncs and propagates user IP addresses. Although
68			Atheme does not support IPv6 connections itself, user IPv6 addresses will
69			be properly stored and logged.
70
71			dreamforge
72			----------
73
74			You need U:lines for services on all servers on the network. If a server lacks
75			U:lines, a storm of mode changes may result.
76
77			Dreamforge is designed for services not joining channels, not having the
78			ability to prevent services being kicked/deopped and the like. If you want to
79			use fantasy commands, you will have to enable join_chans anyway; beware of bots
80			fighting with chanserv.
81
82			The TOPIC and TOPICAPPEND commands cannot be used to change topics as
83			dreamforge does not allow services to set newer topics. KEEPTOPIC and
84			TOPICLOCK can be used, however.
85
86			Dreamforge is a dated IRCd, you should probably upgrade to a more
87			modern one.
88
89			hyperion
90			--------
91
92			The channel mode +D is not supported and will be ignored. Bans with forward
93			channels will not be recognized properly. This may lead to problems like users
94			still being banned after a chanserv unban command.
95
96			There are two methods to allow services to remember users after a netsplit or
97			restart and to enable things like channels only accessible for registered
98			users. The traditional dancer method is umode +e; it only works if the user is
99			logged in to the nick they are currently using. The new hyperion method using
100			SVSLOGIN and SIGNON does not have this restriction. It also allows changing
101			nick/ident/host at the same time, but Atheme does not use that yet.
102			Consequently, NOIDPREFIX is not supported in a useful way.
103
104			Atheme will always set +e appropriately; if SVSLOGIN support is available, it
105			will be used (this assumes the whole network has it). SVSLOGIN support can
106			also be disabled with a simple source file change.
107
108			The wallops option will report via +s server notices.
109
110			Although Atheme does not support IPv6 connections itself, user IPv6 addresses
111			will be properly stored and logged.
112
113			inspircd
114			--------
115
116			You should use inspircd11 for inspircd 1.1.x. InspIRCd 1.0.x support
117			(inspircd10) has been dropped.
118
119			You need <uline> tags for services on all servers on the network.
120
121			Several of the modes supported by Atheme are in optional modules. It should
122			usually not be a problem if those modules are not loaded. The exceptions to
123			this are the m_globops.so and m_services_account.so modules, which must be
124			loaded at all times on your inspircd servers if you wish to use this version of
125			atheme. If the servers are protocol 1102 or newer, m_globops.so is not
126			required, although it will be used if loaded.
127
128			The inspircd support is developed in cooperation with the inspircd
129			developers.
130
131			ircnet
132			------
133
134			Atheme links as a server (C:, N:, H: lines), not as a service. IRCnet-style
135			services cannot do enough (like manipulating channel modes).
136
137			Nick delay will lock any nicks killed, so /ns ghost is worthless; it is
138			probably best to use userserv instead of nickserv.
139
140			Only # channels are supported.
141
142			Tklines are used for /os akill but this only works on the server
143			Atheme is directly linked to.
144
145			It is recommended to enable join_chans, otherwise many things will be sent
146			from the server (possibly generating nasty server notices) or chanserv will
147			join and part to do the action. Alternatively, disable it and avoid commands
148			that cause Atheme to kick as much as possible.
149
150			Jupes will use SIDs numerically following services's SID, make sure to
151			leave plenty of space.
152
153			nefarious
154			---------
155
156			You need U:lines for services on all servers on the network.
157
158			You must enable join_chans as P10 is designed for services to work that way.
159
160			Atheme assumes it is the only entity on the network sending ACCOUNT messages.
161			Login-on-connect is not supported.
162
163			For host hiding (umode +x, <account>.<suffix>) to work, the hosthidesuffix
164			in serverinfo{} must be correct (same value as F:HIDDEN_HOST in ircd.conf).
165			Only F:HOST_HIDING_STYLE:1 (<account>.<suffix>) is supported,
166			F:HOST_HIDING_STYLE:2 (scrambled hostname/IP) is not.
167
168			SETHOST (umode +h [ident@]host) is supported. When changing the ident via +h,
169			atheme will not restore the ident on -h. This can be worked around by never
170			changing ident with +h, never doing -h or doing a +h with the original ident@
171			before -h.
172
173			Ban exceptions are supported, although some Nefarious versions have bugs where
174			they are not sent properly.
175
176			officeirc
177			---------
178
179			Unlike other IRCds, OfficeIRC server names do not necessarily have a period in
180			them; this may cause some warnings about the config file which can safely be
181			ignored.
182
183			plexus
184			------
185
186			PleXusIRCd 3 is the only version supported.
187
188			If you want services to function properly, you will need a shared { }
189			block for services, without any usermask entries, tagged for services:
190
191			shared
192			{
193			name = "services.int";
194			type = all, services;
195			};
196
197			The above block should do the trick.
198
199			ptlink
200			------
201
202			Atheme's server name must match ServicesServer in network.dconf (on all
203			servers on the network).
204
205			The following options/features are not recommended: HideServerOnWhois (not
206			effective), SecureModes (Atheme does not set channels +r), RestrictedChans (not
207			implemented by Atheme), user mode +H (various bugs and tricks allow users to
208			see the oper status anyway), stealth mode (highly unethical and various bugs
209			and tricks allow users to get around it).
210
211			PTlink ircd allows services to do various special things like restarting the
212			server; write a module if you want to use those.
213
214			By default, Atheme assumes cmode +a (channel admin/protect, AdminWithDot in
215			network.dconf) and cmode +h (halfops, compile time option) are enabled. If
216			this is not the case, compile and load the ircd_noprotect and/or
217			ircd_nohalfops modules from contrib.
218
219			Although Atheme does not support IPv6 connections itself, user IPv6 addresses
220			will be properly stored and logged.
221
222			ratbox
223			------
224
225			If you want to use operserv kline, you need shared{} blocks or U:lines
226			for services on all servers on the network. Note that only hybrid 7.1
227			and ratbox support remote unkline, although it may appear to sort of
228			work in hybrid 7.0.
229
230			If you use ratbox 2.1.x or newer, it is recommended to compile with
231			ratbox-services support as this will allow remembering logged-in state
232			across netsplits and services restarts, prevent deopping/kicking chanserv,
233			etc. You will need a service{} block on all servers.
234
235			Hybrid 6.x or csircd should also work but they are not recommended; you
236			must leave join_chans enabled for full functionality.
237
238			Atheme supports both TS5 and TS6 protocol. It is recommended to use TS6
239			as it reduces ghosts/desyncs and propagates user IP addresses. Although
240			Atheme does not support IPv6 connections itself, user IPv6 addresses will
241			be properly stored and logged.
242
243			shadowircd
244			----------
245
246			Atheme does not support the "modern" ShadowIRCd protocol,
247			revisions 3400 and 4000. You will need to use compatibility mode
248			with Atheme. Proper care has been taken to ensure that Atheme
249			complies with all requirements necessary for compatibility mode.
250
251			Note that only ShadowIRCd 3.2 and later properly support the removal
252			of AKILLs, although it may appear to sort of work in earlier versions.
253
254			sorcery
255			-------
256
257			You need U:lines for services on all servers on the network. If a server lacks
258			U:lines, a storm of mode changes may result.
259
260			ircd-sor is designed for services not joining channels, not having the
261			ability to prevent services being kicked/deopped and the like. If you want to
262			use fantasy commands, you will have to enable join_chans anyway; beware of bots
263			fighting with chanserv.
264
265			The TOPIC and TOPICAPPEND commands cannot be used to change topics as
266			ircd-sor does not allow services to set newer topics. KEEPTOPIC and
267			TOPICLOCK can be used, however.
268
269			ultimate3
270			---------
271
272			You will need U:lines for services on all services on the network.
273
274			undernet
275			--------
276
277			You need U:lines for services on all servers on the network.
278
279			You must enable join_chans as P10 is designed for services to work that way.
280
281			P10 does not support logout, so users are killed (from the services server)
282			when they log out. It is suggested that the logout module is not loaded.
283			Users dropping their account will be killed; this cannot be avoided.
284			Furthermore, Atheme assumes it is the only entity on the network sending
285			ACCOUNT messages.
286
287			For host hiding (umode +x, <account>.<suffix>) to work, the hosthidesuffix
288			in serverinfo{} must be correct (same value as F:HIDDEN_HOST in ircd.conf).
289
290			Atheme does not support IPv6 (neither IPv6 connections nor IPv6 IPs in P10
291			protocol). IPs of IPv6 clients will not be stored or logged.
292
293			Atheme does not support oplevels; they should be disabled.
294
295			chanserv::changets can be used with ircu version 2.10.12.06 or newer; if any
296			server on the network is 2.10.11.x, netsplits will occur whenever Atheme tries
297			to lower TS.
298
299			unreal
300			------
301
302			You need ulines{} for services on all servers on the network. If a server lacks
303			U:lines, a storm of mode changes may result.