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