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;
165 /* admin {}: contains admin information about the server. (OLD A:) */
167 name = "Smurf target";
168 description = "Main Server Administrator";
169 email = "<syn@packets.r.us>";
172 /* log {}: contains information about logfiles. */
174 /* logfiles: the logfiles to use for specific activity. if these
175 * paths are defined, then ircd will log to them, otherwise it wont.
177 * The confs are, in order:
178 * - userlog: user exits
179 * - fuserlog: failed user connections
180 * - operlog: /oper usage
181 * - foperlog: failed /oper usage
182 * - serverlog: server connects/disconnects
183 * - klinelog: klines, etc
185 * - operspylog: operspy usage
186 * - ioerrorlog: IO errors
188 fname_userlog = "logs/userlog";
189 #fname_fuserlog = "logs/fuserlog";
190 fname_operlog = "logs/operlog";
191 #fname_foperlog = "logs/foperlog";
192 fname_serverlog = "logs/serverlog";
193 #fname_klinelog = "logs/klinelog";
194 fname_killlog = "logs/killlog";
195 fname_operspylog = "logs/operspylog";
196 #fname_ioerrorlog = "logs/ioerror";
199 /* class {}: contain information about classes for users (OLD Y:) */
201 /* class name must go above */
203 /* ping time: how often a client must reply to a PING from the
204 * server before they are dropped.
206 ping_time = 2 minutes;
208 /* number per ident: the number of users per user@host networkwide
209 * allowed to connect. Unidented connections are classified as
212 number_per_ident = 2;
214 /* number per ip: the number of local users per host allowed */
217 /* number per ip global: the number of network wide connections
218 * per host allowed for a user, including connections to the
221 number_per_ip_global = 5;
223 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
225 cidr_ipv4_bitlen = 24;
227 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
228 * the following example makes the subnet /64 this is useful
229 * for IPv6 connections in particular
231 cidr_ipv6_bitlen = 64;
233 /* number_per_cidr: Number of connections to allow from a subnet of the
234 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
235 * 4 seems to be a good default to me.
239 /* max number: the maximum number of users allowed in this class */
242 /* sendq: the amount of data allowed in a clients queue before
249 ping_time = 1 minute 30 seconds;
256 ping_time = 5 minutes;
263 ping_time = 5 minutes;
265 /* connectfreq: only used in server classes. specifies the delay
266 * between autoconnecting to servers.
268 connectfreq = 5 minutes;
270 /* max number: the amount of servers to autoconnect to */
273 /* sendq: servers need a higher sendq as they are sent more data */
277 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
279 /* port: the specific port to listen on. if no host is specified
280 * before, it will listen on all available IPs.
282 * sslport: the specific port to listen ssl connections on. if no
283 * host is specified before, it will listen on all available IPs.
285 * ports are seperated via a comma, a range may be specified using ".."
288 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
289 port = 5000, 6665 .. 6669;
291 /* sslport: listen for ssl connections on all available IPs, port 9999 */
294 /* host: set a specific IP/host the ports after the line will listen
295 * on. This may be ipv4 or ipv6.
299 sslport = 9000, 9001;
301 host = "3ffe:1234:a:b:c::d";
306 /* auth {}: allow users to connect to the ircd (OLD I:) */
308 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
309 * lines are permitted per auth block. This is matched against the
310 * hostname and IP address (using :: shortening for IPv6 and
311 * prepending a 0 if it starts with a colon) and can also use CIDR
314 user = "*@172.16.0.0/12";
315 user = "*test@123D:B567:*";
317 /* password: an optional password that is required to use this block.
318 * By default this is not encrypted, specify the flag "encrypted" in
319 * flags = ...; below if it is.
321 password = "letmein";
323 /* spoof: fake the users user@host to be be this. You may either
324 * specify a host or a user@host to spoof to. This is free-form,
325 * just do everyone a favour and dont abuse it. (OLD I: = flag)
327 spoof = "I.still.hate.packets";
329 /* Possible flags in auth:
331 * encrypted | password is encrypted with mkpasswd
332 * spoof_notice | give a notice when spoofing hosts
333 * exceed_limit (old > flag) | allow user to exceed class user limits
334 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
335 * dnsbl_exempt | exempt this user from dnsbls
336 * spambot_exempt | exempt this user from spambot checks
337 * shide_exempt | exempt this user from serverhiding
338 * jupe_exempt | exempt this user from generating
339 * warnings joining juped channels
340 * resv_exempt | exempt this user from resvs
341 * flood_exempt | exempt this user from flood limits
343 * no_tilde (old - flag) | don't prefix ~ to username if no ident
344 * need_ident (old + flag) | require ident for user in this class
345 * need_ssl | require SSL/TLS for user in this class
346 * need_sasl | require SASL id for user in this class
348 flags = kline_exempt, exceed_limit;
350 /* class: the class the user is placed in */
355 /* redirect: the server and port to redirect a user to. A user does
356 * not have to obey the redirection, the ircd just suggests to them
357 * an alternative server.
359 redirserv = "irc.some.domain";
362 user = "*.some.domain";
364 /* class: a class is required even though it is not used */
375 /* privset{}: defines operator privilege sets. */
377 /* privs: controls the activities and commands an oper is
378 * allowed to do on the server
382 * oper:local_kill: allows local users to be /KILL'd
383 * oper:global_kill: allows local and remote users to be /KILL'd
384 * oper:routing: allows remote SQUIT and CONNECT
385 * oper:kline: allows KLINE and DLINE
386 * oper:unkline: allows UNKLINE and UNDLINE
387 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
388 * oper:rehash: allows oper to REHASH config
389 * oper:die: allows DIE and RESTART
390 * oper:admin: gives admin privileges. admins
391 * may (un)load modules and see various
392 * additional information.
393 * oper:hidden_admin: gives admin privileges except
394 * will not have the admin lines in
396 * oper:xline: allows use of /quote xline/unxline
397 * oper:resv: allows /quote resv/unresv and cmode +LP
398 * oper:operwall: allows the oper to send/receive operwalls
399 * oper:spy: allows 'operspy' features to see through +s
400 * channels etc. see /quote help operspy
401 * oper:hidden: hides the oper from /stats p
402 * oper:remoteban: allows remote kline etc
403 * oper:mass_notice: allows sending wallops and mass notices
405 privs = oper:local_kill, oper:operwall;
408 privset "server_bot" {
409 /* extends: a privset to inherit in this privset */
410 extends = "local_op";
411 privs = oper:kline, oper:remoteban, snomask:nick_changes;
414 privset "global_op" {
415 extends = "local_op";
416 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
417 oper:resv, oper:mass_notice, oper:remoteban;
421 extends = "global_op";
422 privs = oper:admin, oper:die, oper:rehash, oper:spy;
425 /* operator {}: defines ircd operators. (OLD O:) */
427 /* name: the name of the oper must go above */
429 /* user: the user@host required for this operator. CIDR *is*
430 * supported now. auth{} spoofs work here, other spoofs do not.
431 * multiple user="" lines are supported.
434 user = "*@127.0.0.1";
436 /* password: the password required to oper. Unless ~encrypted is
437 * contained in flags = ...; this will need to be encrypted using
438 * mkpasswd, MD5 is supported
440 password = "etcnjl8juSU1E";
442 /* rsa key: the public key for this oper when using Challenge.
443 * A password should not be defined when this is used, see
444 * doc/challenge.txt for more information.
446 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
448 /* fingerprint: if specified, the oper's client certificate
449 * fingerprint will be checked against the specified fingerprint
452 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
454 /* umodes: the specific umodes this oper gets when they oper.
455 * If this is specified an oper will not be given oper_umodes
456 * These are described above oper_only_umodes in general {};
458 #umodes = locops, servnotice, operwall, wallop;
460 /* snomask: specific server notice mask on oper up.
461 * If this is specified an oper will not be given oper_snomask.
463 snomask = "+Zbfkrsuy";
465 /* flags: misc options for the operator. You may prefix an option
466 * with ~ to disable it, e.g. ~encrypted.
468 * Default flags are encrypted.
472 * encrypted: the password above is encrypted [DEFAULT]
473 * need_ssl: must be using SSL/TLS to oper up
477 /* privset: privileges set to grant */
481 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
482 connect "irc.uplink.com" {
483 /* the name must go above */
485 /* host: the host or IP to connect to. If a hostname is used it
486 * must match the reverse dns of the server.
488 host = "192.168.0.1";
490 /* vhost: the host or IP to bind to for this connection. If this
491 * is not specified, the default vhost (in serverinfo {}) is used.
493 #vhost = "192.168.0.50";
495 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
496 * The remote server will have these passwords reversed.
498 send_password = "password";
499 accept_password = "anotherpassword";
501 /* fingerprint: if specified, the server's client certificate
502 * fingerprint will be checked against the specified fingerprint
505 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
507 /* port: the port to connect to this server on */
510 /* hub mask: the mask of servers that this server may hub. Multiple
511 * entries are permitted
515 /* leaf mask: the mask of servers this server may not hub. Multiple
516 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
520 /* class: the class this server is in */
523 /* flags: controls special options for this server
524 * encrypted - marks the accept_password as being crypt()'d
525 * autoconn - automatically connect to this server
526 * compressed - compress traffic via ziplinks
527 * topicburst - burst topics between servers
528 * ssl - ssl/tls encrypted server connections
530 flags = compressed, topicburst;
533 connect "ipv6.some.server" {
534 /* Hosts that are IPv6 addresses must be in :: shortened form
535 * if applicable. Addresses starting with a colon get an extra
536 * zero prepended, for example: 0::1
538 host = "3ffd:dead:beef::1";
539 send_password = "password";
540 accept_password = "password";
543 /* aftype: controls whether the connection uses "ipv4" or "ipv6".
550 connect "ssl.uplink.com" {
551 /* Example of ssl server-to-server connection, ssl flag doesn't need
552 * compressed flag, 'cause it uses own compression
554 host = "192.168.0.1";
555 send_password = "password";
556 accept_password = "anotherpassword";
560 flags = ssl, topicburst;
563 /* cluster {}; servers that we propagate things to automatically.
564 * NOTE: This does NOT grant them privileges to apply anything locally,
565 * you must add a seperate shared block for that. Clustering will
566 * only be done for actions by LOCAL opers, that arent directed
570 /* name: the server to share with, this can be a wildcard and may be
573 /* flags: list of what to share, all the name lines above this (up
574 * until another flags entry) will receive these flags.
576 * kline - share perm klines
577 * tkline - share temp klines
578 * unkline - share unklines
579 * locops - share locops
580 * xline - share perm xlines
581 * txline - share temp xlines
582 * unxline - share unxlines
583 * resv - share perm resvs
584 * tresv - share temp resvs
585 * unresv - share unresvs
586 * all - share all of the above
589 /* share klines/unklines/xlines with *.lan */
591 flags = kline, unkline, xline;
593 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
594 name = "irc.ircd-ratbox.org";
595 name = "ircd.ircd-ratbox.org";
599 /* service{}: privileged servers (services). These servers have extra
600 * privileges such as setting login names on users and introducing clients
601 * with umode +S (unkickable, hide channels, etc). This does not allow them
602 * to set bans, you need a separate shared{} for that.
603 * Do not place normal servers here.
604 * There may be only one service{} block.
607 /* name: the server name. These may be stacked. */
608 name = "services.int";
611 /* shared {}: users that are allowed to place remote bans on our server.
612 * NOTE: These are ordered top down. The first one the user@host and server
613 * matches will be used. Their access will then be decided on that
614 * block and will not fall back to another block that matches.
617 /* oper: the user@host and server the user must be on to set klines.
618 * The first field must be a user@host, the second field is an
619 * optional server. These may be stacked.
621 /* flags: list of what to allow them to place, all the oper lines
622 * above this (up until another flags entry) will receive these
623 * flags. This *must* be present.
625 * kline - allow setting perm/temp klines
626 * tkline - allow setting temp klines
627 * unkline - allow removing klines
628 * xline - allow setting perm/temp xlines
629 * txline - allow setting temp xlines
630 * unxline - allow removing xlines
631 * resv - allow setting perm/temp resvs
632 * tresv - allow setting temp resvs
633 * unresv - allow removing xlines
634 * all - allow oper/server to do all of above.
635 * locops - allow locops - only used for servers who cluster
636 * rehash - allow rehashing
637 * dline - allow setting perm/temp dlines
638 * tdline - allow setting temp dlines
639 * undline - allow removing dlines
640 * none - disallow everything
643 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
644 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
646 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
647 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
650 /* you may forbid certain opers/servers from doing anything */
651 oper = "irc@vanity.oper", "*";
652 oper = "*@*", "irc.vanity.server";
653 oper = "irc@another.vanity.oper", "bigger.vanity.server";
656 /* or allow everyone to place temp klines */
661 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
663 ip = "192.168.0.0/16";
665 /* these may be stacked */
670 /* The channel block contains options pertaining to channels */
672 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
673 * that can join a +i channel without an invite.
677 /* except: Enable/disable channel mode +e, a n!u@h list of masks
678 * that can join a channel through a ban (+b).
682 /* knock: Allows users to request an invite to a channel that
683 * is locked somehow (+ikl). If the channel is +p or you are banned
684 * the knock will not be sent.
688 /* knock delay: The amount of time a user must wait between issuing
691 knock_delay = 5 minutes;
693 /* knock channel delay: How often a knock to any specific channel
694 * is permitted, regardless of the user sending the knock.
696 knock_delay_channel = 1 minute;
698 /* max chans: The maximum number of channels a user can join/be on. */
699 max_chans_per_user = 15;
701 /* max bans: maximum number of +b/e/I/q modes in a channel */
704 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
705 max_bans_large = 500;
707 /* splitcode: split users, split servers and either no join on split
708 * or no create on split must be enabled for split checking.
709 * splitmode will be entered on either split users or split servers
710 * dropping below the limit.
712 * you may force splitmode to be permanent by /quote set splitmode on
715 /* split users: when the usercount is lower than this level, consider
716 * ourselves split. this must be set for automatic splitmode
718 default_split_user_count = 0;
720 /* split servers: when the amount of servers that have acknowledged
721 * theyve finished bursting is lower than this, consider ourselves
722 * split. this must be set for automatic splitmode
724 default_split_server_count = 0;
726 /* split: no create: disallow users creating channels on split */
727 no_create_on_split = no;
729 /* split: no join: disallow users joining channels at all on a split */
730 no_join_on_split = no;
732 /* burst topicwho: when bursting topics, also burst the topic setter */
733 burst_topicwho = yes;
735 /* kick on split riding: kick users riding splits to join +i or +k
736 * channels. more precisely, if a bursting server sends an SJOIN
737 * for a channel with a lower TS with either a +i mode or a +k
738 * mode with a different key, kick all local users.
740 * note: this does not take +r, +b, +e and +I into account.
742 * warning: if there are any TS5 servers on the network, this
743 * will cause ban desyncs if they send such an SJOIN and the
744 * splitriders added any bans (our side will lose them, the TS5
745 * side will accept them). we will send a notice to the channel
746 * if this happens. most services do not send such SJOINs but
747 * ratbox-services does.
749 kick_on_split_riding = no;
751 /* only ascii channels: disable local users joining channels
752 * containing characters outside the range 33-126 (non-printable
755 only_ascii_channels = no;
757 /* resv_forcepart: force any local users to part a channel
758 * when a RESV is issued.
760 resv_forcepart = yes;
762 /* channel target change: restrict how many channels users can
763 * message per unit of time. IRC operators, channel operators and
764 * voiced users are exempt.
766 channel_target_change = yes;
768 /* disable local channels: if yes, then local channels will not be
771 disable_local_channels = no;
775 /* The serverhide block contains the options regarding serverhiding */
777 /* flatten links: this option will hide various routing information
778 * and make all servers in /links appear that they are linked to
783 /* links delay: how long to wait before showing splits or new
784 * servers in a flattened /links output.
786 links_delay = 5 minutes;
788 /* hidden: hide this server from a /links output on servers with
789 * flatten_links enabled. this allows hub servers to be hidden etc.
793 /* disable hidden: prevent servers hiding themselves from a
799 /* These are the blacklist settings.
800 * You can have multiple combinations of host and rejection reasons.
801 * They are used in pairs of one host/rejection reason.
803 * These settings should be adequate for most networks, and are (presently)
804 * required for use on StaticBox.
806 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
809 * As of charybdis 2.2, you can do some keyword substitution on the rejection
810 * reason. The available keyword substitutions are:
812 * ${ip} - the user's IP
813 * ${host} - the user's canonical hostname
814 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
815 * ${nick} - the user's nickname
816 * ${network-name} - the name of the network
818 * As of charybdis 3.4, a type parameter is supported, which specifies the
819 * address families the blacklist supports. IPv4 and IPv6 are supported.
820 * IPv4 is currently the default as few blacklists support IPv6 operation
821 * as of this writing.
823 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
824 * contacted, via email, at admins@2mbit.com before using these BLs.
825 * See <http://www.ahbl.org/services.php> for more information.
828 host = "rbl.efnetrbl.org";
830 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
832 # host = "ircbl.ahbl.org";
834 # 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.";
836 # host = "tor.ahbl.org";
838 # 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.";
840 /* Example of a blacklist that supports both IPv4 and IPv6 */
841 # host = "foobl.blacklist.invalid";
843 # 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";
847 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
848 * They send PRIVMSG to the given target. A real command takes
849 * precedence above an alias.
852 /* the name must go above */
854 /* target: the target nick (must be a network service) or
855 * user@server (cannot be this server, only opers can use
856 * user starting with "opers" reliably, interpreted on the target
857 * server only so you may need to use nick@server instead)
890 /* The general block contains many of the options that were once compiled
891 * in options in config.h. The general block is read at start time.
894 /* hide error messages: defines whether error messages from
895 * servers that are not deemed fully safe are hidden or not.
896 * These can sometimes contain IPs and can have an adverse
897 * effect on server ip hiding. Set to:
898 * yes: hide from opers and admin
899 * opers: hide from opers only
900 * no: do not hide error messages
901 * Admins on other servers count as opers.
903 hide_error_messages = opers;
905 /* hide spoof ips: hide the real ips of auth{} spoofed users
906 * If disabled, local opers can see them.
907 * Dynamic spoofs (e.g. set by services) are unaffected by this;
908 * any oper (local and remote) can see the real ip.
909 * Warning: for whowas, this is checked when the client exits,
910 * not when the IP is shown.
912 hide_spoof_ips = yes;
914 /* default umodes: umodes to set upon connection
915 * If you have enabled the ip_cloaking extension, and you wish for
916 * incoming clients to be set +h or +x upon connection, add +h or +x to the umode
919 default_umodes = "+i";
921 /* default operstring: defines the default oper response
922 * in /whois queries, eg "is an IRC Operator".
923 * After startup use /quote set operstring to change.
925 default_operstring = "is an IRC Operator";
927 /* default adminstring: defines the default admin response
928 * in /whois queries, eg "is a Server Administrator".
929 * After startup use /quote set adminstring to change.
931 default_adminstring = "is a Server Administrator";
933 /* servicestring: defines the response for opered services (+S)
934 * in /whois queries, eg "is a Network Service".
935 * This is updated on rehash.
937 servicestring = "is a Network Service";
939 /* disable fake channels: disable local users joining fake versions
940 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
941 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
943 disable_fake_channels = no;
945 /* tkline_expire_notices: give a notice to opers when a tkline
948 tkline_expire_notices = no;
950 /* floodcount: the default value of floodcount that is configurable
951 * via /quote set floodcount. This is the amount of lines a user
952 * may send to any other user/channel in one second.
954 default_floodcount = 10;
956 /* failed oper notice: send a notice to all opers on the server when
957 * someone tries to OPER and uses the wrong password, host or ident.
959 failed_oper_notice = yes;
961 /* dots in ident: the amount of '.' characters permitted in an ident
962 * reply before the user is rejected.
966 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
967 * placed via the server. klines hand placed are exempt from limits.
968 * wildcard chars: '.' '*' '?' '@'
972 /* min nonwildcard simple: the minimum non wildcard characters in
973 * xlines/resvs placed via the server.
974 * wildcard chars: '*' '?'
976 min_nonwildcard_simple = 3;
978 /* max accept: maximum allowed /accept's for +g usermode */
981 /* max monitor: the maximum amount of nicknames a client may have in
982 * their monitor (server-side notify) list.
986 /* nick flood: enable the nickflood control code */
987 anti_nick_flood = yes;
989 /* nick flood: the nick changes allowed in the specified period */
990 max_nick_time = 20 seconds;
991 max_nick_changes = 5;
993 /* anti spam time: the minimum time a user must be connected before
994 * custom quit messages are allowed.
996 anti_spam_exit_message_time = 5 minutes;
998 /* ts delta: the time delta allowed between server clocks before
999 * a warning is given, or before the link is dropped. all servers
1000 * should run ntpdate/rdate to keep clocks in sync
1002 ts_warn_delta = 30 seconds;
1003 ts_max_delta = 5 minutes;
1005 /* client exit: prepend a users quit message with "Client exit: " */
1008 /* collision fnc: change user's nick to their UID instead of
1009 * killing them, if possible. This setting only applies to nick
1010 * collisions detected on this server. Only enable this if
1011 * all servers on the network allow remote nicks to start with
1014 collision_fnc = yes;
1016 /* global snotices: send out certain snotices (most +b, +f, +y,
1017 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1018 * displayed unconditionally.
1020 global_snotices = yes;
1022 /* dline reason: show the user the dline reason when they connect
1025 dline_with_reason = yes;
1027 /* kline delay: delay the checking of klines until a specified time.
1028 * Useful if large kline lists are applied often to prevent the
1029 * server eating CPU.
1031 kline_delay = 0 seconds;
1033 /* kline reason: show the user the reason why they are k/dlined
1034 * on exit. may give away who set k/dline when set via tcm.
1036 kline_with_reason = yes;
1038 /* kline reason: make the users quit message on channels this
1039 * reason instead of the oper's reason.
1041 kline_reason = "Connection closed";
1043 /* identify to services via server password
1044 * if auth{} block had no password but the user specified a
1045 * server password anyway, send a PRIVMSG to <identify_service>
1046 * with as text <identify_command> <password>.
1048 identify_service = "NickServ@services.int";
1049 identify_command = "IDENTIFY";
1051 /* non redundant klines: flag and ignore redundant klines */
1052 non_redundant_klines = yes;
1054 /* warn no nline: warn opers about servers that try to connect but
1055 * we dont have a connect {} block for. Twits with misconfigured
1056 * servers can get really annoying with this enabled.
1058 warn_no_nline = yes;
1060 /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
1061 * That means the bans are part of the netburst and restarted/split
1062 * servers will get them, but they will not apply to 3.2 and older
1065 use_propagated_bans = yes;
1067 /* stats e disabled: disable stats e. useful if server ips are
1068 * exempted and you dont want them listing on irc.
1070 stats_e_disabled = no;
1072 /* stats c oper only: make stats c (connect {}) oper only */
1073 stats_c_oper_only=no;
1075 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
1076 stats_h_oper_only=no;
1078 /* stats y oper only: make stats y (class {}) oper only */
1079 stats_y_oper_only=no;
1081 /* stats o oper only: make stats o (opers) oper only */
1082 stats_o_oper_only=yes;
1084 /* stats P oper only: make stats P (ports) oper only
1085 * NOTE: users doing stats P will never be given the ips that the
1086 * server listens on, simply the ports.
1088 stats_P_oper_only=no;
1090 /* stats i oper only: make stats i (auth {}) oper only. set to:
1091 * yes: show users no auth blocks, made oper only.
1092 * masked: show users first matching auth block
1093 * no: show users all auth blocks.
1095 stats_i_oper_only=masked;
1097 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1098 * yes: show users no auth blocks, made oper only
1099 * masked: show users first matching auth block
1100 * no: show users all auth blocks.
1102 stats_k_oper_only=masked;
1104 /* map oper only: make /map oper only */
1107 /* operspy admin only: make operspy notices to +Z admin only */
1108 operspy_admin_only = no;
1110 /* operspy dont care user info: treat /who mask as if there was
1111 * an '!' always; do not log or server notice about operspy
1112 * /who mask, /masktrace and /scan. channel information is still
1114 operspy_dont_care_user_info = no;
1116 /* caller id wait: time between notifying a +g user that somebody
1117 * is messaging them.
1119 caller_id_wait = 1 minute;
1121 /* pace wait simple: time between use of less intensive commands
1122 * (HELP, remote WHOIS, WHOWAS)
1124 pace_wait_simple = 1 second;
1126 /* pace wait: time between more intensive commands
1127 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1129 pace_wait = 10 seconds;
1131 /* short motd: send clients a notice telling them to read the motd
1132 * instead of forcing a motd to clients who may simply ignore it.
1136 /* ping cookies: require clients to respond exactly to a ping command,
1137 * can help block certain types of drones and FTP PASV mode spoofing.
1141 /* connect timeout: sets how long we should wait for a connection
1142 * request to succeed
1144 connect_timeout = 30 seconds;
1146 /* ident timeout: Amount of time (in seconds) that the IRCd will
1147 * wait for a user to respond to an ident request.
1149 default_ident_timeout = 5;
1151 /* disable auth: disables identd checking */
1154 /* no oper flood: increase flood limits for opers. */
1155 no_oper_flood = yes;
1157 /* REMOVE ME. The following line checks you've been reading. */
1158 havent_read_conf = yes;
1160 /* max targets: the maximum amount of targets in a single
1161 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1165 /* use_whois_actually: send clients requesting a whois a numeric
1166 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1168 use_whois_actually = yes;
1170 /* usermodes configurable: a list of usermodes for the options below
1172 * +g - callerid - Server Side Ignore
1173 * +D - deaf - Don't see channel messages
1174 * +i - invisible - Not shown in NAMES or WHO unless you share a
1176 * +l - locops - See LOCOPS messages
1177 * +Q - noforward - Unaffected by channel forwarding
1178 * +R - regonlymsg - No messages from unindentified
1179 * +s - servnotice - See server notices
1180 * +w - wallop - See oper and server generated WALLOPS
1181 * +z - operwall - See operwalls
1184 /* oper only umodes: usermodes only opers may set */
1185 oper_only_umodes = operwall, locops, servnotice;
1187 /* oper umodes: default usermodes opers get when they /oper */
1188 oper_umodes = locops, servnotice, operwall, wallop;
1190 /* oper snomask: default snomask opers get when they /oper,
1191 * provided they have umode +s set */
1192 oper_snomask = "+s";
1194 /* use egd: if your system does not have *random devices yet you
1195 * want to use OpenSSL and encrypted links, enable this. Beware -
1196 * EGD is *very* CPU intensive when gathering data for its pool
1200 /* egdpool path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1201 * which automatically finds the path.
1203 #egdpool_path = "/var/run/egd-pool";
1206 /* compression level: level of compression for compressed links between
1209 * values are between: 1 (least compression, fastest)
1210 * and: 9 (most compression, slowest).
1212 #compression_level = 6;
1214 /* burst_away: This enables bursting away messages to servers.
1215 * With this disabled, we will only propogate AWAY messages
1216 * as users send them, but never burst them. Be warned though
1217 * enabling this could increase the size of a burst significantly
1218 * for a large network, like EFnet.
1222 /* nick delay: This locks nicks of split clients for the given time
1223 * or until a remote client uses the nick. This significantly
1224 * reduces nick collisions on short splits but it can be annoying.
1225 * To make things as fair as possible, this should be the same on
1226 * all servers. If you enable this, the suggested value is 15 minutes.
1228 nick_delay = 0 seconds;
1230 /* reject time: the amount of rejections through klines/dlines etc
1231 * allowed in the given time before the rejection is cached and
1232 * a pseudo temp dline is placed
1234 reject_ban_time = 1 minute;
1235 reject_after_count = 3;
1237 /* reject duration: the amount of time to cache the rejection */
1238 reject_duration = 5 minutes;
1240 /* throttle_duration: Amount of time that throttling will be applied to an IP
1243 throttle_duration = 60;
1245 /* throttle_count: Number of connections within throttle_duration that it takes
1246 * for throttling to take effect */
1249 /* client flood_max_lines: maximum number of lines in a clients queue before
1250 * they are dropped for flooding.
1252 client_flood_max_lines = 20;
1254 /* Flood control settings. DO NOT CHANGE THESE without extensive discussion
1255 * and testing by someone who knows exactly what they do.
1257 * These settings replicate charybdis-3.3 behaviour.
1259 client_flood_burst_rate = 40;
1260 client_flood_burst_max = 5;
1261 client_flood_message_time = 1;
1262 client_flood_message_num = 2;
1266 /* module path: paths to search for modules specified below and
1269 path = "/usr/local/ircd/modules";
1270 path = "/usr/local/ircd/modules/autoload";
1272 /* module: the name of a module to load on startup/rehash */
1273 #module = "some_module.so";