1 /* doc/reference.conf - shadowircd 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 * /mkpassword support -- m_mkpasswd.so
68 * WEBIRC support -- m_webirc.so
69 * Server-side /CYCLE -- m_cycle.so
70 * /oaccept - add to target's accept list, oper only -- m_oaccept.so
71 * /opme - op self in opless channels, admin only -- m_opme.so
72 * /ojoin - join despite restrictions, admin only -- m_ojoin.so
73 * /omode - force modes in channels, admin only -- m_omode.so
74 * /olist - see all channels in /list, oper only -- m_olist.so
75 * /okick - kick users without having ops, oper only -- m_okick.so
76 * /forcejoin - force join users, admin only -- m_force.so
77 * Opers cannot be invisible (umode +i) -- no_oper_invis.so
78 * Far connection notices (snomask +F) -- sno_farconnect.so
79 * Remote k/d/x line active notices -- sno_globalkline.so
80 * Remote oper up notices -- sno_globaloper.so
81 * /whois notifications (snomask +W) -- sno_whois.so
83 #loadmodule "extensions/chm_adminonly.so";
84 loadmodule "extensions/chm_operonly.so";
85 #loadmodule "extensions/chm_sslonly.so";
86 #loadmodule "extensions/chm_operonly_compat.so";
87 #loadmodule "extensions/chm_quietunreg_compat.so";
88 #loadmodule "extensions/chm_sslonly_compat.so";
89 #loadmodule "extensions/createauthonly.so";
90 loadmodule "extensions/extb_account.so";
91 loadmodule "extensions/extb_canjoin.so";
92 loadmodule "extensions/extb_channel.so";
93 loadmodule "extensions/extb_extgecos.so";
94 loadmodule "extensions/extb_oper.so";
95 loadmodule "extensions/extb_realname.so";
96 #loadmodule "extensions/extb_server.so";
97 #loadmodule "extensions/extb_ssl.so";
98 #loadmodule "extensions/hurt.so";
99 loadmodule "extensions/ip_cloaking.so";
100 #loadmodule "extensions/m_findforwards.so";
101 loadmodule "extensions/m_identify.so";
102 loadmodule "extensions/m_mkpasswd.so";
103 loadmodule "extensions/m_webirc.so";
104 #loadmodule "extensions/m_cycle.so";
105 #loadmodule "extensions/m_oaccept.so";
106 #loadmodule "extensions/m_opme.so";
107 #loadmodule "extensions/m_ojoin.so";
108 #loadmodule "extensions/m_omode.so";
109 #loadmodule "extensions/m_olist.so";
110 #loadmodule "extensions/m_okick.so";
111 #loadmodule "extensions/m_force.so";
112 #loadmodule "extensions/no_oper_invis.so";
113 loadmodule "extensions/sno_farconnect.so";
114 loadmodule "extensions/sno_globalkline.so";
115 loadmodule "extensions/sno_globaloper.so";
116 #loadmodule "extensions/sno_whois.so";
118 /* modesets: Modesets are modules that enable various user and channel
119 * modes. When enabled, they enable usermodes and channel modes equivalent
120 * to the named ircd. This is useful for linking to other TS6 IRCds.
121 * If you do not know what this does or do not know if you need it
122 * then you should just load modes/shadowircd.so for full functionality.
123 * Without any modeset loaded, you will only have the modes that are included
124 * in ircd-ratbox. Unloading a modeset while the ircd is running is possible,
125 * but will be confusing for users, as it will leave all existent unloaded
126 * modes in place without users being able to remove them. Said modes will,
127 * however, not function. You should be able to load a module that provides
128 * more modes than your current (say, going from charybdis to shadowircd)
129 * on the fly without any problems. The slight exception to this is unloading
130 * a module that provides quiets (cmode +q). Users affected by quiets will
131 * have to part and rejoin the channel before the quiet will cease affecting
132 * them. In addition, unloaded modes will remain in the IRCd's VERSION reply
133 * until restart. For these reasons, it is highly recommended to restart if you wish
135 * Modesets currently only affect cmodes.
136 * You should only load one of these at a time.
137 * Modules are listed in order of highest functionality to least,
138 * while no module provides the least functionality of all. */
140 loadmodule "modes/shadowircd.so";
141 #loadmodule "modes/charybdis.so";
144 /* serverinfo {}: Contains information about the server. (OLD M:) */
146 /* name: the name of our server */
149 /* sid: the unique server id of our server. This must be three
150 * characters long. The first character must be a digit [0-9], the
151 * remaining two chars may be letters [A-Z] or digits [0-9].
153 * This parameter must be specified for the server to start.
157 /* description: the description of our server. '[' and ']' may not
158 * be used here for compatibility with older servers.
160 description = "shadowircd test server";
162 /* network info: the name and description of the network this server
163 * is on. Shown in the 005 reply and used with serverhiding.
165 network_name = "MyNet";
166 network_desc = "This is My Network";
168 /* helpchan/helpurl: These 2 items are shown when a user does
169 * /quote help with no additional parameters to direct them
170 * to a channel/URL where they can get more or network-specific help.
171 * They can be commented out and will not show to users if they are.
174 helpurl = "http://www.mynet.net/help";
176 /* hub: allow this server to act as a hub and have multiple servers
181 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
182 * This should be an ipv4 IP only.
184 #vhost = "192.169.0.1";
186 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
187 * This should be an ipv6 IP only.
189 #vhost6 = "3ffe:80e8:546::2";
191 /* ssl_private_key: our ssl private key */
192 ssl_private_key = "etc/test.key";
194 /* ssl_cert: certificate for our ssl server */
195 ssl_cert = "etc/test.cert";
197 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
198 ssl_dh_params = "etc/dh.pem";
200 /* ssld_count: number of ssld processes you want to start, if you
201 * have a really busy server, using N-1 where N is the number of
202 * cpu/cpu cores you have might be useful. A number greater than one
203 * can also be useful in case of bugs in ssld and because ssld needs
204 * two file descriptors per SSL connection.
208 /* default max clients: the default maximum number of clients
209 * allowed to connect. This can be changed once ircd has started by
211 * /quote set maxclients <limit>
213 default_max_clients = 1024;
216 /* admin {}: contains admin information about the server. (OLD A:) */
218 name = "Smurf target";
219 description = "Main Server Administrator";
220 email = "<syn@packets.r.us>";
223 /* log {}: contains information about logfiles. */
225 /* logfiles: the logfiles to use for specific activity. if these
226 * paths are defined, then ircd will log to them, otherwise it wont.
228 * The confs are, in order:
229 * - userlog: user exits
230 * - fuserlog: failed user connections
231 * - operlog: /oper usage
232 * - foperlog: failed /oper usage
233 * - serverlog: server connects/disconnects
234 * - klinelog: klines, etc
236 * - operspylog: operspy usage
237 * - ioerrorlog: IO errors
239 fname_userlog = "logs/userlog";
240 #fname_fuserlog = "logs/fuserlog";
241 fname_operlog = "logs/operlog";
242 #fname_foperlog = "logs/foperlog";
243 fname_serverlog = "logs/serverlog";
244 #fname_klinelog = "logs/klinelog";
245 fname_killlog = "logs/killlog";
246 fname_operspylog = "logs/operspylog";
247 #fname_ioerrorlog = "logs/ioerror";
250 /* class {}: contain information about classes for users (OLD Y:) */
252 /* class name must go above */
254 /* ping time: how often a client must reply to a PING from the
255 * server before they are dropped.
257 ping_time = 2 minutes;
259 /* number per ident: the number of users per user@host networkwide
260 * allowed to connect. Unidented connections are classified as
263 number_per_ident = 2;
265 /* number per ip: the number of local users per host allowed */
268 /* number per ip global: the number of network wide connections
269 * per host allowed for a user, including connections to the
272 number_per_ip_global = 5;
274 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
276 cidr_ipv4_bitlen = 24;
278 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
279 * the following example makes the subnet /64 this is useful
280 * for IPv6 connections in particular
282 cidr_ipv6_bitlen = 64;
284 /* number_per_cidr: Number of connections to allow from a subnet of the
285 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
286 * 4 seems to be a good default to me.
290 /* max number: the maximum number of users allowed in this class */
293 /* sendq: the amount of data allowed in a clients queue before
300 ping_time = 1 minute 30 seconds;
307 ping_time = 5 minutes;
314 ping_time = 5 minutes;
316 /* connectfreq: only used in server classes. specifies the delay
317 * between autoconnecting to servers.
319 connectfreq = 5 minutes;
321 /* max number: the amount of servers to autoconnect to */
324 /* sendq: servers need a higher sendq as they are sent more data */
328 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
330 /* port: the specific port to listen on. if no host is specified
331 * before, it will listen on all available IPs.
333 * sslport: the specific port to listen ssl connections on. if no
334 * host is specified before, it will listen on all available IPs.
336 * ports are seperated via a comma, a range may be specified using ".."
339 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
340 port = 5000, 6665 .. 6669;
342 /* sslport: listen for ssl connections on all available IPs, port 9999 */
345 /* host: set a specific IP/host the ports after the line will listen
346 * on. This may be ipv4 or ipv6.
350 sslport = 9000, 9001;
352 host = "3ffe:1234:a:b:c::d";
357 /* auth {}: allow users to connect to the ircd (OLD I:) */
359 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
360 * lines are permitted per auth block. This is matched against the
361 * hostname and IP address (using :: shortening for IPv6 and
362 * prepending a 0 if it starts with a colon) and can also use CIDR
365 user = "*@172.16.0.0/12";
366 user = "*test@123D:B567:*";
368 /* password: an optional password that is required to use this block.
369 * By default this is not encrypted, specify the flag "encrypted" in
370 * flags = ...; below if it is.
372 password = "letmein";
374 /* spoof: fake the users user@host to be be this. You may either
375 * specify a host or a user@host to spoof to. This is free-form,
376 * just do everyone a favour and dont abuse it. (OLD I: = flag)
378 spoof = "I.still.hate.packets";
380 /* autojoin: Channel (or channels, comma-seperated) to join users
381 * in this auth block to on connect. Note that this won't join
382 * the user through any bans or otherwise restrictive chmodes.
384 autojoin = "#shadowircd,#test";
386 /* autojoin_opers : Channel (or channels, comma-seperated) to join
387 * opers to on oper-up.
389 autojoin_opers = "#opers,#help";
391 /* Possible flags in auth:
393 * encrypted | password is encrypted with mkpasswd
394 * spoof_notice | give a notice when spoofing hosts
395 * exceed_limit (old > flag) | allow user to exceed class user limits
396 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
397 * dnsbl_exempt | exempt this user from dnsbls
398 * spambot_exempt | exempt this user from spambot checks
399 * shide_exempt | exempt this user from serverhiding
400 * jupe_exempt | exempt this user from generating
401 * warnings joining juped channels
402 * resv_exempt | exempt this user from resvs
403 * flood_exempt | exempt this user from flood limits
405 * no_tilde (old - flag) | don't prefix ~ to username if no ident
406 * need_ident (old + flag) | require ident for user in this class
407 * need_ssl | require SSL/TLS for user in this class
408 * need_sasl | require SASL id for user in this class
410 flags = kline_exempt, exceed_limit;
412 /* class: the class the user is placed in */
416 /* Example WEBIRC authblock */
418 /* user: webirc@IP.OF.YOUR.WEBIRC . the webirc@ part is required */
419 user = "webirc@192.168.1.1";
421 /* password: password the webirc client sends in the WEBIRC command.
422 * You can use a encrypted password here (see above auth block).
424 password = "<password>";
426 /* spoof: This is required to keep it what it is currently if you
427 * want the webirc client to show the users' real host as their
435 /* redirect: the server and port to redirect a user to. A user does
436 * not have to obey the redirection, the ircd just suggests to them
437 * an alternative server.
439 redirserv = "irc.some.domain";
442 user = "*.some.domain";
444 /* class: a class is required even though it is not used */
455 /* privset{}: defines operator privilege sets. */
457 /* privs: controls the activities and commands an oper is
458 * allowed to do on the server
462 * oper:local_kill: allows local users to be /KILL'd
463 * oper:global_kill: allows local and remote users to be /KILL'd
464 * oper:routing: allows remote SQUIT and CONNECT
465 * oper:kline: allows KLINE and DLINE
466 * oper:unkline: allows UNKLINE and UNDLINE
467 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
468 * oper:rehash: allows oper to REHASH config
469 * oper:die: allows DIE and RESTART
470 * oper:admin: gives admin privileges. admins
471 * may (un)load modules and see various
472 * additional information.
473 * oper:hidden_admin: gives admin privileges except
474 * will not have the admin lines in
476 * oper:xline: allows use of /quote xline/unxline
477 * oper:resv: allows /quote resv/unresv and cmode +LP
478 * oper:operwall: allows the oper to send/receive operwalls
479 * oper:override: allows the oper to set umode +p on themself
480 which grants the ability to have implicit
481 operator access in all channels.
482 * oper:spy: allows 'operspy' features to see through +s
483 * channels etc. see /quote help operspy
484 * oper:hidden: hides the oper from /stats p
485 * oper:remoteban: allows remote kline etc
486 * oper:mass_notice: allows sending wallops and mass notices
488 privs = oper:local_kill, oper:operwall;
491 privset "server_bot" {
492 /* extends: a privset to inherit in this privset */
493 extends = "local_op";
494 privs = oper:kline, oper:remoteban, snomask:nick_changes;
497 privset "global_op" {
498 extends = "local_op";
499 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
500 oper:resv, oper:mass_notice, oper:remoteban;
504 extends = "global_op";
505 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:override;
508 /* operator {}: defines ircd operators. (OLD O:) */
510 /* name: the name of the oper must go above */
512 /* user: the user@host required for this operator. CIDR *is*
513 * supported now. auth{} spoofs work here, other spoofs do not.
514 * multiple user="" lines are supported.
517 user = "*@127.0.0.1";
519 /* password: the password required to oper. Unless ~encrypted is
520 * contained in flags = ...; this will need to be encrypted using
521 * mkpasswd, MD5 is supported
523 password = "etcnjl8juSU1E";
525 /* rsa key: the public key for this oper when using Challenge.
526 * A password should not be defined when this is used, see
527 * doc/challenge.txt for more information.
529 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
531 /* fingerprint: if specified, the oper's client certificate
532 * fingerprint will be checked against the specified fingerprint
535 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
537 /* umodes: the specific umodes this oper gets when they oper.
538 * If this is specified an oper will not be given oper_umodes
539 * These are described above oper_only_umodes in general {};
541 #umodes = locops, servnotice, operwall, wallop;
543 /* snomask: specific server notice mask on oper up.
544 * If this is specified an oper will not be given oper_snomask.
546 snomask = "+FZbcfkrsuy";
548 /* vhost: defines the vhost that this oper will get on oper up.
549 * this must be a valid hostmask. If this is specified the oper
550 * will not be given default_operhost.
552 vhost = "is.an.oper";
554 /* swhois: defines an additional line that will be displayed
555 * whenever someone does /whois on the oper in question.
557 swhois = "is wearing pants.";
559 /* operstring: defines a custom operstring for this oper,
560 * which will be shown in whois instead of default_operstring
561 * or default_adminstring.
563 operstring = "is a lazy IRC Operator";
565 /* flags: misc options for the operator. You may prefix an option
566 * with ~ to disable it, e.g. ~encrypted.
568 * Default flags are encrypted.
572 * encrypted: the password above is encrypted [DEFAULT]
573 * need_ssl: must be using SSL/TLS to oper up
577 /* privset: privileges set to grant */
581 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
582 connect "irc.uplink.com" {
583 /* the name must go above */
585 /* host: the host or IP to connect to. If a hostname is used it
586 * must match the reverse dns of the server.
588 host = "192.168.0.1";
590 /* vhost: the host or IP to bind to for this connection. If this
591 * is not specified, the default vhost (in serverinfo {}) is used.
593 #vhost = "192.168.0.50";
595 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
596 * The remote server will have these passwords reversed.
598 send_password = "password";
599 accept_password = "anotherpassword";
601 /* port: the port to connect to this server on */
604 /* hub mask: the mask of servers that this server may hub. Multiple
605 * entries are permitted
609 /* leaf mask: the mask of servers this server may not hub. Multiple
610 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
614 /* class: the class this server is in */
617 /* flags: controls special options for this server
618 * encrypted - marks the accept_password as being crypt()'d
619 * autoconn - automatically connect to this server
620 * compressed - compress traffic via ziplinks
621 * topicburst - burst topics between servers
622 * ssl - ssl/tls encrypted server connections
624 flags = compressed, topicburst;
627 connect "ipv6.some.server" {
628 /* Hosts that are IPv6 addresses must be in :: shortened form
629 * if applicable. Addresses starting with a colon get an extra
630 * zero prepended, for example: 0::1
632 host = "3ffd:dead:beef::1";
633 send_password = "password";
634 accept_password = "password";
637 /* aftype: controls whether the connection uses "ipv4" or "ipv6".
644 connect "ssl.uplink.com" {
645 /* Example of ssl server-to-server connection, ssl flag doesn't need
646 * compressed flag, 'cause it uses own compression
648 host = "192.168.0.1";
649 send_password = "password";
650 accept_password = "anotherpassword";
654 flags = ssl, topicburst;
657 /* cluster {}; servers that we propagate things to automatically.
658 * NOTE: This does NOT grant them privileges to apply anything locally,
659 * you must add a seperate shared block for that. Clustering will
660 * only be done for actions by LOCAL opers, that arent directed
664 /* name: the server to share with, this can be a wildcard and may be
667 /* flags: list of what to share, all the name lines above this (up
668 * until another flags entry) will receive these flags.
670 * kline - share perm klines
671 * tkline - share temp klines
672 * unkline - share unklines
673 * locops - share locops
674 * xline - share perm xlines
675 * txline - share temp xlines
676 * unxline - share unxlines
677 * resv - share perm resvs
678 * tresv - share temp resvs
679 * unresv - share unresvs
680 * all - share all of the above
683 /* share klines/unklines/xlines with *.lan */
685 flags = kline, unkline, xline;
687 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
688 name = "irc.ircd-ratbox.org";
689 name = "ircd.ircd-ratbox.org";
693 /* service{}: privileged servers (services). These servers have extra
694 * privileges such as setting login names on users and introducing clients
695 * with umode +S (unkickable, hide channels, etc). This does not allow them
696 * to set bans, you need a separate shared{} for that.
697 * Do not place normal servers here.
698 * There may be only one service{} block.
701 /* name: the server name. These may be stacked. */
702 name = "services.int";
705 /* shared {}: users that are allowed to place remote bans on our server.
706 * NOTE: These are ordered top down. The first one the user@host and server
707 * matches will be used. Their access will then be decided on that
708 * block and will not fall back to another block that matches.
711 /* oper: the user@host and server the user must be on to set klines.
712 * The first field must be a user@host, the second field is an
713 * optional server. These may be stacked.
715 /* flags: list of what to allow them to place, all the oper lines
716 * above this (up until another flags entry) will receive these
717 * flags. This *must* be present.
719 * kline - allow setting perm/temp klines
720 * tkline - allow setting temp klines
721 * unkline - allow removing klines
722 * xline - allow setting perm/temp xlines
723 * txline - allow setting temp xlines
724 * unxline - allow removing xlines
725 * resv - allow setting perm/temp resvs
726 * tresv - allow setting temp resvs
727 * unresv - allow removing xlines
728 * rehash - allow rehashing
729 * all - allow oper/server to do all of above.
730 * locops - allow locops - only used for servers who cluster
731 * die - allow restarting/dying of servers
732 * modules - allow loading/unloading/reloading of modules
733 * dline - allow setting perm/temp dlines
734 * tdline - allow setting temp dlines
735 * undline - allow removing dlines
736 * none - disallow everything
739 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
740 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
742 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
743 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
746 /* you may forbid certain opers/servers from doing anything */
747 oper = "irc@vanity.oper", "*";
748 oper = "*@*", "irc.vanity.server";
749 oper = "irc@another.vanity.oper", "bigger.vanity.server";
752 /* or allow everyone to place temp klines */
757 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
759 ip = "192.168.0.0/16";
761 /* these may be stacked */
766 /* The channel block contains options pertaining to channels */
768 /* autochanmodes: Modes that will be set on a unregistered channel
769 * when the first user joins it.
771 autochanmodes = "nt";
773 /* admin_on_channel_create: If set to yes, users joining new channels
774 * will be given +ao instead of just +o. Requires use_admin.
776 admin_on_channel_create = no;
778 /* exemptchanops: Channel modes that any form of channel ops (+aoh)
779 * will be exempt from. Even if the mode is set, it will not apply to the
780 * channel ops if it is listed in this option. Valid modes are cCDTNGK.
782 exemptchanops = "NT";
784 /* halfop: Enable/disable channel mode +h, which adds halfop,
785 * a channel status below op that has op powers (kick, ban, mode, etc.)
786 * halfops can only kick/devoice/etc people who are +v or
787 * do not have any channel status. Disabling this via rehash will
788 * cause things which are rather confusing to occur, it is highly
789 * recommended to restart if you wish to disable this option, though
790 * it may be enabled by rehash with no problems.
794 /* admin: Enable/disable channel mode +a, which adds admin,
795 * a channel status above op that has op powers (kick, ban, mode, etc.)
796 * admins can only be kicked/deadmined by other admins, and may kick
797 * or deop anyone. Disabling this via rehash will cause things which
798 * are rather confusing to occur, it is highly recommended to restart
799 * if you wish to disable this option, though it may be enabled
800 * by rehash with no problems.
804 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
805 * that can join a +i channel without an invite. Disabling this option
806 * via rehash will leave all previously set invexes hanging around,
807 * though they will not do anything. For this reason, you may want to
808 * restart to disable this option.
812 /* except: Enable/disable channel mode +e, a n!u@h list of masks
813 * that can join a channel through a ban (+b). Disabling this option
814 * via rehash will leave all previously set excepts hanging around,
815 * though they will not do anything. For this reason, you may want to
816 * restart to disable this option.
820 /* knock: Allows users to request an invite to a channel that
821 * is locked somehow (+ikl). If the channel is +p or you are banned
822 * the knock will not be sent.
826 /* local channels: &Channel - a channel that exists only on one server
827 * people on other servers will not be able to see or join local channels
828 * from another server.
830 use_local_channels = yes;
832 /* knock delay: The amount of time a user must wait between issuing
835 knock_delay = 5 minutes;
837 /* knock channel delay: How often a knock to any specific channel
838 * is permitted, regardless of the user sending the knock.
840 knock_delay_channel = 1 minute;
842 /* max chans: The maximum number of channels a user can join/be on. */
843 max_chans_per_user = 15;
845 /* max bans: maximum number of +b/e/I/q modes in a channel */
848 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
849 max_bans_large = 500;
851 /* splitcode: split users, split servers and either no join on split
852 * or no create on split must be enabled for split checking.
853 * splitmode will be entered on either split users or split servers
854 * dropping below the limit.
856 * you may force splitmode to be permanent by /quote set splitmode on
859 /* split users: when the usercount is lower than this level, consider
860 * ourselves split. this must be set for automatic splitmode
862 default_split_user_count = 0;
864 /* split servers: when the amount of servers that have acknowledged
865 * theyve finished bursting is lower than this, consider ourselves
866 * split. this must be set for automatic splitmode
868 default_split_server_count = 0;
870 /* split: no create: disallow users creating channels on split */
871 no_create_on_split = no;
873 /* split: no join: disallow users joining channels at all on a split */
874 no_join_on_split = no;
876 /* burst topicwho: when bursting topics, also burst the topic setter */
877 burst_topicwho = yes;
879 /* kick on split riding: kick users riding splits to join +i or +k
880 * channels. more precisely, if a bursting server sends an SJOIN
881 * for a channel with a lower TS with either a +i mode or a +k
882 * mode with a different key, kick all local users.
884 * note: this does not take +r, +b, +e and +I into account.
886 * warning: if there are any TS5 servers on the network, this
887 * will cause ban desyncs if they send such an SJOIN and the
888 * splitriders added any bans (our side will lose them, the TS5
889 * side will accept them). we will send a notice to the channel
890 * if this happens. most services do not send such SJOINs but
891 * ratbox-services does.
893 kick_on_split_riding = no;
895 /* only ascii channels: disable local users joining channels
896 * containing characters outside the range 33-126 (non-printable
899 only_ascii_channels = no;
901 /* cycle_host_change: Should a user be cycled in the channels
902 * they're in when their host changes. If set to no, this may
903 * cause client desyncs.
905 cycle_host_change = yes;
907 /* host_in_topic: Defines whether or not the topicsetter's
908 * host is shown when users request the TOPIC. If this option
909 * is set to no, it will only show the nick of the topicsetter.
913 /* resv_forcepart: force any local users to part a channel
914 * when a RESV is issued.
916 resv_forcepart = yes;
918 /* channel target change: restrict how many channels users can
919 * message per unit of time. IRC operators, channel operators and
920 * voiced users are exempt.
922 channel_target_change = yes;
926 /* The serverhide block contains the options regarding serverhiding */
928 /* flatten links: this option will hide various routing information
929 * and make all servers in /links appear that they are linked to
934 /* links delay: how long to wait before showing splits or new
935 * servers in a flattened /links output.
937 links_delay = 5 minutes;
939 /* hidden: hide this server from a /links output on servers with
940 * flatten_links enabled. this allows hub servers to be hidden etc.
944 /* disable hidden: prevent servers hiding themselves from a
950 /* These are the blacklist settings.
951 * You can have multiple combinations of host and rejection reasons.
952 * They are used in pairs of one host/rejection reason.
954 * These settings should be adequate for most networks, and are (presently)
955 * required for use on AthemeNet.
957 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
960 * As of charybdis 2.2, you can do some keyword substitution on the rejection
961 * reason. The available keyword substitutions are:
963 * ${ip} - the user's IP
964 * ${host} - the user's canonical hostname
965 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
966 * ${nick} - the user's nickname
967 * ${network-name} - the name of the network
969 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
970 * contacted, via email, at admins@2mbit.com before using these BLs.
971 * See <http://www.ahbl.org/services.php> for more information.
974 host = "rbl.efnetrbl.org";
975 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
977 host = "dnsbl.dronebl.org";
978 reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
980 # host = "ircbl.ahbl.org";
981 # 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.";
983 # host = "tor.ahbl.org";
984 # 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.";
988 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
989 * They send PRIVMSG to the given target. A real command takes
990 * precedence above an alias.
993 /* the name must go above */
995 /* target: the target nick (must be a network service) or
996 * user@server (cannot be this server, only opers can use
997 * user starting with "opers" reliably, interpreted on the target
998 * server only so you may need to use nick@server instead)
1000 target = "NickServ";
1004 target = "ChanServ";
1008 target = "OperServ";
1012 target = "MemoServ";
1016 target = "HostServ";
1024 target = "InfoServ";
1028 target = "GroupServ";
1032 target = "NickServ";
1036 target = "ChanServ";
1040 target = "OperServ";
1044 target = "MemoServ";
1048 target = "HostServ";
1056 target = "InfoServ";
1060 target = "GroupServ";
1063 /* The general block contains many of the options that were once compiled
1064 * in options in config.h. The general block is read at start time.
1067 /* hide error messages: defines whether error messages from
1068 * servers that are not deemed fully safe are hidden or not.
1069 * These can sometimes contain IPs and can have an adverse
1070 * effect on server ip hiding. Set to:
1071 * yes: hide from opers and admin
1072 * opers: hide from opers only
1073 * no: do not hide error messages
1074 * Admins on other servers count as opers.
1076 hide_error_messages = opers;
1078 /* hide spoof ips: hide the real ips of auth{} spoofed users
1079 * If disabled, local opers can see them.
1080 * Dynamic spoofs (e.g. set by services) are unaffected by this;
1081 * any oper (local and remote) can see the real ip.
1082 * Warning: for whowas, this is checked when the client exits,
1083 * not when the IP is shown.
1085 hide_spoof_ips = yes;
1087 /* default umodes: umodes to set upon connection
1088 * If you have enabled the ip_cloaking extension, and you wish for
1089 * incoming clients to be cloaked upon connection, +x must be in
1090 * the umode string below.
1092 default_umodes = "+ix";
1094 /* default operstring: defines the default oper response
1095 * in /whois queries, eg "is an IRC Operator".
1096 * After startup use /quote set operstring to change.
1098 default_operstring = "is an IRC Operator";
1100 /* default adminstring: defines the default admin response
1101 * in /whois queries, eg "is a Server Administrator".
1102 * After startup use /quote set adminstring to change.
1104 default_adminstring = "is a Server Administrator";
1106 /* default operhost: defines the default virtual host that
1107 * operators will receiving upon opering up. Can be overriden
1108 * by the vhost option in individual operator blocks. This
1109 * must be a valid hostmask.
1111 default_operhost = "staff.testnet.net";
1113 /* static quit: Quit message to display for all users (not opers)
1116 #static_quit = "I like turtles!";
1118 /* servicestring: defines the response for opered services (+S)
1119 * in /whois queries, eg "is a Network Service".
1120 * This is updated on rehash.
1122 servicestring = "is a Network Service";
1124 /* disable fake channels: disable local users joining fake versions
1125 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
1126 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
1128 disable_fake_channels = no;
1130 /* hide_channel_below_users: Amount of users a channel must have in it
1131 * before it is shown in a standard LIST. This can be overridden by
1132 * invoking LIST like: /LIST <3
1134 hide_channel_below_users = 3;
1136 /* tkline_expire_notices: give a notice to opers when a tkline
1139 tkline_expire_notices = no;
1141 /* floodcount: the default value of floodcount that is configurable
1142 * via /quote set floodcount. This is the amount of lines a user
1143 * may send to any other user/channel in one second.
1145 default_floodcount = 10;
1147 /* failed oper notice: send a notice to all opers on the server when
1148 * someone tries to OPER and uses the wrong password, host or ident.
1150 failed_oper_notice = yes;
1152 /* dots in ident: the amount of '.' characters permitted in an ident
1153 * reply before the user is rejected.
1157 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
1158 * placed via the server. klines hand placed are exempt from limits.
1159 * wildcard chars: '.' '*' '?' '@'
1161 min_nonwildcard = 4;
1163 /* min nonwildcard simple: the minimum non wildcard characters in
1164 * xlines/resvs placed via the server.
1165 * wildcard chars: '*' '?'
1167 min_nonwildcard_simple = 3;
1169 /* max accept: maximum allowed /accept's for +gGR usermodes */
1172 /* max monitor: the maximum amount of nicknames a client may have in
1173 * their monitor (server-side notify) list.
1177 /* nick flood: enable the nickflood control code */
1178 anti_nick_flood = yes;
1180 /* nick flood: the nick changes allowed in the specified period */
1181 max_nick_time = 20 seconds;
1182 max_nick_changes = 5;
1184 /* anti spam time: the minimum time a user must be connected before
1185 * custom quit messages are allowed.
1187 anti_spam_exit_message_time = 5 minutes;
1189 /* use part messages: This option controls whether users should be
1190 * allowed to send PART messages to channels. It should probably
1191 * be set to no if static_quit is set.
1193 use_part_messages = yes;
1195 /* ts delta: the time delta allowed between server clocks before
1196 * a warning is given, or before the link is dropped. all servers
1197 * should run ntpdate/rdate to keep clocks in sync
1199 ts_warn_delta = 30 seconds;
1200 ts_max_delta = 5 minutes;
1202 /* client exit: prepend a users quit message with "Client exit: " */
1205 /* collision fnc: change user's nick to their UID instead of
1206 * killing them, if possible. This setting only applies to nick
1207 * collisions detected on this server. Only enable this if
1208 * all servers on the network allow remote nicks to start with
1211 collision_fnc = yes;
1213 /* global snotices: send out certain snotices (most +b, +f, +y,
1214 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1215 * displayed unconditionally.
1217 global_snotices = yes;
1219 /* dline reason: show the user the dline reason when they connect
1222 dline_with_reason = yes;
1224 /* kline delay: delay the checking of klines until a specified time.
1225 * Useful if large kline lists are applied often to prevent the
1226 * server eating CPU.
1228 kline_delay = 0 seconds;
1230 /* kline reason: show the user the reason why they are k/dlined
1231 * on exit. may give away who set k/dline when set via tcm.
1233 kline_with_reason = yes;
1235 /* kline reason: make the users quit message on channels this
1236 * reason instead of the oper's reason.
1238 kline_reason = "K-Lined";
1240 /* identify to services via server password
1241 * if auth{} block had no password but the user specified a
1242 * server password anyway, send a PRIVMSG to <identify_service>
1243 * with as text <identify_command> <password>.
1245 identify_service = "NickServ@services.int";
1246 identify_command = "IDENTIFY";
1248 /* non redundant klines: flag and ignore redundant klines */
1249 non_redundant_klines = yes;
1251 /* warn no nline: warn opers about servers that try to connect but
1252 * we dont have a connect {} block for. Twits with misconfigured
1253 * servers can get really annoying with this enabled.
1255 warn_no_nline = yes;
1257 /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
1258 * That means the bans are part of the netburst and restarted/split
1259 * servers will get them, but they will not apply to 3.2 and older
1262 use_propagated_bans = yes;
1264 /* stats e disabled: disable stats e. useful if server ips are
1265 * exempted and you dont want them listing on irc.
1267 stats_e_disabled = no;
1269 /* stats c oper only: make stats c (connect {}) oper only */
1270 stats_c_oper_only=no;
1272 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
1273 stats_h_oper_only=no;
1275 /* stats y oper only: make stats y (class {}) oper only */
1276 stats_y_oper_only=no;
1278 /* stats o oper only: make stats o (opers) oper only */
1279 stats_o_oper_only=yes;
1281 /* stats P oper only: make stats P (ports) oper only
1282 * NOTE: users doing stats P will never be given the ips that the
1283 * server listens on, simply the ports.
1285 stats_P_oper_only=no;
1287 /* stats i oper only: make stats i (auth {}) oper only. set to:
1288 * yes: show users no auth blocks, made oper only.
1289 * masked: show users first matching auth block
1290 * no: show users all auth blocks.
1292 stats_i_oper_only=masked;
1294 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1295 * yes: show users no auth blocks, made oper only
1296 * masked: show users first matching auth block
1297 * no: show users all auth blocks.
1299 stats_k_oper_only=masked;
1301 /* map oper only: make /map oper only */
1304 /* operspy admin only: make operspy notices to +Z admin only */
1305 operspy_admin_only = no;
1307 /* operspy dont care user info: treat /who mask as if there was
1308 * an '!' always; do not log or server notice about operspy
1309 * /who mask, /masktrace and /scan. channel information is still
1311 operspy_dont_care_user_info = no;
1313 /* secret channels in whois: display secret channels in /whois
1314 * even if operspy was not used, as long as the oper doing the
1315 * whois has the oper:spy priv. this will not send any kind of
1317 secret_channels_in_whois = no;
1319 /* caller id wait: time between notifying a +g user that somebody
1320 * is messaging them.
1322 caller_id_wait = 1 minute;
1324 /* pace wait simple: time between use of less intensive commands
1325 * (HELP, remote WHOIS, WHOWAS)
1327 pace_wait_simple = 1 second;
1329 /* pace wait: time between more intensive commands
1330 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1332 pace_wait = 10 seconds;
1334 /* short motd: send clients a notice telling them to read the motd
1335 * instead of forcing a motd to clients who may simply ignore it.
1339 /* ping cookies: require clients to respond exactly to a ping command,
1340 * can help block certain types of drones and FTP PASV mode spoofing.
1344 /* connect timeout: sets how long we should wait for a connection
1345 * request to succeed
1347 connect_timeout = 30 seconds;
1349 /* ident timeout: Amount of time (in seconds) that the IRCd will
1350 * wait for a user to respond to an ident request.
1352 default_ident_timeout = 5;
1354 /* disable auth: disables identd checking */
1357 /* no oper flood: increase flood limits for opers.
1358 * This option quadruples the user command flood limits, it
1359 * DOES NOT affect PRIVMSG/NOTICE usage.
1361 no_oper_flood = yes;
1363 /* true no oper flood: Allow opers to NEVER hit flood limits.
1364 * With the above setting, flood limits are set to 4x what they
1365 * are for normal users. With this setting, they're removed entirely.
1366 * For this setting to work, you need to have no_oper_flood enabled as well.
1367 * This option DOES allow PRIVMSG/NOTICE flooding.
1368 * ENABLE THIS SETTING WITH CAUTION.
1370 true_no_oper_flood = no;
1372 /* REMOVE ME. The following line checks you've been reading. */
1373 havent_read_conf = yes;
1375 /* max targets: the maximum amount of targets in a single
1376 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1380 /* client flood: maximum number of lines in a clients queue before
1381 * they are dropped for flooding.
1385 /* use_whois_actually: send clients requesting a whois a numeric
1386 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1388 use_whois_actually = yes;
1390 /* usermodes configurable: a list of usermodes for the options below
1392 * +g - callerid - Server Side Ignore
1393 * +D - deaf - Don't see channel messages
1394 * +i - invisible - Not shown in NAMES or WHO unless you share a
1396 * +l - locops - See LOCOPS messages
1397 * +Q - noforward - Unaffected by channel forwarding
1398 * +R - regonlymsg - No messages from unindentified
1399 * +s - servnotice - See server notices
1400 * +w - wallop - See oper and server generated WALLOPS
1401 * +z - operwall - See operwalls
1402 * +C - noctcp - Block CTCPs to user.
1403 * +V - noinvite - Block INVITE to user.
1404 * +B - bot - Marks as a bot.
1405 * +p - override - Implicit operator access in all channels.
1406 * This is oper-only and requires the oper:override priv.
1409 /* oper only umodes: usermodes only opers may set */
1410 oper_only_umodes = operwall, locops, servnotice;
1412 /* oper umodes: default usermodes opers get when they /oper */
1413 oper_umodes = locops, servnotice, operwall, wallop;
1415 /* oper snomask: default snomask opers get when they /oper,
1416 * provided they have umode +s set */
1417 oper_snomask = "+s";
1419 /* use egd: if your system does not have *random devices yet you
1420 * want to use OpenSSL and encrypted links, enable this. Beware -
1421 * EGD is *very* CPU intensive when gathering data for its pool
1425 /* egdpool path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1426 * which automatically finds the path.
1428 #egdpool_path = "/var/run/egd-pool";
1431 /* compression level: level of compression for compressed links between
1434 * values are between: 1 (least compression, fastest)
1435 * and: 9 (most compression, slowest).
1437 #compression_level = 6;
1439 /* burst_away: This enables bursting away messages to servers.
1440 * With this disabled, we will only propogate AWAY messages
1441 * as users send them, but never burst them. Be warned though
1442 * enabling this could increase the size of a burst significantly
1443 * for a large network, like EFnet.
1447 /* nick delay: This locks nicks of split clients for the given time
1448 * or until a remote client uses the nick. This significantly
1449 * reduces nick collisions on short splits but it can be annoying.
1450 * To make things as fair as possible, this should be the same on
1451 * all servers. If you enable this, the suggested value is 15 minutes.
1453 nick_delay = 0 seconds;
1455 /* reject time: the amount of rejections through klines/dlines etc
1456 * allowed in the given time before the rejection is cached and
1457 * a pseudo temp dline is placed
1459 reject_ban_time = 1 minute;
1460 reject_after_count = 3;
1462 /* reject duration: the amount of time to cache the rejection */
1463 reject_duration = 5 minutes;
1465 /* throttle_duration: Amount of time that throttling will be applied to an IP
1468 throttle_duration = 60;
1470 /* throttle_count: Number of connections within throttle_duration that it takes
1471 * for throttling to take effect */
1474 /* expire_override_time: User mode +p will be automatically unset
1475 * this long after it is set. 0 disables this. Default is 5 minutes.
1477 expire_override_time = 5 minutes;
1481 /* module path: paths to search for modules specified below and
1484 path = "/usr/local/ircd/modules";
1485 path = "/usr/local/ircd/modules/autoload";
1487 /* module: the name of a module to load on startup/rehash */
1488 #module = "some_module.so";