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 * Charybdis contains several extensions that are not enabled by default.
45 * To use them, uncomment the lines below.
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
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 * New host mangling (umode +x) -- ip_cloaking_4.0.so
64 * Old host mangling (umode +h) -- 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 * Oper-override (modehacking only) -- override.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_4.0.so";
91 #loadmodule "extensions/ip_cloaking.so";
92 #loadmodule "extensions/m_findforwards.so";
93 #loadmodule "extensions/m_identify.so";
94 #loadmodule "extensions/no_oper_invis.so";
95 #loadmodule "extensions/sno_farconnect.so";
96 #loadmodule "extensions/sno_globalkline.so";
97 #loadmodule "extensions/sno_globaloper.so";
98 #loadmodule "extensions/sno_whois.so";
99 #loadmodule "extensions/override.so";
101 /* serverinfo {}: Contains information about the server. (OLD M:) */
103 /* name: the name of our server */
106 /* sid: the unique server id of our server. This must be three
107 * characters long. The first character must be a digit [0-9], the
108 * remaining two chars may be letters [A-Z] or digits [0-9].
110 * This parameter must be specified for the server to start.
114 /* description: the description of our server. '[' and ']' may not
115 * be used here for compatibility with older servers.
117 description = "charybdis test server";
119 /* network info: the name and description of the network this server
120 * is on. Shown in the 005 reply and used with serverhiding.
122 network_name = "MyNet";
123 network_desc = "This is My Network";
125 /* hub: allow this server to act as a hub and have multiple servers
130 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
131 * This should be an ipv4 IP only.
133 #vhost = "192.169.0.1";
135 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
136 * This should be an ipv6 IP only.
138 #vhost6 = "3ffe:80e8:546::2";
140 /* ssl_private_key: our ssl private key */
141 ssl_private_key = "etc/ssl.key";
143 /* ssl_cert: certificate for our ssl server */
144 ssl_cert = "etc/ssl.cert";
146 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
147 ssl_dh_params = "etc/dh.pem";
149 /* ssld_count: number of ssld processes you want to start, if you
150 * have a really busy server, using N-1 where N is the number of
151 * cpu/cpu cores you have might be useful. A number greater than one
152 * can also be useful in case of bugs in ssld and because ssld needs
153 * two file descriptors per SSL connection.
157 /* default max clients: the default maximum number of clients
158 * allowed to connect. This can be changed once ircd has started by
160 * /quote set maxclients <limit>
162 default_max_clients = 1024;
164 /* nicklen: enforced nickname length (for this server only; must not
165 * be longer than the maximum length set while building).
170 /* admin {}: contains admin information about the server. (OLD A:) */
172 name = "Smurf target";
173 description = "Main Server Administrator";
174 email = "<syn@packets.r.us>";
177 /* log {}: contains information about logfiles. */
179 /* logfiles: the logfiles to use for specific activity. if these
180 * paths are defined, then ircd will log to them, otherwise it wont.
182 * The confs are, in order:
183 * - userlog: user exits
184 * - fuserlog: failed user connections
185 * - operlog: /oper usage
186 * - foperlog: failed /oper usage
187 * - serverlog: server connects/disconnects
188 * - klinelog: klines, etc
190 * - operspylog: operspy usage
191 * - ioerrorlog: IO errors
193 fname_userlog = "logs/userlog";
194 #fname_fuserlog = "logs/fuserlog";
195 fname_operlog = "logs/operlog";
196 #fname_foperlog = "logs/foperlog";
197 fname_serverlog = "logs/serverlog";
198 #fname_klinelog = "logs/klinelog";
199 fname_killlog = "logs/killlog";
200 fname_operspylog = "logs/operspylog";
201 #fname_ioerrorlog = "logs/ioerror";
204 /* class {}: contain information about classes for users (OLD Y:) */
206 /* class name must go above */
208 /* ping time: how often a client must reply to a PING from the
209 * server before they are dropped.
211 ping_time = 2 minutes;
213 /* number per ident: the number of users per user@host networkwide
214 * allowed to connect. Unidented connections are classified as
217 number_per_ident = 2;
219 /* number per ip: the number of local users per host allowed */
222 /* number per ip global: the number of network wide connections
223 * per host allowed for a user, including connections to the
226 number_per_ip_global = 5;
228 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
230 cidr_ipv4_bitlen = 24;
232 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
233 * the following example makes the subnet /64 this is useful
234 * for IPv6 connections in particular
236 cidr_ipv6_bitlen = 64;
238 /* number_per_cidr: Number of connections to allow from a subnet of the
239 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
240 * 4 seems to be a good default to me.
244 /* max number: the maximum number of users allowed in this class */
247 /* sendq: the amount of data allowed in a clients queue before
254 ping_time = 1 minute 30 seconds;
261 ping_time = 5 minutes;
268 ping_time = 5 minutes;
270 /* connectfreq: only used in server classes. specifies the delay
271 * between autoconnecting to servers.
273 connectfreq = 5 minutes;
275 /* max number: the amount of servers to autoconnect to. if the number
276 * of servers in the class is or exceeds this, no more servers in the
277 * class are autoconnected. oper initiated connects are unaffected.
278 * this should usually be set to either 0 or 1. (autoconnecting from
279 * hubs to leaves may cause leaves to function as hubs by having
280 * multiple servers connected to them.)
284 /* sendq: servers need a higher sendq as they are sent more data */
288 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
290 /* defer_accept: wait for clients to send IRC handshake data before
291 * accepting them. if you intend to use software which depends on the
292 * server replying first, such as BOPM, you should disable this feature.
293 * otherwise, you probably want to leave it on.
297 /* port: the specific port to listen on. if no host is specified
298 * before, it will listen on all available IPs.
300 * sslport: the specific port to listen ssl connections on. if no
301 * host is specified before, it will listen on all available IPs.
303 * ports are seperated via a comma, a range may be specified using ".."
306 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
307 port = 5000, 6665 .. 6669;
309 /* sslport: listen for ssl connections on all available IPs, port 9999 */
312 /* host: set a specific IP/host the ports after the line will listen
313 * on. This may be ipv4 or ipv6.
317 sslport = 9000, 9001;
319 host = "3ffe:1234:a:b:c::d";
324 /* auth {}: allow users to connect to the ircd (OLD I:) */
326 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
327 * lines are permitted per auth block. This is matched against the
328 * hostname and IP address (using :: shortening for IPv6 and
329 * prepending a 0 if it starts with a colon) and can also use CIDR
332 user = "*@172.16.0.0/12";
333 user = "*test@123D:B567:*";
335 /* auth_user: This allows specifying a username:password instead of
336 * just a password in PASS, so that a fixed user@host is not
337 * necessary for a specific auth{} block.
339 #auth_user = "SomeUser";
341 /* password: an optional password that is required to use this block.
342 * By default this is not encrypted, specify the flag "encrypted" in
343 * flags = ...; below if it is.
345 password = "letmein";
347 /* spoof: fake the users user@host to be be this. You may either
348 * specify a host or a user@host to spoof to. This is free-form,
349 * just do everyone a favour and dont abuse it. (OLD I: = flag)
351 spoof = "I.still.hate.packets";
353 /* Possible flags in auth:
355 * encrypted | password is encrypted with mkpasswd
356 * spoof_notice | give a notice when spoofing hosts
357 * exceed_limit (old > flag) | allow user to exceed class user limits
358 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
359 * dnsbl_exempt | exempt this user from dnsbls
360 * spambot_exempt | exempt this user from spambot checks
361 * shide_exempt | exempt this user from serverhiding
362 * jupe_exempt | exempt this user from generating
363 * warnings joining juped channels
364 * resv_exempt | exempt this user from resvs
365 * flood_exempt | exempt this user from flood limits
367 * no_tilde (old - flag) | don't prefix ~ to username if no ident
368 * need_ident (old + flag) | require ident for user in this class
369 * need_ssl | require SSL/TLS for user in this class
370 * need_sasl | require SASL id for user in this class
372 flags = kline_exempt, exceed_limit;
374 /* class: the class the user is placed in */
379 /* redirect: the server and port to redirect a user to. A user does
380 * not have to obey the redirection, the ircd just suggests to them
381 * an alternative server.
383 redirserv = "irc.some.domain";
386 user = "*.some.domain";
388 /* class: a class is required even though it is not used */
397 /* privset{}: defines operator privilege sets. */
399 /* privs: controls the activities and commands an oper is
400 * allowed to do on the server
404 * oper:local_kill: allows local users to be /KILL'd
405 * oper:global_kill: allows local and remote users to be /KILL'd
406 * oper:routing: allows remote SQUIT and CONNECT
407 * oper:kline: allows KLINE and DLINE
408 * oper:unkline: allows UNKLINE and UNDLINE
409 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
410 * oper:rehash: allows oper to REHASH config
411 * oper:die: allows DIE and RESTART
412 * oper:admin: gives admin privileges. admins
413 * may (un)load modules and see various
414 * additional information.
415 * oper:hidden_admin: gives admin privileges except
416 * will not have the admin lines in
418 * oper:xline: allows use of /quote xline/unxline
419 * oper:resv: allows /quote resv/unresv and cmode +LP
420 * oper:operwall: allows the oper to send/receive operwalls
421 * oper:spy: allows 'operspy' features to see through +s
422 * channels etc. see /quote help operspy
423 * oper:hidden: hides the oper from /stats p
424 * oper:remoteban: allows remote kline etc
425 * oper:mass_notice: allows sending wallops and mass notices
427 privs = oper:local_kill, oper:operwall;
430 privset "server_bot" {
431 /* extends: a privset to inherit in this privset */
432 extends = "local_op";
433 privs = oper:kline, oper:remoteban, snomask:nick_changes;
436 privset "global_op" {
437 extends = "local_op";
438 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
439 oper:resv, oper:mass_notice, oper:remoteban;
443 extends = "global_op";
444 privs = oper:admin, oper:die, oper:rehash, oper:spy;
447 /* operator {}: defines ircd operators. (OLD O:) */
449 /* name: the name of the oper must go above */
451 /* user: the user@host required for this operator. CIDR *is*
452 * supported now. auth{} spoofs work here, other spoofs do not.
453 * multiple user="" lines are supported.
456 user = "*@127.0.0.1";
458 /* password: the password required to oper. Unless ~encrypted is
459 * contained in flags = ...; this will need to be encrypted using
460 * mkpasswd, MD5 is supported
462 password = "etcnjl8juSU1E";
464 /* rsa key: the public key for this oper when using Challenge.
465 * A password should not be defined when this is used, see
466 * doc/challenge.txt for more information.
468 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
470 /* fingerprint: if specified, the oper's client certificate
471 * fingerprint will be checked against the specified fingerprint
474 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
476 /* umodes: the specific umodes this oper gets when they oper.
477 * If this is specified an oper will not be given oper_umodes
478 * These are described above oper_only_umodes in general {};
480 #umodes = locops, servnotice, operwall, wallop;
482 /* snomask: specific server notice mask on oper up.
483 * If this is specified an oper will not be given oper_snomask.
485 snomask = "+Zbfkrsuy";
487 /* flags: misc options for the operator. You may prefix an option
488 * with ~ to disable it, e.g. ~encrypted.
490 * Default flags are encrypted.
494 * encrypted: the password above is encrypted [DEFAULT]
495 * need_ssl: must be using SSL/TLS to oper up
499 /* privset: privileges set to grant */
503 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
504 connect "irc.uplink.com" {
505 /* the name must go above */
507 /* host: the host or IP to connect to. If a hostname is used it
508 * must match the reverse dns of the server.
510 host = "192.168.0.1";
512 /* vhost: the host or IP to bind to for this connection. If this
513 * is not specified, the default vhost (in serverinfo {}) is used.
515 #vhost = "192.168.0.50";
517 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
518 * The remote server will have these passwords reversed.
520 send_password = "password";
521 accept_password = "anotherpassword";
523 /* fingerprint: if specified, the server's client certificate
524 * fingerprint will be checked against the specified fingerprint
527 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
529 /* port: the port to connect to this server on */
532 /* hub mask: the mask of servers that this server may hub. Multiple
533 * entries are permitted
537 /* leaf mask: the mask of servers this server may not hub. Multiple
538 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
542 /* class: the class this server is in */
545 /* flags: controls special options for this server
546 * encrypted - marks the accept_password as being crypt()'d
547 * autoconn - automatically connect to this server
548 * compressed - compress traffic via ziplinks
549 * topicburst - burst topics between servers
550 * ssl - ssl/tls encrypted server connections
552 flags = compressed, topicburst;
555 connect "ipv6.some.server" {
556 /* Hosts that are IPv6 addresses must be in :: shortened form
557 * if applicable. Addresses starting with a colon get an extra
558 * zero prepended, for example: 0::1
560 host = "3ffd:dead:beef::1";
561 send_password = "password";
562 accept_password = "password";
565 /* aftype: controls whether the connection uses "ipv4" or "ipv6".
572 connect "ssl.uplink.com" {
573 /* Example of ssl server-to-server connection, ssl flag doesn't need
574 * compressed flag, 'cause it uses own compression
576 host = "192.168.0.1";
577 send_password = "password";
578 accept_password = "anotherpassword";
582 flags = ssl, topicburst;
585 /* cluster {}; servers that we propagate things to automatically.
586 * NOTE: This does NOT grant them privileges to apply anything locally,
587 * you must add a seperate shared block for that. Clustering will
588 * only be done for actions by LOCAL opers, that arent directed
592 /* name: the server to share with, this can be a wildcard and may be
595 /* flags: list of what to share, all the name lines above this (up
596 * until another flags entry) will receive these flags.
598 * kline - share perm klines
599 * tkline - share temp klines
600 * unkline - share unklines
601 * locops - share locops
602 * xline - share perm xlines
603 * txline - share temp xlines
604 * unxline - share unxlines
605 * resv - share perm resvs
606 * tresv - share temp resvs
607 * unresv - share unresvs
608 * all - share all of the above
611 /* share klines/unklines/xlines with *.lan */
613 flags = kline, unkline, xline;
615 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
616 name = "irc.ircd-ratbox.org";
617 name = "ircd.ircd-ratbox.org";
621 /* service{}: privileged servers (services). These servers have extra
622 * privileges such as setting login names on users and introducing clients
623 * with umode +S (unkickable, hide channels, etc). This does not allow them
624 * to set bans, you need a separate shared{} for that.
625 * Do not place normal servers here.
626 * There may be only one service{} block.
629 /* name: the server name. These may be stacked. */
630 name = "services.int";
633 /* shared {}: users that are allowed to place remote bans on our server.
634 * NOTE: These are ordered top down. The first one the user@host and server
635 * matches will be used. Their access will then be decided on that
636 * block and will not fall back to another block that matches.
639 /* oper: the user@host and server the user must be on to set klines.
640 * The first field must be a user@host, the second field is an
641 * optional server. These may be stacked.
643 /* flags: list of what to allow them to place, all the oper lines
644 * above this (up until another flags entry) will receive these
645 * flags. This *must* be present.
647 * kline - allow setting perm/temp klines
648 * tkline - allow setting temp klines
649 * unkline - allow removing klines
650 * xline - allow setting perm/temp xlines
651 * txline - allow setting temp xlines
652 * unxline - allow removing xlines
653 * resv - allow setting perm/temp resvs
654 * tresv - allow setting temp resvs
655 * unresv - allow removing xlines
656 * all - allow oper/server to do all of above.
657 * locops - allow locops - only used for servers who cluster
658 * rehash - allow rehashing
659 * dline - allow setting perm/temp dlines
660 * tdline - allow setting temp dlines
661 * undline - allow removing dlines
662 * none - disallow everything
665 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
666 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
668 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
669 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
672 /* you may forbid certain opers/servers from doing anything */
673 oper = "irc@vanity.oper", "*";
674 oper = "*@*", "irc.vanity.server";
675 oper = "irc@another.vanity.oper", "bigger.vanity.server";
678 /* or allow everyone to place temp klines */
683 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
685 ip = "192.168.0.0/16";
687 /* these may be stacked */
692 /* The channel block contains options pertaining to channels */
694 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
695 * that can join a +i channel without an invite.
699 /* except: Enable/disable channel mode +e, a n!u@h list of masks
700 * that can join a channel through a ban (+b).
704 /* forward: Enable/disable channel mode +f, a channel to forward
705 * users to if they can't join because of +i etc. Also enables ban
706 * forwarding, <mask>$<channel>.
710 /* knock: Allows users to request an invite to a channel that
711 * is locked somehow (+ikl). If the channel is +p or you are banned
712 * the knock will not be sent.
716 /* knock delay: The amount of time a user must wait between issuing
719 knock_delay = 5 minutes;
721 /* knock channel delay: How often a knock to any specific channel
722 * is permitted, regardless of the user sending the knock.
724 knock_delay_channel = 1 minute;
726 /* max chans: The maximum number of channels a user can join/be on. */
727 max_chans_per_user = 15;
729 /* max bans: maximum number of +b/e/I/q modes in a channel */
732 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
733 max_bans_large = 500;
735 /* splitcode: split users, split servers and either no join on split
736 * or no create on split must be enabled for split checking.
737 * splitmode will be entered on either split users or split servers
738 * dropping below the limit.
740 * you may force splitmode to be permanent by /quote set splitmode on
743 /* split users: when the usercount is lower than this level, consider
744 * ourselves split. this must be set for automatic splitmode
746 default_split_user_count = 0;
748 /* split servers: when the amount of servers that have acknowledged
749 * theyve finished bursting is lower than this, consider ourselves
750 * split. this must be set for automatic splitmode
752 default_split_server_count = 0;
754 /* split: no create: disallow users creating channels on split */
755 no_create_on_split = no;
757 /* split: no join: disallow users joining channels at all on a split */
758 no_join_on_split = no;
760 /* burst topicwho: when bursting topics, also burst the topic setter */
761 burst_topicwho = yes;
763 /* kick on split riding: kick users riding splits to join +i or +k
764 * channels. more precisely, if a bursting server sends an SJOIN
765 * for a channel with a lower TS with either a +i mode or a +k
766 * mode with a different key, kick all local users.
768 * note: this does not take +r, +b, +e and +I into account.
770 kick_on_split_riding = no;
772 /* only ascii channels: disable local users joining channels
773 * containing characters outside the range 33-126 (non-printable
776 only_ascii_channels = no;
778 /* resv_forcepart: force any local users to part a channel
779 * when a RESV is issued.
781 resv_forcepart = yes;
783 /* channel target change: restrict how many channels users can
784 * message per unit of time. IRC operators, channel operators and
785 * voiced users are exempt.
787 channel_target_change = yes;
789 /* disable local channels: if yes, then local channels will not be
792 disable_local_channels = no;
796 /* The serverhide block contains the options regarding serverhiding */
798 /* flatten links: this option will hide various routing information
799 * and make all servers in /links appear that they are linked to
804 /* links delay: how long to wait before showing splits or new
805 * servers in a flattened /links output.
807 links_delay = 5 minutes;
809 /* hidden: hide this server from a /links output on servers with
810 * flatten_links enabled. this allows hub servers to be hidden etc.
814 /* disable hidden: prevent servers hiding themselves from a
820 /* These are the blacklist settings.
821 * You can have multiple combinations of host and rejection reasons.
822 * They are used in pairs of one host/rejection reason.
824 * These settings should be adequate for most networks, and are (presently)
825 * required for use on StaticBox.
827 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
830 * As of charybdis 2.2, you can do some keyword substitution on the rejection
831 * reason. The available keyword substitutions are:
833 * ${ip} - the user's IP
834 * ${host} - the user's canonical hostname
835 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
836 * ${nick} - the user's nickname
837 * ${network-name} - the name of the network
839 * As of charybdis 3.4, a type parameter is supported, which specifies the
840 * address families the blacklist supports. IPv4 and IPv6 are supported.
841 * IPv4 is currently the default as few blacklists support IPv6 operation
842 * as of this writing.
844 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
845 * contacted, via email, at admins@2mbit.com before using these BLs.
846 * See <http://www.ahbl.org/services.php> for more information.
849 host = "rbl.efnetrbl.org";
851 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
853 # 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";
859 # 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.";
861 /* Example of a blacklist that supports both IPv4 and IPv6 */
862 # host = "foobl.blacklist.invalid";
864 # reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for some reason. In order to protect ${network-name} from abuse, we are not allowing connections listed in ${dnsbl-host} to connect";
868 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
869 * They send PRIVMSG to the given target. A real command takes
870 * precedence above an alias.
873 /* the name must go above */
875 /* target: the target nick (must be a network service) or
876 * user@server (cannot be this server, only opers can use
877 * user starting with "opers" reliably, interpreted on the target
878 * server only so you may need to use nick@server instead)
911 /* The general block contains many of the options that were once compiled
912 * in options in config.h. The general block is read at start time.
915 /* hide error messages: defines whether error messages from
916 * servers that are not deemed fully safe are hidden or not.
917 * These can sometimes contain IPs and can have an adverse
918 * effect on server ip hiding. Set to:
919 * yes: hide from opers and admin
920 * opers: hide from opers only
921 * no: do not hide error messages
922 * Admins on other servers count as opers.
924 hide_error_messages = opers;
926 /* hide spoof ips: hide the real ips of auth{} spoofed users
927 * If disabled, local opers can see them.
928 * Dynamic spoofs (e.g. set by services) are unaffected by this;
929 * any oper (local and remote) can see the real ip.
930 * Warning: for whowas, this is checked when the client exits,
931 * not when the IP is shown.
933 hide_spoof_ips = yes;
935 /* default umodes: umodes to set upon connection
936 * If you have enabled the ip_cloaking extension, and you wish for
937 * incoming clients to be set +h or +x upon connection, add +h or +x to the umode
940 default_umodes = "+i";
942 /* default operstring: defines the default oper response
943 * in /whois queries, eg "is an IRC Operator".
944 * After startup use /quote set operstring to change.
946 default_operstring = "is an IRC Operator";
948 /* default adminstring: defines the default admin response
949 * in /whois queries, eg "is a Server Administrator".
950 * After startup use /quote set adminstring to change.
952 default_adminstring = "is a Server Administrator";
954 /* servicestring: defines the response for opered services (+S)
955 * in /whois queries, eg "is a Network Service".
956 * This is updated on rehash.
958 servicestring = "is a Network Service";
960 /* disable fake channels: disable local users joining fake versions
961 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
962 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
964 disable_fake_channels = no;
966 /* tkline_expire_notices: give a notice to opers when a tkline
969 tkline_expire_notices = no;
971 /* floodcount: the default value of floodcount that is configurable
972 * via /quote set floodcount. This is the amount of lines a user
973 * may send to any other user/channel in one second.
975 default_floodcount = 10;
977 /* failed oper notice: send a notice to all opers on the server when
978 * someone tries to OPER and uses the wrong password, host or ident.
980 failed_oper_notice = yes;
982 /* dots in ident: the amount of '.' characters permitted in an ident
983 * reply before the user is rejected.
987 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
988 * placed via the server. klines hand placed are exempt from limits.
989 * wildcard chars: '.' '*' '?' '@'
993 /* min nonwildcard simple: the minimum non wildcard characters in
994 * xlines/resvs placed via the server.
995 * wildcard chars: '*' '?'
997 min_nonwildcard_simple = 3;
999 /* max accept: maximum allowed /accept's for +g usermode */
1002 /* max monitor: the maximum amount of nicknames a client may have in
1003 * their monitor (server-side notify) list.
1007 /* nick flood: enable the nickflood control code */
1008 anti_nick_flood = yes;
1010 /* nick flood: the nick changes allowed in the specified period */
1011 max_nick_time = 20 seconds;
1012 max_nick_changes = 5;
1014 /* anti spam time: the minimum time a user must be connected before
1015 * custom quit messages are allowed.
1017 anti_spam_exit_message_time = 5 minutes;
1019 /* ts delta: the time delta allowed between server clocks before
1020 * a warning is given, or before the link is dropped. all servers
1021 * should run ntpdate/rdate to keep clocks in sync
1023 ts_warn_delta = 30 seconds;
1024 ts_max_delta = 5 minutes;
1026 /* client exit: prepend a user's quit message with "Quit: " */
1029 /* collision fnc: change user's nick to their UID instead of
1030 * killing them, if possible. This setting only applies to nick
1031 * collisions detected on this server. Only enable this if
1032 * all servers on the network allow remote nicks to start with
1035 collision_fnc = yes;
1037 /* resv fnc: change a user's nick to a nick they have recently used
1038 * (or their UID, if no such nick can be found) when a resv matching
1039 * them is set by services. Only enable this if all servers on the
1040 * network allow remote nicks to start with a digit.
1044 /* global snotices: send out certain snotices (most +b, +f, +y,
1045 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1046 * displayed unconditionally.
1048 global_snotices = yes;
1050 /* dline reason: show the user the dline reason when they connect
1053 dline_with_reason = yes;
1055 /* kline delay: delay the checking of klines until a specified time.
1056 * Useful if large kline lists are applied often to prevent the
1057 * server eating CPU.
1059 kline_delay = 0 seconds;
1061 /* kline reason: show the user the reason why they are k/dlined
1062 * on exit. may give away who set k/dline when set via tcm.
1064 kline_with_reason = yes;
1066 /* kline reason: make the users quit message on channels this
1067 * reason instead of the oper's reason.
1069 kline_reason = "Connection closed";
1071 /* identify to services via server password
1072 * if auth{} block had no password but the user specified a
1073 * server password anyway, send a PRIVMSG to <identify_service>
1074 * with as text <identify_command> <password>.
1076 identify_service = "NickServ@services.int";
1077 identify_command = "IDENTIFY";
1079 /* non redundant klines: flag and ignore redundant klines */
1080 non_redundant_klines = yes;
1082 /* warn no nline: warn opers about servers that try to connect but
1083 * we dont have a connect {} block for. Twits with misconfigured
1084 * servers can get really annoying with this enabled.
1086 warn_no_nline = yes;
1088 /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
1089 * That means the bans are part of the netburst and restarted/split
1090 * servers will get them, but they will not apply to 3.2 and older
1093 use_propagated_bans = yes;
1095 /* stats e disabled: disable stats e. useful if server ips are
1096 * exempted and you dont want them listing on irc.
1098 stats_e_disabled = no;
1100 /* stats c oper only: make stats c (connect {}) oper only */
1101 stats_c_oper_only=no;
1103 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
1104 stats_h_oper_only=no;
1106 /* stats y oper only: make stats y (class {}) oper only */
1107 stats_y_oper_only=no;
1109 /* stats o oper only: make stats o (opers) oper only */
1110 stats_o_oper_only=yes;
1112 /* stats P oper only: make stats P (ports) oper only
1113 * NOTE: users doing stats P will never be given the ips that the
1114 * server listens on, simply the ports.
1116 stats_P_oper_only=no;
1118 /* stats i oper only: make stats i (auth {}) oper only. set to:
1119 * yes: show users no auth blocks, made oper only.
1120 * masked: show users first matching auth block
1121 * no: show users all auth blocks.
1123 stats_i_oper_only=masked;
1125 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1126 * yes: show users no auth blocks, made oper only
1127 * masked: show users first matching auth block
1128 * no: show users all auth blocks.
1130 stats_k_oper_only=masked;
1132 /* map oper only: make /map oper only */
1135 /* operspy admin only: make operspy notices to +Z admin only */
1136 operspy_admin_only = no;
1138 /* operspy dont care user info: treat /who mask as if there was
1139 * an '!' always; do not log or server notice about operspy
1140 * /who mask, /masktrace and /scan. channel information is still
1142 operspy_dont_care_user_info = no;
1144 /* caller id wait: time between notifying a +g user that somebody
1145 * is messaging them.
1147 caller_id_wait = 1 minute;
1149 /* pace wait simple: time between use of less intensive commands
1150 * (HELP, remote WHOIS, WHOWAS)
1152 pace_wait_simple = 1 second;
1154 /* pace wait: time between more intensive commands
1155 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1157 pace_wait = 10 seconds;
1159 /* short motd: send clients a notice telling them to read the motd
1160 * instead of forcing a motd to clients who may simply ignore it.
1164 /* ping cookies: require clients to respond exactly to a ping command,
1165 * can help block certain types of drones and FTP PASV mode spoofing.
1169 /* connect timeout: sets how long we should wait for a connection
1170 * request to succeed
1172 connect_timeout = 30 seconds;
1174 /* ident timeout: Amount of time (in seconds) that the IRCd will
1175 * wait for a user to respond to an ident request.
1177 default_ident_timeout = 5;
1179 /* disable auth: disables identd checking */
1182 /* no oper flood: increase flood limits for opers. */
1183 no_oper_flood = yes;
1185 /* REMOVE ME. The following line checks you've been reading. */
1186 havent_read_conf = yes;
1188 /* max targets: the maximum amount of targets in a single
1189 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1193 /* use_whois_actually: send clients requesting a whois a numeric
1194 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1196 use_whois_actually = yes;
1198 /* usermodes configurable: a list of usermodes for the options below
1200 * +g - callerid - Server Side Ignore
1201 * +D - deaf - Don't see channel messages
1202 * +i - invisible - Not shown in NAMES or WHO unless you share a
1204 * +l - locops - See LOCOPS messages
1205 * +Q - noforward - Unaffected by channel forwarding
1206 * +R - regonlymsg - No messages from unindentified
1207 * +s - servnotice - See server notices
1208 * +w - wallop - See oper and server generated WALLOPS
1209 * +z - operwall - See operwalls
1212 /* oper only umodes: usermodes only opers may set */
1213 oper_only_umodes = operwall, locops, servnotice;
1215 /* oper umodes: default usermodes opers get when they /oper */
1216 oper_umodes = locops, servnotice, operwall, wallop;
1218 /* oper snomask: default snomask opers get when they /oper,
1219 * provided they have umode +s set */
1220 oper_snomask = "+s";
1222 /* use egd: if your system does not have *random devices yet you
1223 * want to use OpenSSL and encrypted links, enable this. Beware -
1224 * EGD is *very* CPU intensive when gathering data for its pool
1228 /* egdpool path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1229 * which automatically finds the path.
1231 #egdpool_path = "/var/run/egd-pool";
1234 /* compression level: level of compression for compressed links between
1237 * values are between: 1 (least compression, fastest)
1238 * and: 9 (most compression, slowest).
1240 #compression_level = 6;
1242 /* burst_away: This enables bursting away messages to servers.
1243 * With this disabled, we will only propogate AWAY messages
1244 * as users send them, but never burst them. Be warned though
1245 * enabling this could increase the size of a burst significantly
1246 * for a large network, like EFnet.
1250 /* nick delay: This locks nicks of split clients for the given time
1251 * or until a remote client uses the nick. This significantly
1252 * reduces nick collisions on short splits but it can be annoying.
1253 * To make things as fair as possible, this should be the same on
1254 * all servers. If you enable this, the suggested value is 15 minutes.
1256 nick_delay = 0 seconds;
1258 /* reject time: the amount of rejections through klines/dlines etc
1259 * allowed in the given time before the rejection is cached and
1260 * a pseudo temp dline is placed
1262 reject_ban_time = 1 minute;
1263 reject_after_count = 3;
1265 /* reject duration: the amount of time to cache the rejection */
1266 reject_duration = 5 minutes;
1268 /* throttle_duration: Amount of time that throttling will be applied to an IP
1271 throttle_duration = 60;
1273 /* throttle_count: Number of connections within throttle_duration that it takes
1274 * for throttling to take effect */
1277 /* client flood_max_lines: maximum number of lines in a clients queue before
1278 * they are dropped for flooding.
1280 client_flood_max_lines = 20;
1282 /* Flood control settings. DO NOT CHANGE THESE without extensive discussion
1283 * and testing by someone who knows exactly what they do.
1285 * These settings replicate charybdis-3.3 behaviour.
1287 client_flood_burst_rate = 40;
1288 client_flood_burst_max = 5;
1289 client_flood_message_time = 1;
1290 client_flood_message_num = 2;
1292 /* max_ratelimit_tokens: the maximum number of ratelimit tokens that one
1293 * user can accumulate. This attempts to limit the amount of outbound
1294 * bandwidth one user can consume. Do not change unless you know what
1297 max_ratelimit_tokens = 30;
1299 /* away_interval: the minimum interval between AWAY commands. One
1300 * additional AWAY command is allowed, and only marking as away
1307 /* module path: paths to search for modules specified below and
1310 path = "/usr/local/ircd/modules";
1311 path = "/usr/local/ircd/modules/autoload";
1313 /* module: the name of a module to load on startup/rehash */
1314 #module = "some_module.so";