1 /* doc/reference.conf - charybdis Example configuration file
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
7 * Written by ejb, wcampbel, db, leeh and others
9 * $Id: reference.conf 3582 2007-11-17 21:55:48Z jilles $
14 * class {} blocks MUST be specified before anything that uses them. That
15 * means they must be defined before auth {} and before connect {}.
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.
21 * privset {} blocks MUST be specified before anything that uses them. That
22 * means they must be defined before operator {}.
24 * Both shell style (#) and C style comments are supported.
26 * Files may be included by either:
30 * Times/durations are written as:
31 * 12 hours 30 minutes 1 second
33 * Valid units of time:
34 * month, week, day, hour, minute, second
36 * Valid units of size:
37 * megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
39 * Sizes and times may be singular or plural.
44 * ShadowIRCd contains several extensions that are not enabled by default.
45 * To use them, uncomment the lines below. More information on each extension
46 * can be found in extensions/README
48 * Channel mode +-A (admin only) -- chm_adminonly.so
49 * Channel mode +-O (oper only) -- chm_operonly.so
50 * Channel mode +-S (ssl only) -- chm_sslonly.so
51 * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat.so
52 * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat.so
53 * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat.so
54 * Restrict channel creation to logged in users -- createauthonly.so
55 * Account bans (+b $a[:mask]) -- extb_account.so
56 * Banned from another channel (+b $j:mask) -- extb_canjoin.so
57 * Other-channel bans (+b $c:mask) -- extb_channel.so
58 * Extended ban (+b $x:mask) -- extb_extgecos.so
59 * Oper bans (+b $o) -- extb_oper.so
60 * Realname (gecos) bans (+b $r:mask) -- extb_realname.so
61 * Server bans (+b $s:mask) -- extb_server.so
62 * SSL bans (+b $z) -- extb_ssl.so
63 * HURT system -- hurt.so
64 * New host mangling (umode +x) -- ip_cloaking.so
65 * Find channel forwards -- m_findforwards.so
66 * /identify support -- m_identify.so
67 * Opers cannot be invisible (umode +i) -- no_oper_invis.so
68 * Far connection notices (snomask +F) -- sno_farconnect.so
69 * Remote k/d/x line active notices -- sno_globalkline.so
70 * Remote oper up notices -- sno_globaloper.so
71 * /whois notifications (snomask +W) -- sno_whois.so
72 * Force join users to channels -- m_force.so
74 #loadmodule "extensions/chm_adminonly.so";
75 loadmodule "extensions/chm_operonly.so";
76 #loadmodule "extensions/chm_sslonly.so";
77 #loadmodule "extensions/chm_operonly_compat.so";
78 #loadmodule "extensions/chm_quietunreg_compat.so";
79 #loadmodule "extensions/chm_sslonly_compat.so";
80 #loadmodule "extensions/createauthonly.so";
81 loadmodule "extensions/extb_account.so";
82 loadmodule "extensions/extb_canjoin.so";
83 loadmodule "extensions/extb_channel.so";
84 loadmodule "extensions/extb_extgecos.so";
85 loadmodule "extensions/extb_oper.so";
86 loadmodule "extensions/extb_realname.so";
87 #loadmodule "extensions/extb_server.so";
88 #loadmodule "extensions/extb_ssl.so";
89 #loadmodule "extensions/hurt.so";
90 loadmodule "extensions/ip_cloaking.so";
91 #loadmodule "extensions/m_findforwards.so";
92 loadmodule "extensions/m_identify.so";
93 #loadmodule "extensions/no_oper_invis.so";
94 loadmodule "extensions/sno_farconnect.so";
95 loadmodule "extensions/sno_globalkline.so";
96 loadmodule "extensions/sno_globaloper.so";
97 #loadmodule "extensions/sno_whois.so";
98 #loadmodule "extensions/m_force.so";
100 /* serverinfo {}: Contains information about the server. (OLD M:) */
102 /* name: the name of our server */
105 /* sid: the unique server id of our server. This must be three
106 * characters long. The first character must be a digit [0-9], the
107 * remaining two chars may be letters [A-Z] or digits [0-9].
109 * This parameter must be specified for the server to start.
113 /* description: the description of our server. '[' and ']' may not
114 * be used here for compatibility with older servers.
116 description = "shadowircd test server";
118 /* network info: the name and description of the network this server
119 * is on. Shown in the 005 reply and used with serverhiding.
121 network_name = "MyNet";
122 network_desc = "This is My Network";
124 /* hub: allow this server to act as a hub and have multiple servers
129 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
130 * This should be an ipv4 IP only.
132 #vhost = "192.169.0.1";
134 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
135 * This should be an ipv6 IP only.
137 #vhost6 = "3ffe:80e8:546::2";
139 /* ssl_private_key: our ssl private key */
140 ssl_private_key = "etc/test.key";
142 /* ssl_cert: certificate for our ssl server */
143 ssl_cert = "etc/test.cert";
145 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
146 ssl_dh_params = "etc/dh.pem";
148 /* ssld_count: number of ssld processes you want to start, if you
149 * have a really busy server, using N-1 where N is the number of
150 * cpu/cpu cores you have might be useful. A number greater than one
151 * can also be useful in case of bugs in ssld and because ssld needs
152 * two file descriptors per SSL connection.
156 /* default max clients: the default maximum number of clients
157 * allowed to connect. This can be changed once ircd has started by
159 * /quote set maxclients <limit>
161 default_max_clients = 1024;
164 /* admin {}: contains admin information about the server. (OLD A:) */
166 name = "Smurf target";
167 description = "Main Server Administrator";
168 email = "<syn@packets.r.us>";
171 /* log {}: contains information about logfiles. */
173 /* logfiles: the logfiles to use for specific activity. if these
174 * paths are defined, then ircd will log to them, otherwise it wont.
176 * The confs are, in order:
177 * - userlog: user exits
178 * - fuserlog: failed user connections
179 * - operlog: /oper usage
180 * - foperlog: failed /oper usage
181 * - serverlog: server connects/disconnects
182 * - klinelog: klines, etc
184 * - operspylog: operspy usage
185 * - ioerrorlog: IO errors
187 fname_userlog = "logs/userlog";
188 #fname_fuserlog = "logs/fuserlog";
189 fname_operlog = "logs/operlog";
190 #fname_foperlog = "logs/foperlog";
191 fname_serverlog = "logs/serverlog";
192 #fname_klinelog = "logs/klinelog";
193 fname_killlog = "logs/killlog";
194 fname_operspylog = "logs/operspylog";
195 #fname_ioerrorlog = "logs/ioerror";
198 /* class {}: contain information about classes for users (OLD Y:) */
200 /* class name must go above */
202 /* ping time: how often a client must reply to a PING from the
203 * server before they are dropped.
205 ping_time = 2 minutes;
207 /* number per ident: the number of users per user@host networkwide
208 * allowed to connect. Unidented connections are classified as
211 number_per_ident = 2;
213 /* number per ip: the number of local users per host allowed */
216 /* number per ip global: the number of network wide connections
217 * per host allowed for a user, including connections to the
220 number_per_ip_global = 5;
222 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
224 cidr_ipv4_bitlen = 24;
226 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
227 * the following example makes the subnet /64 this is useful
228 * for IPv6 connections in particular
230 cidr_ipv6_bitlen = 64;
232 /* number_per_cidr: Number of connections to allow from a subnet of the
233 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
234 * 4 seems to be a good default to me.
238 /* max number: the maximum number of users allowed in this class */
241 /* sendq: the amount of data allowed in a clients queue before
248 ping_time = 1 minute 30 seconds;
255 ping_time = 5 minutes;
262 ping_time = 5 minutes;
264 /* connectfreq: only used in server classes. specifies the delay
265 * between autoconnecting to servers.
267 connectfreq = 5 minutes;
269 /* max number: the amount of servers to autoconnect to */
272 /* sendq: servers need a higher sendq as they are sent more data */
276 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
278 /* port: the specific port to listen on. if no host is specified
279 * before, it will listen on all available IPs.
281 * sslport: the specific port to listen ssl connections on. if no
282 * host is specified before, it will listen on all available IPs.
284 * ports are seperated via a comma, a range may be specified using ".."
287 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
288 port = 5000, 6665 .. 6669;
290 /* sslport: listen for ssl connections on all available IPs, port 9999 */
293 /* host: set a specific IP/host the ports after the line will listen
294 * on. This may be ipv4 or ipv6.
298 sslport = 9000, 9001;
300 host = "3ffe:1234:a:b:c::d";
305 /* auth {}: allow users to connect to the ircd (OLD I:) */
307 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
308 * lines are permitted per auth block. This is matched against the
309 * hostname and IP address (using :: shortening for IPv6 and
310 * prepending a 0 if it starts with a colon) and can also use CIDR
313 user = "*@172.16.0.0/12";
314 user = "*test@123D:B567:*";
316 /* password: an optional password that is required to use this block.
317 * By default this is not encrypted, specify the flag "encrypted" in
318 * flags = ...; below if it is.
320 password = "letmein";
322 /* spoof: fake the users user@host to be be this. You may either
323 * specify a host or a user@host to spoof to. This is free-form,
324 * just do everyone a favour and dont abuse it. (OLD I: = flag)
326 spoof = "I.still.hate.packets";
328 /* autojoin: Channel (or channels, comma-seperated) to join users
329 * in this auth block to on connect. Note that this won't join
330 * the user through any bans or otherwise restrictive chmodes.
332 autojoin = "#shadowircd,#test";
334 /* autojoin_opers : Channel (or channels, comma-seperated) to join
335 * opers to on oper-up.
337 autojoin_opers = "#opers,#help";
339 /* Possible flags in auth:
341 * encrypted | password is encrypted with mkpasswd
342 * spoof_notice | give a notice when spoofing hosts
343 * exceed_limit (old > flag) | allow user to exceed class user limits
344 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
345 * dnsbl_exempt | exempt this user from dnsbls
346 * spambot_exempt | exempt this user from spambot checks
347 * shide_exempt | exempt this user from serverhiding
348 * jupe_exempt | exempt this user from generating
349 * warnings joining juped channels
350 * resv_exempt | exempt this user from resvs
351 * flood_exempt | exempt this user from flood limits
353 * no_tilde (old - flag) | don't prefix ~ to username if no ident
354 * need_ident (old + flag) | require ident for user in this class
355 * need_ssl | require SSL/TLS for user in this class
356 * need_sasl | require SASL id for user in this class
358 flags = kline_exempt, exceed_limit;
360 /* class: the class the user is placed in */
365 /* redirect: the server and port to redirect a user to. A user does
366 * not have to obey the redirection, the ircd just suggests to them
367 * an alternative server.
369 redirserv = "irc.some.domain";
372 user = "*.some.domain";
374 /* class: a class is required even though it is not used */
385 /* privset{}: defines operator privilege sets. */
387 /* privs: controls the activities and commands an oper is
388 * allowed to do on the server
392 * oper:local_kill: allows local users to be /KILL'd
393 * oper:global_kill: allows local and remote users to be /KILL'd
394 * oper:routing: allows remote SQUIT and CONNECT
395 * oper:kline: allows KLINE and DLINE
396 * oper:unkline: allows UNKLINE and UNDLINE
397 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
398 * oper:rehash: allows oper to REHASH config
399 * oper:die: allows DIE and RESTART
400 * oper:admin: gives admin privileges. admins
401 * may (un)load modules and see various
402 * additional information.
403 * oper:hidden_admin: gives admin privileges except
404 * will not have the admin lines in
406 * oper:xline: allows use of /quote xline/unxline
407 * oper:resv: allows /quote resv/unresv and cmode +LP
408 * oper:operwall: allows the oper to send/receive operwalls
409 * oper:spy: allows 'operspy' features to see through +s
410 * channels etc. see /quote help operspy
411 * oper:hidden: hides the oper from /stats p
412 * oper:remoteban: allows remote kline etc
413 * oper:mass_notice: allows sending wallops and mass notices
415 privs = oper:local_kill, oper:operwall;
418 privset "server_bot" {
419 /* extends: a privset to inherit in this privset */
420 extends = "local_op";
421 privs = oper:kline, oper:remoteban, snomask:nick_changes;
424 privset "global_op" {
425 extends = "local_op";
426 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
427 oper:resv, oper:mass_notice, oper:remoteban;
431 extends = "global_op";
432 privs = oper:admin, oper:die, oper:rehash, oper:spy;
435 /* operator {}: defines ircd operators. (OLD O:) */
437 /* name: the name of the oper must go above */
439 /* user: the user@host required for this operator. CIDR *is*
440 * supported now. auth{} spoofs work here, other spoofs do not.
441 * multiple user="" lines are supported.
444 user = "*@127.0.0.1";
446 /* password: the password required to oper. Unless ~encrypted is
447 * contained in flags = ...; this will need to be encrypted using
448 * mkpasswd, MD5 is supported
450 password = "etcnjl8juSU1E";
452 /* rsa key: the public key for this oper when using Challenge.
453 * A password should not be defined when this is used, see
454 * doc/challenge.txt for more information.
456 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
458 /* fingerprint: if specified, the oper's client certificate
459 * fingerprint will be checked against the specified fingerprint
462 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
464 /* umodes: the specific umodes this oper gets when they oper.
465 * If this is specified an oper will not be given oper_umodes
466 * These are described above oper_only_umodes in general {};
468 #umodes = locops, servnotice, operwall, wallop;
470 /* snomask: specific server notice mask on oper up.
471 * If this is specified an oper will not be given oper_snomask.
473 snomask = "+Zbfkrsuy";
475 /* flags: misc options for the operator. You may prefix an option
476 * with ~ to disable it, e.g. ~encrypted.
478 * Default flags are encrypted.
482 * encrypted: the password above is encrypted [DEFAULT]
483 * need_ssl: must be using SSL/TLS to oper up
487 /* privset: privileges set to grant */
491 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
492 connect "irc.uplink.com" {
493 /* the name must go above */
495 /* host: the host or IP to connect to. If a hostname is used it
496 * must match the reverse dns of the server.
498 host = "192.168.0.1";
500 /* vhost: the host or IP to bind to for this connection. If this
501 * is not specified, the default vhost (in serverinfo {}) is used.
503 #vhost = "192.168.0.50";
505 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
506 * The remote server will have these passwords reversed.
508 send_password = "password";
509 accept_password = "anotherpassword";
511 /* port: the port to connect to this server on */
514 /* hub mask: the mask of servers that this server may hub. Multiple
515 * entries are permitted
519 /* leaf mask: the mask of servers this server may not hub. Multiple
520 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
524 /* class: the class this server is in */
527 /* flags: controls special options for this server
528 * encrypted - marks the accept_password as being crypt()'d
529 * autoconn - automatically connect to this server
530 * compressed - compress traffic via ziplinks
531 * topicburst - burst topics between servers
532 * ssl - ssl/tls encrypted server connections
534 flags = compressed, topicburst;
537 connect "ipv6.some.server" {
538 /* Hosts that are IPv6 addresses must be in :: shortened form
539 * if applicable. Addresses starting with a colon get an extra
540 * zero prepended, for example: 0::1
542 host = "3ffd:dead:beef::1";
543 send_password = "password";
544 accept_password = "password";
547 /* aftype: controls whether the connection uses "ipv4" or "ipv6".
554 connect "ssl.uplink.com" {
555 /* Example of ssl server-to-server connection, ssl flag doesn't need
556 * compressed flag, 'cause it uses own compression
558 host = "192.168.0.1";
559 send_password = "password";
560 accept_password = "anotherpassword";
564 flags = ssl, topicburst;
567 /* cluster {}; servers that we propagate things to automatically.
568 * NOTE: This does NOT grant them privileges to apply anything locally,
569 * you must add a seperate shared block for that. Clustering will
570 * only be done for actions by LOCAL opers, that arent directed
574 /* name: the server to share with, this can be a wildcard and may be
577 /* flags: list of what to share, all the name lines above this (up
578 * until another flags entry) will receive these flags.
580 * kline - share perm klines
581 * tkline - share temp klines
582 * unkline - share unklines
583 * locops - share locops
584 * xline - share perm xlines
585 * txline - share temp xlines
586 * unxline - share unxlines
587 * resv - share perm resvs
588 * tresv - share temp resvs
589 * unresv - share unresvs
590 * all - share all of the above
593 /* share klines/unklines/xlines with *.lan */
595 flags = kline, unkline, xline;
597 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
598 name = "irc.ircd-ratbox.org";
599 name = "ircd.ircd-ratbox.org";
603 /* service{}: privileged servers (services). These servers have extra
604 * privileges such as setting login names on users and introducing clients
605 * with umode +S (unkickable, hide channels, etc). This does not allow them
606 * to set bans, you need a separate shared{} for that.
607 * Do not place normal servers here.
608 * There may be only one service{} block.
611 /* name: the server name. These may be stacked. */
612 name = "services.int";
615 /* shared {}: users that are allowed to place remote bans on our server.
616 * NOTE: These are ordered top down. The first one the user@host and server
617 * matches will be used. Their access will then be decided on that
618 * block and will not fall back to another block that matches.
621 /* oper: the user@host and server the user must be on to set klines.
622 * The first field must be a user@host, the second field is an
623 * optional server. These may be stacked.
625 /* flags: list of what to allow them to place, all the oper lines
626 * above this (up until another flags entry) will receive these
627 * flags. This *must* be present.
629 * kline - allow setting perm/temp klines
630 * tkline - allow setting temp klines
631 * unkline - allow removing klines
632 * xline - allow setting perm/temp xlines
633 * txline - allow setting temp xlines
634 * unxline - allow removing xlines
635 * resv - allow setting perm/temp resvs
636 * tresv - allow setting temp resvs
637 * unresv - allow removing xlines
638 * all - allow oper/server to do all of above.
639 * locops - allow locops - only used for servers who cluster
640 * rehash - allow rehashing
641 * dline - allow setting perm/temp dlines
642 * tdline - allow setting temp dlines
643 * undline - allow removing dlines
644 * none - disallow everything
647 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
648 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
650 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
651 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
654 /* you may forbid certain opers/servers from doing anything */
655 oper = "irc@vanity.oper", "*";
656 oper = "*@*", "irc.vanity.server";
657 oper = "irc@another.vanity.oper", "bigger.vanity.server";
660 /* or allow everyone to place temp klines */
665 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
667 ip = "192.168.0.0/16";
669 /* these may be stacked */
674 /* The channel block contains options pertaining to channels */
676 /* autochanmodes: Modes that will be set on a unregistered channel
677 * when the first user joins it.
679 autochanmodes = "nt";
681 /* halfop: Enable/disable channel mode +h, which adds halfop,
682 * a channel status below op that has op powers (kick, ban, mode, etc.)
685 /* owner: Enable/disable channel mode +a, which adds owner,
686 * a channel status above op that has op powers (kick, ban, mode, etc.)
689 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
690 * that can join a +i channel without an invite.
694 /* except: Enable/disable channel mode +e, a n!u@h list of masks
695 * that can join a channel through a ban (+b).
699 /* forward: Enable/disable channel mode +f, a channel to forward
700 * users to if they can't join because of +i etc.
704 /* knock: Allows users to request an invite to a channel that
705 * is locked somehow (+ikl). If the channel is +p or you are banned
706 * the knock will not be sent.
710 /* knock delay: The amount of time a user must wait between issuing
713 knock_delay = 5 minutes;
715 /* knock channel delay: How often a knock to any specific channel
716 * is permitted, regardless of the user sending the knock.
718 knock_delay_channel = 1 minute;
720 /* max chans: The maximum number of channels a user can join/be on. */
721 max_chans_per_user = 15;
723 /* max bans: maximum number of +b/e/I/q modes in a channel */
726 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
727 max_bans_large = 500;
729 /* splitcode: split users, split servers and either no join on split
730 * or no create on split must be enabled for split checking.
731 * splitmode will be entered on either split users or split servers
732 * dropping below the limit.
734 * you may force splitmode to be permanent by /quote set splitmode on
737 /* split users: when the usercount is lower than this level, consider
738 * ourselves split. this must be set for automatic splitmode
740 default_split_user_count = 0;
742 /* split servers: when the amount of servers that have acknowledged
743 * theyve finished bursting is lower than this, consider ourselves
744 * split. this must be set for automatic splitmode
746 default_split_server_count = 0;
748 /* split: no create: disallow users creating channels on split */
749 no_create_on_split = no;
751 /* split: no join: disallow users joining channels at all on a split */
752 no_join_on_split = no;
754 /* burst topicwho: when bursting topics, also burst the topic setter */
755 burst_topicwho = yes;
757 /* kick on split riding: kick users riding splits to join +i or +k
758 * channels. more precisely, if a bursting server sends an SJOIN
759 * for a channel with a lower TS with either a +i mode or a +k
760 * mode with a different key, kick all local users.
762 * note: this does not take +r, +b, +e and +I into account.
764 * warning: if there are any TS5 servers on the network, this
765 * will cause ban desyncs if they send such an SJOIN and the
766 * splitriders added any bans (our side will lose them, the TS5
767 * side will accept them). we will send a notice to the channel
768 * if this happens. most services do not send such SJOINs but
769 * ratbox-services does.
771 kick_on_split_riding = no;
773 /* only ascii channels: disable local users joining channels
774 * containing characters outside the range 33-126 (non-printable
777 only_ascii_channels = no;
779 /* cycle_host_change: Should a user be cycled in the channels
780 * they're in when their host changes. If set to no, this may
781 * cause client desyncs.
783 cycle_host_change = yes;
785 /* host_in_topic: Defines whether or not the topicsetter's
786 * host is shown when users request the TOPIC. If this option
787 * is set to no, it will only show the nick of the topicsetter.
791 /* resv_forcepart: force any local users to part a channel
792 * when a RESV is issued.
794 resv_forcepart = yes;
796 /* kick_no_rejoin_time: the amount of time that a user cannot
797 * rejoin for after being kicked out of a +J channel.
799 kick_no_rejoin_time = 30 seconds;
803 /* The serverhide block contains the options regarding serverhiding */
805 /* flatten links: this option will hide various routing information
806 * and make all servers in /links appear that they are linked to
811 /* links delay: how long to wait before showing splits or new
812 * servers in a flattened /links output.
814 links_delay = 5 minutes;
816 /* hidden: hide this server from a /links output on servers with
817 * flatten_links enabled. this allows hub servers to be hidden etc.
821 /* disable hidden: prevent servers hiding themselves from a
827 /* These are the blacklist settings.
828 * You can have multiple combinations of host and rejection reasons.
829 * They are used in pairs of one host/rejection reason.
831 * These settings should be adequate for most networks, and are (presently)
832 * required for use on AthemeNet.
834 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
837 * As of charybdis 2.2, you can do some keyword substitution on the rejection
838 * reason. The available keyword substitutions are:
840 * ${ip} - the user's IP
841 * ${host} - the user's canonical hostname
842 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
843 * ${nick} - the user's nickname
844 * ${network-name} - the name of the network
846 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
847 * contacted, via email, at admins@2mbit.com before using these BLs.
848 * See <http://www.ahbl.org/services.php> for more information.
851 host = "dnsbl.dronebl.org";
852 reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
854 # host = "ircbl.ahbl.org";
855 # 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.";
857 # host = "tor.ahbl.org";
858 # 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.";
862 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
863 * They send PRIVMSG to the given target. A real command takes
864 * precedence above an alias.
867 /* the name must go above */
869 /* target: the target nick (must be a network service) or
870 * user@server (cannot be this server, only opers can use
871 * user starting with "opers" reliably, interpreted on the target
872 * server only so you may need to use nick@server instead)
921 /* The general block contains many of the options that were once compiled
922 * in options in config.h. The general block is read at start time.
925 /* hide error messages: defines whether error messages from
926 * servers that are not deemed fully safe are hidden or not.
927 * These can sometimes contain IPs and can have an adverse
928 * effect on server ip hiding. Set to:
929 * yes: hide from opers and admin
930 * opers: hide from opers only
931 * no: do not hide error messages
932 * Admins on other servers count as opers.
934 hide_error_messages = opers;
936 /* hide spoof ips: hide the real ips of auth{} spoofed users
937 * If disabled, local opers can see them.
938 * Dynamic spoofs (e.g. set by services) are unaffected by this;
939 * any oper (local and remote) can see the real ip.
940 * Warning: for whowas, this is checked when the client exits,
941 * not when the IP is shown.
943 hide_spoof_ips = yes;
945 /* default umodes: umodes to set upon connection
946 * If you have enabled the ip_cloaking extension, and you wish for
947 * incoming clients to be cloaked upon connection, +x must be in
948 * the umode string below.
950 default_umodes = "+ix";
952 /* default operstring: defines the default oper response
953 * in /whois queries, eg "is an IRC Operator".
954 * After startup use /quote set operstring to change.
956 default_operstring = "is an IRC Operator";
958 /* default adminstring: defines the default admin response
959 * in /whois queries, eg "is a Server Administrator".
960 * After startup use /quote set adminstring to change.
962 default_adminstring = "is a Server Administrator";
964 /* servicestring: defines the response for opered services (+S)
965 * in /whois queries, eg "is a Network Service".
966 * This is updated on rehash.
968 servicestring = "is a Network Service";
970 /* disable fake channels: disable local users joining fake versions
971 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
972 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
974 disable_fake_channels = no;
976 /* tkline_expire_notices: give a notice to opers when a tkline
979 tkline_expire_notices = no;
981 /* floodcount: the default value of floodcount that is configurable
982 * via /quote set floodcount. This is the amount of lines a user
983 * may send to any other user/channel in one second.
985 default_floodcount = 10;
987 /* failed oper notice: send a notice to all opers on the server when
988 * someone tries to OPER and uses the wrong password, host or ident.
990 failed_oper_notice = yes;
992 /* dots in ident: the amount of '.' characters permitted in an ident
993 * reply before the user is rejected.
997 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
998 * placed via the server. klines hand placed are exempt from limits.
999 * wildcard chars: '.' '*' '?' '@'
1001 min_nonwildcard = 4;
1003 /* min nonwildcard simple: the minimum non wildcard characters in
1004 * xlines/resvs placed via the server.
1005 * wildcard chars: '*' '?'
1007 min_nonwildcard_simple = 3;
1009 /* max accept: maximum allowed /accept's for +g usermode */
1012 /* max monitor: the maximum amount of nicknames a client may have in
1013 * their monitor (server-side notify) list.
1017 /* nick flood: enable the nickflood control code */
1018 anti_nick_flood = yes;
1020 /* nick flood: the nick changes allowed in the specified period */
1021 max_nick_time = 20 seconds;
1022 max_nick_changes = 5;
1024 /* anti spam time: the minimum time a user must be connected before
1025 * custom quit messages are allowed.
1027 anti_spam_exit_message_time = 5 minutes;
1029 /* ts delta: the time delta allowed between server clocks before
1030 * a warning is given, or before the link is dropped. all servers
1031 * should run ntpdate/rdate to keep clocks in sync
1033 ts_warn_delta = 30 seconds;
1034 ts_max_delta = 5 minutes;
1036 /* client exit: prepend a users quit message with "Client exit: " */
1039 /* collision fnc: change user's nick to their UID instead of
1040 * killing them, if possible. This setting only applies to nick
1041 * collisions detected on this server. Only enable this if
1042 * all servers on the network allow remote nicks to start with
1045 collision_fnc = yes;
1047 /* global snotices: send out certain snotices (most +b, +f, +y,
1048 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1049 * displayed unconditionally.
1051 global_snotices = yes;
1053 /* dline reason: show the user the dline reason when they connect
1056 dline_with_reason = yes;
1058 /* kline delay: delay the checking of klines until a specified time.
1059 * Useful if large kline lists are applied often to prevent the
1060 * server eating CPU.
1062 kline_delay = 0 seconds;
1064 /* kline reason: show the user the reason why they are k/dlined
1065 * on exit. may give away who set k/dline when set via tcm.
1067 kline_with_reason = yes;
1069 /* kline reason: make the users quit message on channels this
1070 * reason instead of the oper's reason.
1072 kline_reason = "Connection closed";
1074 /* identify to services via server password
1075 * if auth{} block had no password but the user specified a
1076 * server password anyway, send a PRIVMSG to <identify_service>
1077 * with as text <identify_command> <password>.
1079 identify_service = "NickServ@services.int";
1080 identify_command = "IDENTIFY";
1082 /* non redundant klines: flag and ignore redundant klines */
1083 non_redundant_klines = yes;
1085 /* warn no nline: warn opers about servers that try to connect but
1086 * we dont have a connect {} block for. Twits with misconfigured
1087 * servers can get really annoying with this enabled.
1089 warn_no_nline = yes;
1091 /* stats e disabled: disable stats e. useful if server ips are
1092 * exempted and you dont want them listing on irc.
1094 stats_e_disabled = no;
1096 /* stats c oper only: make stats c (connect {}) oper only */
1097 stats_c_oper_only=no;
1099 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
1100 stats_h_oper_only=no;
1102 /* stats y oper only: make stats y (class {}) oper only */
1103 stats_y_oper_only=no;
1105 /* stats o oper only: make stats o (opers) oper only */
1106 stats_o_oper_only=yes;
1108 /* stats P oper only: make stats P (ports) oper only
1109 * NOTE: users doing stats P will never be given the ips that the
1110 * server listens on, simply the ports.
1112 stats_P_oper_only=no;
1114 /* stats i oper only: make stats i (auth {}) oper only. set to:
1115 * yes: show users no auth blocks, made oper only.
1116 * masked: show users first matching auth block
1117 * no: show users all auth blocks.
1119 stats_i_oper_only=masked;
1121 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1122 * yes: show users no auth blocks, made oper only
1123 * masked: show users first matching auth block
1124 * no: show users all auth blocks.
1126 stats_k_oper_only=masked;
1128 /* map oper only: make /map oper only */
1131 /* operspy admin only: make operspy notices to +Z admin only */
1132 operspy_admin_only = no;
1134 /* operspy dont care user info: treat /who mask as if there was
1135 * an '!' always; do not log or server notice about operspy
1136 * /who mask, /masktrace and /scan. channel information is still
1138 operspy_dont_care_user_info = no;
1140 /* secret channels in whois: display secret channels in /whois
1141 * even if operspy was not used, as long as the oper doing the
1142 * whois has the oper:spy priv. this will not send any kind of
1144 secret_channels_in_whois = no;
1146 /* caller id wait: time between notifying a +g user that somebody
1147 * is messaging them.
1149 caller_id_wait = 1 minute;
1151 /* pace wait simple: time between use of less intensive commands
1152 * (HELP, remote WHOIS, WHOWAS)
1154 pace_wait_simple = 1 second;
1156 /* pace wait: time between more intensive commands
1157 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1159 pace_wait = 10 seconds;
1161 /* short motd: send clients a notice telling them to read the motd
1162 * instead of forcing a motd to clients who may simply ignore it.
1166 /* ping cookies: require clients to respond exactly to a ping command,
1167 * can help block certain types of drones and FTP PASV mode spoofing.
1171 /* connect timeout: sets how long we should wait for a connection
1172 * request to succeed
1174 connect_timeout = 30 seconds;
1176 /* disable auth: disables identd checking */
1179 /* no oper flood: increase flood limits for opers. */
1180 no_oper_flood = yes;
1182 /* REMOVE ME. The following line checks you've been reading. */
1183 havent_read_conf = yes;
1185 /* max targets: the maximum amount of targets in a single
1186 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1190 /* client flood: maximum number of lines in a clients queue before
1191 * they are dropped for flooding.
1195 /* use_whois_actually: send clients requesting a whois a numeric
1196 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1198 use_whois_actually = yes;
1200 /* usermodes configurable: a list of usermodes for the options below
1202 * +g - callerid - Server Side Ignore
1203 * +D - deaf - Don't see channel messages
1204 * +i - invisible - Not shown in NAMES or WHO unless you share a
1206 * +l - locops - See LOCOPS messages
1207 * +Q - noforward - Unaffected by channel forwarding
1208 * +R - regonlymsg - No messages from unindentified
1209 * +s - servnotice - See server notices
1210 * +w - wallop - See oper and server generated WALLOPS
1211 * +z - operwall - See operwalls
1212 * +C - noctcp - Block CTCPs to user.
1213 * +V - noinvite - Block INVITE to user.
1214 * +B - bot - Marks as a bot.
1217 /* oper only umodes: usermodes only opers may set */
1218 oper_only_umodes = operwall, locops, servnotice;
1220 /* oper umodes: default usermodes opers get when they /oper */
1221 oper_umodes = locops, servnotice, operwall, wallop;
1223 /* oper snomask: default snomask opers get when they /oper,
1224 * provided they have umode +s set */
1225 oper_snomask = "+s";
1227 /* use egd: if your system does not have *random devices yet you
1228 * want to use OpenSSL and encrypted links, enable this. Beware -
1229 * EGD is *very* CPU intensive when gathering data for its pool
1233 /* egdpool path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1234 * which automatically finds the path.
1236 #egdpool_path = "/var/run/egd-pool";
1239 /* compression level: level of compression for compressed links between
1242 * values are between: 1 (least compression, fastest)
1243 * and: 9 (most compression, slowest).
1245 #compression_level = 6;
1247 /* burst_away: This enables bursting away messages to servers.
1248 * With this disabled, we will only propogate AWAY messages
1249 * as users send them, but never burst them. Be warned though
1250 * enabling this could increase the size of a burst significantly
1251 * for a large network, like EFnet.
1255 /* nick delay: This locks nicks of split clients for the given time
1256 * or until a remote client uses the nick. This significantly
1257 * reduces nick collisions on short splits but it can be annoying.
1258 * To make things as fair as possible, this should be the same on
1259 * all servers. If you enable this, the suggested value is 15 minutes.
1261 nick_delay = 0 seconds;
1263 /* reject time: the amount of rejections through klines/dlines etc
1264 * allowed in the given time before the rejection is cached and
1265 * a pseudo temp dline is placed
1267 reject_ban_time = 1 minute;
1268 reject_after_count = 3;
1270 /* reject duration: the amount of time to cache the rejection */
1271 reject_duration = 5 minutes;
1273 /* throttle_duration: Amount of time that throttling will be applied to an IP
1276 throttle_duration = 60;
1278 /* throttle_count: Number of connections within throttle_duration that it takes
1279 * for throttling to take effect */
1284 /* module path: paths to search for modules specified below and
1287 path = "/usr/local/ircd/modules";
1288 path = "/usr/local/ircd/modules/autoload";
1290 /* module: the name of a module to load on startup/rehash */
1291 #module = "some_module.so";