]> jfr.im git - solanum.git/blame - doc/reference.conf
Fix possible crash with m_mkpasswd extension.
[solanum.git] / doc / reference.conf
CommitLineData
212380e3
AC
1/* doc/reference.conf - charybdis Example configuration file
2 *
3 * Copyright (C) 2000-2002 Hybrid Development Team
4 * Copyright (C) 2002-2005 ircd-ratbox development team
5 * Copyright (C) 2005-2006 charybdis development team
6 *
7 * Written by ejb, wcampbel, db, leeh and others
8 *
407b1826 9 * $Id: reference.conf 3582 2007-11-17 21:55:48Z jilles $
212380e3
AC
10 */
11
12/* IMPORTANT NOTES:
13 *
14 * class {} blocks MUST be specified before anything that uses them. That
15 * means they must be defined before auth {} and before connect {}.
16 *
17 * auth {} blocks MUST be specified in order of precedence. The first one
18 * that matches a user will be used. So place spoofs first, then specials,
19 * then general access, then restricted.
20 *
21 * Both shell style (#) and C style comments are supported.
22 *
23 * Files may be included by either:
24 * .include "filename"
25 * .include <filename>
26 *
27 * Times/durations are written as:
28 * 12 hours 30 minutes 1 second
29 *
30 * Valid units of time:
31 * month, week, day, hour, minute, second
32 *
33 * Valid units of size:
34 * megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
35 *
36 * Sizes and times may be singular or plural.
37 */
38
39/* Extensions:
40 *
41 * Charybdis contains several extensions that are not enabled by default.
42 * To use them, uncomment the lines below.
43 *
67e6f4df
VY
44 * Channel mode +-A (admin only) -- chm_adminonly.so
45 * Channel mode +-O (oper only) -- chm_operonly.so
46 * Channel mode +-S (ssl only) -- chm_sslonly.so
dbbe26fa
VY
47 * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat.so
48 * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat.so
49 * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat.so
50 * Restrict channel creation to logged in users -- createauthonly.so
51 * Account bans (+b $a[:mask]) -- extb_account.so
52 * Banned from another channel (+b $j:mask) -- extb_canjoin.so
53 * Other-channel bans (+b $c:mask) -- extb_channel.so
54 * Extended ban (+b $x:mask) -- extb_extgecos.so
55 * Oper bans (+b $o) -- extb_oper.so
56 * Realname (gecos) bans (+b $r:mask) -- extb_realname.so
57 * Server bans (+b $s:mask) -- extb_server.so
58 * SSL bans (+b $z) -- extb_ssl.so
59 * HURT system -- hurt.so
60 * Host mangling (umode +h) -- ip_cloaking.so
61 * Find channel forwards -- m_findforwards.so
62 * /identify support -- m_identify.so
63 * Opers cannot be invisible (umode +i) -- no_oper_invis.so
64 * Far connection notices (snomask +F) -- sno_farconnect.so
bf870ceb 65 * Remote k/d/x line active notices -- sno_globalkline.so
dbbe26fa
VY
66 * Remote oper up notices -- sno_globaloper.so
67 * /whois notifications (snomask +W) -- sno_whois.so
212380e3 68 */
67e6f4df
VY
69#loadmodule "extensions/chm_adminonly.so";
70#loadmodule "extensions/chm_operonly.so";
71#loadmodule "extensions/chm_sslonly.so";
dbbe26fa
VY
72#loadmodule "extensions/chm_operonly_compat.so";
73#loadmodule "extensions/chm_quietunreg_compat.so";
74#loadmodule "extensions/chm_sslonly_compat.so";
212380e3
AC
75#loadmodule "extensions/createauthonly.so";
76#loadmodule "extensions/extb_account.so";
77#loadmodule "extensions/extb_canjoin.so";
78#loadmodule "extensions/extb_channel.so";
79#loadmodule "extensions/extb_extgecos.so";
80#loadmodule "extensions/extb_oper.so";
81#loadmodule "extensions/extb_realname.so";
82#loadmodule "extensions/extb_server.so";
dbbe26fa 83#loadmodule "extensions/extb_ssl.so";
212380e3
AC
84#loadmodule "extensions/hurt.so";
85#loadmodule "extensions/ip_cloaking.so";
86#loadmodule "extensions/m_findforwards.so";
87#loadmodule "extensions/m_identify.so";
88#loadmodule "extensions/no_oper_invis.so";
89#loadmodule "extensions/sno_farconnect.so";
90#loadmodule "extensions/sno_globalkline.so";
91#loadmodule "extensions/sno_globaloper.so";
446d88dd 92#loadmodule "extensions/sno_whois.so";
212380e3
AC
93
94/* serverinfo {}: Contains information about the server. (OLD M:) */
95serverinfo {
96 /* name: the name of our server */
97 name = "hades.arpa";
98
212380e3
AC
99 /* sid: the unique server id of our server. This must be three
100 * characters long. The first character must be a digit [0-9], the
101 * remaining two chars may be letters [A-Z] or digits [0-9].
102 *
cda8e9b8 103 * This parameter must be specified for the server to start.
212380e3
AC
104 */
105 sid = "42X";
106
107 /* description: the description of our server. '[' and ']' may not
108 * be used here for compatibility with older servers.
109 */
110 description = "charybdis test server";
111
112 /* network info: the name and description of the network this server
113 * is on. Shown in the 005 reply and used with serverhiding.
114 */
115 network_name = "MyNet";
116 network_desc = "This is My Network";
117
118 /* hub: allow this server to act as a hub and have multiple servers
119 * connected to it.
120 */
121 hub = no;
122
123 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
124 * This should be an ipv4 IP only.
125 */
126 #vhost = "192.169.0.1";
127
128 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
129 * This should be an ipv6 IP only.
130 */
131 #vhost6 = "3ffe:80e8:546::2";
c6d72037 132
b8730cbf
VY
133 /* ssl_private_key: our ssl private key */
134 ssl_private_key = "etc/test.key";
135
136 /* ssl_cert: certificate for our ssl server */
137 ssl_cert = "etc/test.cert";
138
139 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
140 ssl_dh_params = "etc/dh.pem";
141
142 /* ssld_count: number of ssld processes you want to start, if you have a really busy
143 * server, using N-1 where N is the number of cpu/cpu cores you have might be useful
144 */
145 ssld_count = 1;
146
147 /* default max clients: the default maximum number of clients
148 * allowed to connect. This can be changed once ircd has started by
149 * issuing:
150 * /quote set maxclients <limit>
c2d96fcb 151 */
101db4c4 152 default_max_clients = 1024;
212380e3
AC
153};
154
155/* admin {}: contains admin information about the server. (OLD A:) */
156admin {
157 name = "Smurf target";
158 description = "Main Server Administrator";
159 email = "<syn@packets.r.us>";
160};
161
162/* log {}: contains information about logfiles. */
163log {
164 /* logfiles: the logfiles to use for specific activity. if these
165 * paths are defined, then ircd will log to them, otherwise it wont.
166 *
167 * The confs are, in order:
168 * - userlog: user exits
169 * - fuserlog: failed user connections
170 * - operlog: /oper usage
171 * - foperlog: failed /oper usage
172 * - serverlog: server connects/disconnects
212380e3
AC
173 * - klinelog: klines, etc
174 * - killlog: kills
175 * - operspylog: operspy usage
176 * - ioerrorlog: IO errors
177 */
178 fname_userlog = "logs/userlog";
179 #fname_fuserlog = "logs/fuserlog";
180 fname_operlog = "logs/operlog";
181 #fname_foperlog = "logs/foperlog";
182 fname_serverlog = "logs/serverlog";
212380e3
AC
183 #fname_klinelog = "logs/klinelog";
184 fname_killlog = "logs/killlog";
185 fname_operspylog = "logs/operspylog";
186 #fname_ioerrorlog = "logs/ioerror";
187};
188
189/* class {}: contain information about classes for users (OLD Y:) */
190class "users" {
191 /* class name must go above */
192
193 /* ping time: how often a client must reply to a PING from the
194 * server before they are dropped.
195 */
196 ping_time = 2 minutes;
197
198 /* number per ident: the number of users per user@host networkwide
199 * allowed to connect. Unidented connections are classified as
200 * the same ident.
201 */
202 number_per_ident = 2;
203
204 /* number per ip: the number of local users per host allowed */
205 number_per_ip = 3;
206
207 /* number per ip global: the number of network wide connections
208 * per host allowed for a user, including connections to the
209 * local server.
210 */
211 number_per_ip_global = 5;
212
213 /* cidr_bitlen: Limits numbers of connections from a subnet size
214 * the following example makes the subnet /64 this is useful
215 * for IPv6 connections in particular
216 * Also note that the way charybdis is written if you have
217 * compiled support for IPv6, IPv4 cidr bitlens need to be modified
218 * Basically to get the approriate length add 96 to the IPv4 length
219 * For example for a /24 do 96+24 = 120
220 *
221 */
222 cidr_bitlen = 64;
223
224 /* number_per_cidr: Number of connections to allow from a subnet of the
225 * size given in cidr_bitlen. 4 seems to be a good default to me.
226 */
227 number_per_cidr = 4;
228
229 /* max number: the maximum number of users allowed in this class */
230 max_number = 100;
231
232 /* sendq: the amount of data allowed in a clients queue before
233 * they are dropped.
234 */
235 sendq = 100 kbytes;
236};
237
238class "restricted" {
239 ping_time = 1 minute 30 seconds;
240 number_per_ip = 1;
241 max_number = 100;
242 sendq = 60kb;
243};
244
245class "opers" {
246 ping_time = 5 minutes;
247 number_per_ip = 10;
248 max_number = 100;
249 sendq = 100kbytes;
250};
251
252class "server" {
253 ping_time = 5 minutes;
254
255 /* connectfreq: only used in server classes. specifies the delay
256 * between autoconnecting to servers.
257 */
258 connectfreq = 5 minutes;
259
260 /* max number: the amount of servers to autoconnect to */
261 max_number = 1;
262
263 /* sendq: servers need a higher sendq as they are sent more data */
264 sendq=2 megabytes;
265};
266
267/* listen {}: contain information about the ports ircd listens on (OLD P:) */
268listen {
269 /* port: the specific port to listen on. if no host is specified
270 * before, it will listen on all available IPs.
271 *
b8730cbf
VY
272 * sslport: the specific port to listen ssl connections on. if no
273 * host is specified before, it will listen on all available IPs.
274 *
212380e3
AC
275 * ports are seperated via a comma, a range may be specified using ".."
276 */
277
278 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
279 port = 5000, 6665 .. 6669;
b8730cbf
VY
280
281 /* sslport: listen for ssl connections on all available IPs, port 9999 */
282 sslport = 9999;
212380e3
AC
283
284 /* host: set a specific IP/host the ports after the line will listen
285 * on. This may be ipv4 or ipv6.
286 */
287 host = "1.2.3.4";
288 port = 7000, 7001;
b8730cbf 289 sslport = 9000, 9001;
212380e3
AC
290
291 host = "3ffe:1234:a:b:c::d";
292 port = 7002;
b8730cbf 293 sslport = 9002;
212380e3
AC
294};
295
296/* auth {}: allow users to connect to the ircd (OLD I:) */
297auth {
b0dc8e03
JT
298 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
299 * lines are permitted per auth block. This is matched against the
300 * hostname and IP address (using :: shortening for IPv6 and
301 * prepending a 0 if it starts with a colon) and can also use CIDR
302 * masks.
212380e3
AC
303 */
304 user = "*@172.16.0.0/12";
305 user = "*test@123D:B567:*";
306
307 /* password: an optional password that is required to use this block.
308 * By default this is not encrypted, specify the flag "encrypted" in
309 * flags = ...; below if it is.
310 */
311 password = "letmein";
312
313 /* spoof: fake the users user@host to be be this. You may either
314 * specify a host or a user@host to spoof to. This is free-form,
315 * just do everyone a favour and dont abuse it. (OLD I: = flag)
316 */
317 spoof = "I.still.hate.packets";
318
319 /* Possible flags in auth:
320 *
321 * encrypted | password is encrypted with mkpasswd
322 * spoof_notice | give a notice when spoofing hosts
323 * exceed_limit (old > flag) | allow user to exceed class user limits
324 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
325 * dnsbl_exempt | exempt this user from dnsbls
212380e3
AC
326 * spambot_exempt | exempt this user from spambot checks
327 * shide_exempt | exempt this user from serverhiding
328 * jupe_exempt | exempt this user from generating
329 * warnings joining juped channels
330 * resv_exempt | exempt this user from resvs
331 * flood_exempt | exempt this user from flood limits
332 * USE WITH CAUTION.
333 * no_tilde (old - flag) | don't prefix ~ to username if no ident
334 * need_ident (old + flag) | require ident for user in this class
335 * need_sasl | require SASL id for user in this class
336 */
337 flags = kline_exempt, exceed_limit;
338
339 /* class: the class the user is placed in */
340 class = "opers";
341};
342
343auth {
344 /* redirect: the server and port to redirect a user to. A user does
345 * not have to obey the redirection, the ircd just suggests to them
346 * an alternative server.
347 */
348 redirserv = "irc.some.domain";
349 redirport = 6667;
350
351 user = "*.some.domain";
352
353 /* class: a class is required even though it is not used */
354 class = "users";
355};
356
357auth {
358 user = "*@*";
359 class = "users";
360
361 flags = need_ident;
362};
363
364/* operator {}: defines ircd operators. (OLD O:)
365 * charybdis no longer supports local operators, privileges are
366 * controlled via flags.
367 */
368operator "god" {
369 /* name: the name of the oper must go above */
370
371 /* user: the user@host required for this operator. CIDR *is*
372 * supported now. auth{} spoofs work here, other spoofs do not.
373 * multiple user="" lines are supported.
374 */
375 user = "*god@*";
376 user = "*@127.0.0.1";
377
378 /* password: the password required to oper. Unless ~encrypted is
379 * contained in flags = ...; this will need to be encrypted using
380 * mkpasswd, MD5 is supported
381 */
382 password = "etcnjl8juSU1E";
383
384 /* rsa key: the public key for this oper when using Challenge.
385 * A password should not be defined when this is used, see
386 * doc/challenge.txt for more information.
387 */
388 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
389
390 /* umodes: the specific umodes this oper gets when they oper.
391 * If this is specified an oper will not be given oper_umodes
392 * These are described above oper_only_umodes in general {};
393 */
394 #umodes = locops, servnotice, operwall, wallop;
395
396 /* snomask: specific server notice mask on oper up.
397 * If this is specified an oper will not be given oper_snomask.
398 */
399 snomask = "+Zbfkrsuy";
400
401 /* privileges: controls the activities and commands an oper is
402 * allowed to do on the server. You may prefix an option with ~ to
403 * disable it, ie ~operwall
404 *
405 * Default flags are operwall, remoteban and encrypted.
406 *
407 * Available options:
408 *
409 * encrypted: the password above is encrypted [DEFAULT]
410 * local_kill: allows local users to be /KILL'd
411 * global_kill: allows local and remote users to be
412 * /KILL'd (OLD 'O' flag)
413 * remote: allows remote SQUIT and CONNECT (OLD 'R' flag)
407b1826 414 * kline: allows KLINE and DLINE (OLD 'K' flag)
212380e3 415 * unkline: allows UNKLINE and UNDLINE (OLD 'U' flag)
212380e3 416 * nick_changes: allows oper to see nickchanges (OLD 'N' flag)
407b1826 417 * via snomask +n
212380e3
AC
418 * rehash: allows oper to REHASH config (OLD 'H' flag)
419 * die: allows DIE and RESTART (OLD 'D' flag)
420 * admin: gives admin privileges. admins
421 * may (un)load modules and see the
422 * real IPs of servers.
423 * hidden_admin: gives admin privileges except
424 * will not have the admin lines in
425 * stats p and whois.
426 * xline: allows use of /quote xline/unxline
1ef5b430 427 * resv: allows /quote resv/unresv and cmode +LP [DEFAULT]
407b1826 428 * operwall: allows the oper to send/receive operwalls [DEFAULT]
212380e3
AC
429 * oper_spy: allows 'operspy' features to see through +s
430 * channels etc. see /quote help operspy
431 * hidden_oper: hides the oper from /stats p (OLD UMODE +p)
432 * remoteban: allows remote kline etc [DEFAULT]
a6f4368b 433 * mass_notice: allows sending wallops and mass notices [DEFAULT]
212380e3 434 */
170703fe 435 flags = global_kill, remote, kline, unkline,
212380e3
AC
436 die, rehash, admin, xline, operwall;
437};
438
439/* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
440connect "irc.uplink.com" {
441 /* the name must go above */
442
443 /* host: the host or IP to connect to. If a hostname is used it
444 * must match the reverse dns of the server.
445 */
446 host = "192.168.0.1";
447
448 /* vhost: the host or IP to bind to for this connection. If this
449 * is not specified, the default vhost (in serverinfo {}) is used.
450 */
451 #vhost = "192.168.0.50";
452
453 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
454 * The remote server will have these passwords reversed.
455 */
456 send_password = "password";
457 accept_password = "anotherpassword";
458
459 /* port: the port to connect to this server on */
460 port = 6666;
461
462 /* hub mask: the mask of servers that this server may hub. Multiple
463 * entries are permitted
464 */
465 hub_mask = "*";
466
467 /* leaf mask: the mask of servers this server may not hub. Multiple
468 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
469 */
470 #leaf_mask = "*.uk";
471
472 /* class: the class this server is in */
473 class = "server";
474
475 /* flags: controls special options for this server
476 * encrypted - marks the accept_password as being crypt()'d
477 * autoconn - automatically connect to this server
478 * compressed - compress traffic via ziplinks
479 * topicburst - burst topics between servers
b8730cbf 480 * ssl - ssl/tls encrypted server connections
212380e3
AC
481 */
482 flags = compressed, topicburst;
483};
484
485connect "ipv6.some.server" {
b0dc8e03
JT
486 /* Hosts that are IPv6 addresses must be in :: shortened form
487 * if applicable. Addresses starting with a colon get an extra
488 * zero prepended, for example: 0::1
489 */
212380e3
AC
490 host = "3ffd:dead:beef::1";
491 send_password = "password";
492 accept_password = "password";
493 port = 6666;
494
495 /* aftype: controls whether the connection uses "ipv4" or "ipv6".
496 * Default is ipv4.
497 */
498 aftype = ipv6;
499 class = "server";
500};
501
b8730cbf
VY
502connect "ssl.uplink.com" {
503 /* Example of ssl server-to-server connection, ssl flag doesn't need
504 * compressed flag, 'cause it uses own compression
505 */
506 host = "192.168.0.1";
507 send_password = "password";
508 accept_password = "anotherpassword";
509 port = 9999;
510 hub_mask = "*";
511 class = "server";
512 flags = ssl, topicburst;
513};
514
212380e3
AC
515/* cluster {}; servers that we propagate things to automatically.
516 * NOTE: This does NOT grant them privileges to apply anything locally,
517 * you must add a seperate shared block for that. Clustering will
518 * only be done for actions by LOCAL opers, that arent directed
519 * remotely.
520 */
521cluster {
522 /* name: the server to share with, this can be a wildcard and may be
523 * stacked.
524 */
525 /* flags: list of what to share, all the name lines above this (up
526 * until another flags entry) will receive these flags.
527 *
528 * kline - share perm klines
529 * tkline - share temp klines
530 * unkline - share unklines
531 * locops - share locops
532 * xline - share perm xlines
533 * txline - share temp xlines
534 * unxline - share unxlines
535 * resv - share perm resvs
536 * tresv - share temp resvs
537 * unresv - share unresvs
538 * all - share all of the above
539 */
540
541 /* share klines/unklines/xlines with *.lan */
542 name = "*.lan";
543 flags = kline, unkline, xline;
544
545 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
546 name = "irc.ircd-ratbox.org";
547 name = "ircd.ircd-ratbox.org";
548 flags = locops;
549};
550
551/* service{}: privileged servers (services). These servers have extra
552 * privileges such as setting login names on users and introducing clients
553 * with umode +S (unkickable, hide channels, etc). This does not allow them
554 * to set bans, you need a separate shared{} for that.
555 * Do not place normal servers here.
556 * There may be only one service{} block.
557 */
558service {
559 /* name: the server name. These may be stacked. */
560 name = "services.int";
561};
562
563/* shared {}: users that are allowed to place remote bans on our server.
564 * NOTE: These are ordered top down. The first one the user@host and server
565 * matches will be used. Their access will then be decided on that
566 * block and will not fall back to another block that matches.
567 */
568shared {
569 /* oper: the user@host and server the user must be on to set klines.
570 * The first field must be a user@host, the second field is an
571 * optional server. These may be stacked.
572 */
573 /* flags: list of what to allow them to place, all the oper lines
574 * above this (up until another flags entry) will receive these
575 * flags. This *must* be present.
576 *
577 * kline - allow setting perm/temp klines
578 * tkline - allow setting temp klines
579 * unkline - allow removing klines
580 * xline - allow setting perm/temp xlines
581 * txline - allow setting temp xlines
582 * unxline - allow removing xlines
583 * resv - allow setting perm/temp resvs
584 * tresv - allow setting temp resvs
585 * unresv - allow removing xlines
586 * all - allow oper/server to do all of above.
587 * locops - allow locops - only used for servers who cluster
588 * rehash - allow rehashing
d8d2cb0a
JT
589 * dline - allow setting perm/temp dlines
590 * tdline - allow setting temp dlines
591 * undline - allow removing dlines
212380e3
AC
592 * none - disallow everything
593 */
594
595 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
596 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
597 */
598 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
599 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
600 flags = kline;
601
602 /* you may forbid certain opers/servers from doing anything */
603 oper = "irc@vanity.oper", "*";
604 oper = "*@*", "irc.vanity.server";
605 oper = "irc@another.vanity.oper", "bigger.vanity.server";
606 flags = none;
607
608 /* or allow everyone to place temp klines */
609 oper = "*@*";
610 flags = tkline;
611};
612
b808adf9 613/* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
212380e3
AC
614exempt {
615 ip = "192.168.0.0/16";
616
617 /* these may be stacked */
618 ip = "127.0.0.1";
619 ip = "10.0.0.0/8";
620};
621
622/* The channel block contains options pertaining to channels */
623channel {
624 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
625 * that can join a +i channel without an invite.
626 */
627 use_invex = yes;
628
629 /* except: Enable/disable channel mode +e, a n!u@h list of masks
630 * that can join a channel through a ban (+b).
631 */
632 use_except = yes;
633
634 /* forward: Enable/disable channel mode +f, a channel to forward
635 * users to if they can't join because of +i etc.
636 */
637 use_forward = yes;
638
639 /* knock: Allows users to request an invite to a channel that
640 * is locked somehow (+ikl). If the channel is +p or you are banned
641 * the knock will not be sent.
642 */
643 use_knock = yes;
644
212380e3
AC
645 /* knock delay: The amount of time a user must wait between issuing
646 * the knock command.
647 */
648 knock_delay = 5 minutes;
649
650 /* knock channel delay: How often a knock to any specific channel
651 * is permitted, regardless of the user sending the knock.
652 */
653 knock_delay_channel = 1 minute;
654
655 /* max chans: The maximum number of channels a user can join/be on. */
656 max_chans_per_user = 15;
657
658 /* max bans: maximum number of +b/e/I/q modes in a channel */
659 max_bans = 25;
660
661 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
662 max_bans_large = 500;
663
664 /* splitcode: split users, split servers and either no join on split
665 * or no create on split must be enabled for split checking.
666 * splitmode will be entered on either split users or split servers
667 * dropping below the limit.
668 *
669 * you may force splitmode to be permanent by /quote set splitmode on
670 */
671
672 /* split users: when the usercount is lower than this level, consider
673 * ourselves split. this must be set for automatic splitmode
674 */
675 default_split_user_count = 0;
676
677 /* split servers: when the amount of servers that have acknowledged
678 * theyve finished bursting is lower than this, consider ourselves
679 * split. this must be set for automatic splitmode
680 */
681 default_split_server_count = 0;
682
683 /* split: no create: disallow users creating channels on split */
684 no_create_on_split = no;
685
686 /* split: no join: disallow users joining channels at all on a split */
687 no_join_on_split = no;
688
689 /* burst topicwho: when bursting topics, also burst the topic setter */
690 burst_topicwho = yes;
691
692 /* kick on split riding: kick users riding splits to join +i or +k
693 * channels. more precisely, if a bursting server sends an SJOIN
694 * for a channel with a lower TS with either a +i mode or a +k
695 * mode with a different key, kick all local users.
696 *
697 * note: this does not take +r, +b, +e and +I into account.
698 *
699 * warning: if there are any TS5 servers on the network, this
700 * will cause ban desyncs if they send such an SJOIN and the
701 * splitriders added any bans (our side will lose them, the TS5
702 * side will accept them). we will send a notice to the channel
703 * if this happens. most services do not send such SJOINs but
704 * ratbox-services does.
705 */
706 kick_on_split_riding = no;
707};
708
709
710/* The serverhide block contains the options regarding serverhiding */
711serverhide {
4acf2281
JT
712 /* flatten links: this option will hide various routing information
713 * and make all servers in /links appear that they are linked to
714 * this server.
212380e3
AC
715 */
716 flatten_links = no;
717
994544c2
JT
718 /* links delay: how long to wait before showing splits or new
719 * servers in a flattened /links output.
212380e3
AC
720 */
721 links_delay = 5 minutes;
722
4acf2281
JT
723 /* hidden: hide this server from a /links output on servers with
724 * flatten_links enabled. this allows hub servers to be hidden etc.
212380e3
AC
725 */
726 hidden = no;
727
728 /* disable hidden: prevent servers hiding themselves from a
729 * /links ouput.
730 */
731 disable_hidden = no;
732};
733
734/* These are the blacklist settings.
735 * You can have multiple combinations of host and rejection reasons.
92fb5c31 736 * They are used in pairs of one host/rejection reason, or multiple hosts/rejection reason.
212380e3
AC
737 *
738 * These settings should be adequate for most networks, and are (presently)
739 * required for use on AthemeNet.
740 *
741 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
742 * connections.
743 *
92fb5c31
AC
744 * As of charybdis 2.2, you can do some keyword substitution on the rejection
745 * reason. The available keyword substitutions are:
746 *
747 * ${ip} - the user's IP
748 * ${host} - the user's canonical hostname
749 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
750 * ${nick} - the user's nickname
751 * ${network-name} - the name of the network
752 *
57b8cb0f 753 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
212380e3
AC
754 * contacted, via email, at admins@2mbit.com before using these BLs.
755 * See <http://www.ahbl.org/services.php> for more information.
756 */
57b8cb0f
AC
757blacklist {
758 host = "dnsbl.dronebl.org";
759 reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
760
212380e3 761# host = "ircbl.ahbl.org";
92fb5c31 762# reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for having an open proxy. In order to protect ${network-name} from abuse, we are not allowing connections with open proxies to connect.";
212380e3
AC
763#
764# host = "tor.ahbl.org";
92fb5c31 765# reject_reason = "${nick}, your IP (${ip}) is listed as a TOR exit node. In order to protect ${network-name} from tor-based abuse, we are not allowing TOR exit nodes to connect to our network.";
57b8cb0f 766};
212380e3
AC
767
768/*
769 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
770 * They send PRIVMSG to the given target. A real command takes
771 * precedence above an alias.
772 */
773alias "NickServ" {
774 /* the name must go above */
775
776 /* target: the target nick (must be a network service) or
777 * user@server (cannot be this server, only opers can use
778 * user starting with "opers" reliably, interpreted on the target
779 * server only so you may need to use nick@server instead)
780 */
781 target = "NickServ";
782};
783
784alias "ChanServ" {
785 target = "ChanServ";
786};
787
788alias "OperServ" {
789 target = "OperServ";
790};
791
792alias "MemoServ" {
793 target = "MemoServ";
794};
795
796alias "NS" {
797 target = "NickServ";
798};
799
800alias "CS" {
801 target = "ChanServ";
802};
803
804alias "OS" {
805 target = "OperServ";
806};
807
808alias "MS" {
809 target = "MemoServ";
810};
811
812/* The general block contains many of the options that were once compiled
813 * in options in config.h. The general block is read at start time.
814 */
815general {
816 /* hide error messages: defines whether error messages from
922aa826
JT
817 * servers that are not deemed fully safe are hidden or not.
818 * These can sometimes contain IPs and can have an adverse
819 * effect on server ip hiding. Set to:
212380e3
AC
820 * yes: hide from opers and admin
821 * opers: hide from opers only
822 * no: do not hide error messages
922aa826 823 * Admins on other servers count as opers.
212380e3
AC
824 */
825 hide_error_messages = opers;
826
827 /* hide spoof ips: hide the real ips of auth{} spoofed users
828 * If disabled, local opers can see them.
829 * Dynamic spoofs (e.g. set by services) are unaffected by this;
830 * any oper (local and remote) can see the real ip.
831 * Warning: for whowas, this is checked when the client exits,
832 * not when the IP is shown.
833 */
834 hide_spoof_ips = yes;
835
836 /* default umodes: umodes to set upon connection
837 * If you have enabled the ip_cloaking extension, and you wish for
838 * incoming clients to be set +h upon connection, add +h to the umode
839 * string below.
840 */
841 default_umodes = "+i";
842
843 /* default operstring: defines the default oper response
844 * in /whois queries, eg "is an IRC Operator".
845 * After startup use /quote set operstring to change.
846 */
847 default_operstring = "is an IRC Operator";
848
849 /* default adminstring: defines the default admin response
850 * in /whois queries, eg "is a Server Administrator".
851 * After startup use /quote set adminstring to change.
852 */
853 default_adminstring = "is a Server Administrator";
854
855 /* servicestring: defines the response for opered services (+S)
856 * in /whois queries, eg "is a Network Service".
857 * This is updated on rehash.
858 */
859 servicestring = "is a Network Service";
860
861 /* disable fake channels: disable local users joining fake versions
862 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
863 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
864 */
865 disable_fake_channels = no;
866
867 /* tkline_expire_notices: give a notice to opers when a tkline
868 * expires
869 */
870 tkline_expire_notices = no;
871
872 /* floodcount: the default value of floodcount that is configurable
873 * via /quote set floodcount. This is the amount of lines a user
874 * may send to any other user/channel in one second.
875 */
876 default_floodcount = 10;
877
878 /* failed oper notice: send a notice to all opers on the server when
879 * someone tries to OPER and uses the wrong password, host or ident.
880 */
881 failed_oper_notice = yes;
882
883 /* dots in ident: the amount of '.' characters permitted in an ident
884 * reply before the user is rejected.
885 */
886 dots_in_ident=2;
887
212380e3
AC
888 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
889 * placed via the server. klines hand placed are exempt from limits.
890 * wildcard chars: '.' '*' '?' '@'
891 */
892 min_nonwildcard = 4;
893
894 /* min nonwildcard simple: the minimum non wildcard characters in
895 * xlines/resvs placed via the server.
896 * wildcard chars: '*' '?'
897 */
898 min_nonwildcard_simple = 3;
899
900 /* max accept: maximum allowed /accept's for +g usermode */
901 max_accept = 20;
902
903 /* max monitor: the maximum amount of nicknames a client may have in
904 * their monitor (server-side notify) list.
905 */
906 max_monitor = 100;
907
908 /* nick flood: enable the nickflood control code */
909 anti_nick_flood = yes;
910
911 /* nick flood: the nick changes allowed in the specified period */
912 max_nick_time = 20 seconds;
913 max_nick_changes = 5;
914
915 /* anti spam time: the minimum time a user must be connected before
916 * custom quit messages are allowed.
917 */
918 anti_spam_exit_message_time = 5 minutes;
919
920 /* ts delta: the time delta allowed between server clocks before
921 * a warning is given, or before the link is dropped. all servers
922 * should run ntpdate/rdate to keep clocks in sync
923 */
924 ts_warn_delta = 30 seconds;
925 ts_max_delta = 5 minutes;
926
927 /* client exit: prepend a users quit message with "Client exit: " */
928 client_exit = yes;
929
930 /* collision fnc: change user's nick to their UID instead of
931 * killing them, if possible. This setting only applies to nick
932 * collisions detected on this server. Only enable this if
933 * all servers on the network allow remote nicks to start with
934 * a digit.
935 */
936 collision_fnc = yes;
937
938 /* global snotices: send out certain snotices (most +b, +f, +y,
939 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
940 * displayed unconditionally.
941 */
942 global_snotices = yes;
943
944 /* dline reason: show the user the dline reason when they connect
945 * and are dlined.
946 */
947 dline_with_reason = yes;
948
949 /* kline delay: delay the checking of klines until a specified time.
950 * Useful if large kline lists are applied often to prevent the
951 * server eating CPU.
952 */
953 kline_delay = 0 seconds;
954
170703fe 955 /* kline reason: show the user the reason why they are k/dlined
212380e3
AC
956 * on exit. may give away who set k/dline when set via tcm.
957 */
958 kline_with_reason = yes;
959
960 /* kline reason: make the users quit message on channels this
961 * reason instead of the oper's reason.
962 */
963 kline_reason = "Connection closed";
964
965 /* identify to services via server password
966 * if auth{} block had no password but the user specified a
967 * server password anyway, send a PRIVMSG to <identify_service>
968 * with as text <identify_command> <password>.
969 */
970 identify_service = "NickServ@services.int";
971 identify_command = "IDENTIFY";
972
973 /* non redundant klines: flag and ignore redundant klines */
974 non_redundant_klines = yes;
975
976 /* warn no nline: warn opers about servers that try to connect but
977 * we dont have a connect {} block for. Twits with misconfigured
978 * servers can get really annoying with this enabled.
979 */
980 warn_no_nline = yes;
981
982 /* stats e disabled: disable stats e. useful if server ips are
983 * exempted and you dont want them listing on irc.
984 */
985 stats_e_disabled = no;
986
987 /* stats c oper only: make stats c (connect {}) oper only */
988 stats_c_oper_only=no;
989
990 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
991 stats_h_oper_only=no;
992
993 /* stats y oper only: make stats y (class {}) oper only */
994 stats_y_oper_only=no;
995
996 /* stats o oper only: make stats o (opers) oper only */
997 stats_o_oper_only=yes;
998
999 /* stats P oper only: make stats P (ports) oper only
1000 * NOTE: users doing stats P will never be given the ips that the
1001 * server listens on, simply the ports.
1002 */
1003 stats_P_oper_only=no;
1004
1005 /* stats i oper only: make stats i (auth {}) oper only. set to:
1006 * yes: show users no auth blocks, made oper only.
1007 * masked: show users first matching auth block
1008 * no: show users all auth blocks.
1009 */
1010 stats_i_oper_only=masked;
1011
1012 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1013 * yes: show users no auth blocks, made oper only
1014 * masked: show users first matching auth block
1015 * no: show users all auth blocks.
1016 */
1017 stats_k_oper_only=masked;
1018
1019 /* map oper only: make /map oper only */
1020 map_oper_only = no;
1021
1022 /* operspy admin only: make operspy notices to +Z admin only */
1023 operspy_admin_only = no;
1024
1025 /* operspy dont care user info: treat /who mask as if there was
1026 * an '!' always; do not log or server notice about operspy
1027 * /who mask, /masktrace and /scan. channel information is still
1028 * protected. */
1029 operspy_dont_care_user_info = no;
1030
1031 /* caller id wait: time between notifying a +g user that somebody
1032 * is messaging them.
1033 */
1034 caller_id_wait = 1 minute;
1035
1036 /* pace wait simple: time between use of less intensive commands
1037 * (HELP, remote WHOIS, WHOWAS)
1038 */
1039 pace_wait_simple = 1 second;
1040
1041 /* pace wait: time between more intensive commands
1042 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1043 */
1044 pace_wait = 10 seconds;
1045
1046 /* short motd: send clients a notice telling them to read the motd
1047 * instead of forcing a motd to clients who may simply ignore it.
1048 */
1049 short_motd = no;
1050
1051 /* ping cookies: require clients to respond exactly to a ping command,
1052 * can help block certain types of drones and FTP PASV mode spoofing.
1053 */
1054 ping_cookie = no;
1055
1056 /* connect timeout: sets how long we should wait for a connection
1057 * request to succeed
1058 */
1059 connect_timeout = 30 seconds;
1060
1061 /* disable auth: disables identd checking */
1062 disable_auth = no;
1063
1064 /* no oper flood: increase flood limits for opers. */
1065 no_oper_flood = yes;
1066
212380e3
AC
1067 /* REMOVE ME. The following line checks you've been reading. */
1068 havent_read_conf = yes;
1069
1070 /* max targets: the maximum amount of targets in a single
1071 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1072 */
1073 max_targets = 4;
1074
1075 /* client flood: maximum number of lines in a clients queue before
1076 * they are dropped for flooding.
1077 */
1078 client_flood = 20;
1079
1080 /* use_whois_actually: send clients requesting a whois a numeric
1081 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1082 */
1083 use_whois_actually = yes;
1084
1085 /* usermodes configurable: a list of usermodes for the options below
1086 *
1087 * +g - callerid - Server Side Ignore
1088 * +D - deaf - Don't see channel messages
1089 * +i - invisible - Not shown in NAMES or WHO unless you share a
1090 * a channel
1091 * +l - locops - See LOCOPS messages
1092 * +Q - noforward - Unaffected by channel forwarding
1093 * +R - regonlymsg - No messages from unindentified
1094 * +s - servnotice - See server notices
1095 * +w - wallop - See oper and server generated WALLOPS
1096 * +z - operwall - See operwalls
1097 */
1098
1099 /* oper only umodes: usermodes only opers may set */
1100 oper_only_umodes = operwall, locops, servnotice;
1101
1102 /* oper umodes: default usermodes opers get when they /oper */
1103 oper_umodes = locops, servnotice, operwall, wallop;
1104
1105 /* oper snomask: default snomask opers get when they /oper,
1106 * provided they have umode +s set */
1107 oper_snomask = "+s";
1108
212380e3
AC
1109 /* use egd: if your system does not have *random devices yet you
1110 * want to use OpenSSL and encrypted links, enable this. Beware -
1111 * EGD is *very* CPU intensive when gathering data for its pool
1112 */
1113 #use_egd = yes;
1114
1115 /* egdpool path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1116 * which automatically finds the path.
1117 */
1118 #egdpool_path = "/var/run/egd-pool";
1119
1120
1121 /* compression level: level of compression for compressed links between
1122 * servers.
1123 *
1124 * values are between: 1 (least compression, fastest)
1125 * and: 9 (most compression, slowest).
1126 */
1127 #compression_level = 6;
1128
1129 /* burst_away: This enables bursting away messages to servers.
1130 * With this disabled, we will only propogate AWAY messages
1131 * as users send them, but never burst them. Be warned though
1132 * enabling this could increase the size of a burst significantly
1133 * for a large network, like EFnet.
1134 */
1135 burst_away = yes;
1136
1137 /* nick delay: This locks nicks of split clients for the given time
1138 * or until a remote client uses the nick. This significantly
1139 * reduces nick collisions on short splits but it can be annoying.
1140 * To make things as fair as possible, this should be the same on
1141 * all servers. If you enable this, the suggested value is 15 minutes.
1142 */
1143 nick_delay = 0 seconds;
1144
1145 /* reject time: the amount of rejections through klines/dlines etc
1146 * allowed in the given time before the rejection is cached and
1147 * a pseudo temp dline is placed
1148 */
1149 reject_ban_time = 1 minute;
1150 reject_after_count = 3;
1151
1152 /* reject duration: the amount of time to cache the rejection */
1153 reject_duration = 5 minutes;
54015b5f 1154
43946961
JT
1155 /* throttle_duration: Amount of time that throttling will be applied to an IP
1156 * address.
54015b5f 1157 */
43946961
JT
1158 throttle_duration = 60;
1159
1160 /* throttle_count: Number of connections within throttle_duration that it takes
1161 * for throttling to take effect */
1162 throttle_count = 4;
212380e3
AC
1163};
1164
1165modules {
1166 /* module path: paths to search for modules specified below and
1167 * in /modload.
1168 */
1169 path = "/usr/local/ircd/modules";
1170 path = "/usr/local/ircd/modules/autoload";
1171
1172 /* module: the name of a module to load on startup/rehash */
1173 #module = "some_module.so";
1174};