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