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
13 * class {} blocks MUST be specified before anything that uses them. That
14 * means they must be defined before auth {} and before connect {}.
16 * auth {} blocks MUST be specified in order of precedence. The first one
17 * that matches a user will be used. So place spoofs first, then specials,
18 * then general access, then restricted.
20 * privset {} blocks MUST be specified before anything that uses them. That
21 * means they must be defined before operator {}.
23 * Both shell style (#) and C style comments are supported.
25 * Files may be included by either:
29 * Times/durations are written as:
30 * 12 hours 30 minutes 1 second
32 * Valid units of time:
33 * month, week, day, hour, minute, second
35 * Valid units of size:
36 * megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
38 * Sizes and times may be singular or plural.
43 * Charybdis contains several extensions that are not enabled by default.
44 * To use them, uncomment the lines below.
46 * Channel mode +-A (admin only) -- chm_adminonly.la
47 * Channel mode +-O (oper only) -- chm_operonly.la
48 * Channel mode +-S (ssl only) -- chm_sslonly.la
49 * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat.la
50 * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat.la
51 * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat.la
52 * Channel mode +-M (disallow KICK on IRC ops) -- chm_operpeace.la
53 * Restrict channel creation to logged in users -- createauthonly.la
54 * Account bans (+b $a[:mask]) -- extb_account.la
55 * Banned from another channel (+b $j:mask) -- extb_canjoin.la
56 * Other-channel bans (+b $c:mask) -- extb_channel.la
57 * Combination extbans -- extb_combi.la
58 * Extended ban (+b $x:mask) -- extb_extgecos.la
59 * Hostmask bans (for combination extbans) -- extb_hostmask.la
60 * Oper bans (+b $o) -- extb_oper.la
61 * Realname (gecos) bans (+b $r:mask) -- extb_realname.la
62 * Server bans (+b $s:mask) -- extb_server.la
63 * SSL bans (+b $z) -- extb_ssl.la
64 * Helpops system (umode +H) -- helpops.la
65 * HURT system -- hurt.la
66 * New host mangling (umode +x) -- ip_cloaking_4.0.la
67 * Old host mangling (umode +h) -- ip_cloaking.la
68 * Dynamically extend channel limits -- m_extendchans.la
69 * Find channel forwards -- m_findforwards.la
70 * /identify support -- m_identify.la
71 * Opers cannot be invisible (umode +i) -- no_oper_invis.la
72 * Far connection notices (snomask +F) -- sno_farconnect.la
73 * Remote k/d/x line active notices -- sno_globalkline.la
74 * Remote oper up notices -- sno_globaloper.la
75 * Global nick-change notices -- sno_globalnickchange.la
76 * /whois notifications (snomask +W) -- sno_whois.la
77 * Oper-override (modehacking only) -- override.la
78 * Stop services kills -- no_kill_services.la
80 #loadmodule "extensions/chm_adminonly.la";
81 #loadmodule "extensions/chm_operonly.la";
82 #loadmodule "extensions/chm_sslonly.la";
83 #loadmodule "extensions/chm_operonly_compat.la";
84 #loadmodule "extensions/chm_quietunreg_compat.la";
85 #loadmodule "extensions/chm_sslonly_compat.la";
86 #loadmodule "extensions/chm_operpeace.la";
87 #loadmodule "extensions/createauthonly.la";
88 #loadmodule "extensions/extb_account.la";
89 #loadmodule "extensions/extb_canjoin.la";
90 #loadmodule "extensions/extb_channel.la";
91 #loadmodule "extensions/extb_combi.la";
92 #loadmodule "extensions/extb_extgecos.la";
93 #loadmodule "extensions/extb_hostmask.la";
94 #loadmodule "extensions/extb_oper.la";
95 #loadmodule "extensions/extb_realname.la";
96 #loadmodule "extensions/extb_server.la";
97 #loadmodule "extensions/extb_ssl.la";
98 #loadmodule "extensions/helpops.la";
99 #loadmodule "extensions/hurt.la";
100 #loadmodule "extensions/ip_cloaking_4.0.la";
101 #loadmodule "extensions/ip_cloaking.la";
102 #loadmodule "extensions/m_extendchans.la";
103 #loadmodule "extensions/m_findforwards.la";
104 #loadmodule "extensions/m_identify.la";
105 #loadmodule "extensions/no_oper_invis.la";
106 #loadmodule "extensions/sno_farconnect.la";
107 #loadmodule "extensions/sno_globalkline.la";
108 #loadmodule "extensions/sno_globalnickchange.la";
109 #loadmodule "extensions/sno_globaloper.la";
110 #loadmodule "extensions/sno_whois.la";
111 #loadmodule "extensions/override.la";
112 #loadmodule "extensions/no_kill_services.la";
114 /* serverinfo {}: Contains information about the server. (OLD M:) */
116 /* name: the name of our server */
119 /* sid: the unique server id of our server. This must be three
120 * characters long. The first character must be a digit [0-9], the
121 * remaining two chars may be letters [A-Z] or digits [0-9].
123 * This parameter must be specified for the server to start.
127 /* description: the description of our server. '[' and ']' may not
128 * be used here for compatibility with older servers.
130 description = "charybdis test server";
132 /* network info: the name and description of the network this server
133 * is on. Shown in the 005 reply and used with serverhiding.
135 network_name = "MyNet";
137 /* hub: allow this server to act as a hub and have multiple servers
142 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
143 * This should be an ipv4 IP only.
145 #vhost = "192.0.2.6";
147 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
148 * This should be an ipv6 IP only.
150 #vhost6 = "2001:db7:2::6";
152 /* ssl_private_key: our ssl private key */
153 ssl_private_key = "etc/ssl.key";
155 /* ssl_cert: certificate for our ssl server */
156 ssl_cert = "etc/ssl.pem";
158 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
159 ssl_dh_params = "etc/dh.pem";
161 /* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
162 #ssl_cipher_list = "EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
164 /* ssld_count: number of ssld processes you want to start, if you
165 * have a really busy server, using N-1 where N is the number of
166 * cpu/cpu cores you have might be useful. A number greater than one
167 * can also be useful in case of bugs in ssld and because ssld needs
168 * two file descriptors per SSL connection.
172 /* default max clients: the default maximum number of clients
173 * allowed to connect. This can be changed once ircd has started by
175 * /quote set maxclients <limit>
177 default_max_clients = 1024;
179 /* nicklen: enforced nickname length (for this server only; must not
180 * be longer than the maximum length set while building).
185 /* admin {}: contains admin information about the server. (OLD A:) */
187 name = "Smurf target";
188 description = "Main Server Administrator";
189 email = "<syn@packets.r.us>";
192 /* log {}: contains information about logfiles. */
194 /* logfiles: the logfiles to use for specific activity. if these
195 * paths are defined, then ircd will log to them, otherwise it wont.
197 * The confs are, in order:
198 * - userlog: user exits
199 * - fuserlog: failed user connections
200 * - operlog: /oper usage
201 * - foperlog: failed /oper usage
202 * - serverlog: server connects/disconnects
203 * - klinelog: klines, etc
205 * - operspylog: operspy usage
206 * - ioerrorlog: IO errors
208 fname_userlog = "logs/userlog";
209 #fname_fuserlog = "logs/fuserlog";
210 fname_operlog = "logs/operlog";
211 #fname_foperlog = "logs/foperlog";
212 fname_serverlog = "logs/serverlog";
213 #fname_klinelog = "logs/klinelog";
214 fname_killlog = "logs/killlog";
215 fname_operspylog = "logs/operspylog";
216 #fname_ioerrorlog = "logs/ioerror";
219 /* class {}: contain information about classes for users (OLD Y:) */
221 /* class name must go above */
223 /* ping time: how often a client must reply to a PING from the
224 * server before they are dropped.
226 ping_time = 2 minutes;
228 /* number per ident: the number of users per user@host networkwide
229 * allowed to connect. Unidented connections are classified as
232 number_per_ident = 2;
234 /* number per ip: the number of local users per host allowed */
237 /* number per ip global: the number of network wide connections
238 * per host allowed for a user, including connections to the
241 number_per_ip_global = 5;
243 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
245 cidr_ipv4_bitlen = 24;
247 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
248 * the following example makes the subnet /64 this is useful
249 * for IPv6 connections in particular
251 cidr_ipv6_bitlen = 64;
253 /* number_per_cidr: Number of connections to allow from a subnet of the
254 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
255 * 4 seems to be a good default to me.
259 /* max number: the maximum number of users allowed in this class */
262 /* sendq: the amount of data allowed in a clients queue before
269 ping_time = 1 minute 30 seconds;
276 ping_time = 5 minutes;
283 ping_time = 5 minutes;
285 /* connectfreq: only used in server classes. specifies the delay
286 * between autoconnecting to servers.
288 connectfreq = 5 minutes;
290 /* max number: the amount of servers to autoconnect to. if the number
291 * of servers in the class is or exceeds this, no more servers in the
292 * class are autoconnected. oper initiated connects are unaffected.
293 * this should usually be set to either 0 or 1. (autoconnecting from
294 * hubs to leaves may cause leaves to function as hubs by having
295 * multiple servers connected to them.)
299 /* sendq: servers need a higher sendq as they are sent more data */
303 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
305 /* defer_accept: wait for clients to send IRC handshake data before
306 * accepting them. if you intend to use software which depends on the
307 * server replying first, such as BOPM, you should disable this feature.
308 * otherwise, you probably want to leave it on.
312 /* port: the specific port to listen on. if no host is specified
313 * before, it will listen on all available IPs.
315 * sslport: the specific port to listen ssl connections on. if no
316 * host is specified before, it will listen on all available IPs.
318 * ports are seperated via a comma, a range may be specified using ".."
321 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
322 port = 5000, 6665 .. 6669;
324 /* sslport: listen for ssl connections on all available IPs, port 9999 */
327 /* host: set a specific IP/host the ports after the line will listen
328 * on. This may be ipv4 or ipv6.
332 sslport = 9000, 9001;
334 host = "2001:db8:2::6";
339 /* auth {}: allow users to connect to the ircd (OLD I:) */
341 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
342 * lines are permitted per auth block. This is matched against the
343 * hostname and IP address (using :: shortening for IPv6 and
344 * prepending a 0 if it starts with a colon) and can also use CIDR
347 user = "*@198.51.100.0/24";
348 user = "*test@2001:db8:1:*";
350 /* auth_user: This allows specifying a username:password instead of
351 * just a password in PASS, so that a fixed user@host is not
352 * necessary for a specific auth{} block.
354 #auth_user = "SomeUser";
356 /* password: an optional password that is required to use this block.
357 * By default this is not encrypted, specify the flag "encrypted" in
358 * flags = ...; below if it is.
360 password = "letmein";
362 /* spoof: fake the users user@host to be be this. You may either
363 * specify a host or a user@host to spoof to. This is free-form,
364 * just do everyone a favour and dont abuse it. (OLD I: = flag)
366 spoof = "I.still.hate.packets";
368 /* Possible flags in auth:
370 * encrypted | password is encrypted with mkpasswd
371 * spoof_notice | give a notice when spoofing hosts
372 * exceed_limit (old > flag) | allow user to exceed class user limits
373 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
374 * dnsbl_exempt | exempt this user from dnsbls
375 * spambot_exempt | exempt this user from spambot checks
376 * shide_exempt | exempt this user from serverhiding
377 * jupe_exempt | exempt this user from generating
378 * warnings joining juped channels
379 * resv_exempt | exempt this user from resvs
380 * flood_exempt | exempt this user from flood limits
382 * no_tilde (old - flag) | don't prefix ~ to username if no ident
383 * need_ident (old + flag) | require ident for user in this class
384 * need_ssl | require SSL/TLS for user in this class
385 * need_sasl | require SASL id for user in this class
386 * extend_chans | allow this user to join more channels than normal
388 flags = kline_exempt, exceed_limit;
390 /* class: the class the user is placed in */
395 /* redirect: the server and port to redirect a user to. A user does
396 * not have to obey the redirection, the ircd just suggests to them
397 * an alternative server.
399 redirserv = "irc.example.net";
402 user = "*.example.com";
404 /* class: a class is required even though it is not used */
413 /* privset{}: defines operator privilege sets. */
415 /* privs: controls the activities and commands an oper is
416 * allowed to do on the server
420 * oper:local_kill: allows local users to be /KILL'd
421 * oper:global_kill: allows local and remote users to be /KILL'd
422 * oper:routing: allows remote SQUIT and CONNECT
423 * oper:kline: allows KLINE and DLINE
424 * oper:unkline: allows UNKLINE and UNDLINE
425 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
426 * oper:rehash: allows oper to REHASH config
427 * oper:die: allows DIE and RESTART
428 * oper:admin: gives admin privileges. admins
429 * may (un)load modules and see various
430 * additional information.
431 * oper:hidden_admin: gives admin privileges except
432 * will not have the admin lines in
434 * oper:xline: allows use of /quote xline/unxline
435 * oper:resv: allows /quote resv/unresv and cmode +LP
436 * oper:operwall: allows the oper to send/receive operwalls
437 * oper:spy: allows 'operspy' features to see through +s
438 * channels etc. see /quote help operspy
439 * oper:hidden: hides the oper from /stats p
440 * oper:remoteban: allows remote kline etc
441 * oper:mass_notice: allows sending wallops and mass notices
442 * oper:grant: allows using the GRANT command
444 privs = oper:local_kill, oper:operwall;
447 privset "server_bot" {
448 /* extends: a privset to inherit in this privset */
449 extends = "local_op";
450 privs = oper:kline, oper:remoteban, snomask:nick_changes;
453 privset "global_op" {
454 extends = "local_op";
455 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
456 oper:resv, oper:mass_notice, oper:remoteban;
460 extends = "global_op";
461 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
464 /* operator {}: defines ircd operators. (OLD O:) */
466 /* name: the name of the oper must go above */
468 /* user: the user@host required for this operator. CIDR *is*
469 * supported now. auth{} spoofs work here, other spoofs do not.
470 * multiple user="" lines are supported.
473 user = "*@127.0.0.1";
475 /* password: the password required to oper. Unless ~encrypted is
476 * contained in flags = ...; this will need to be encrypted using
477 * mkpasswd, MD5 is supported
479 password = "etcnjl8juSU1E";
481 /* rsa key: the public key for this oper when using Challenge.
482 * A password should not be defined when this is used, see
483 * doc/challenge.txt for more information.
485 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
487 /* fingerprint: if specified, the oper's client certificate
488 * fingerprint will be checked against the specified fingerprint
491 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
493 /* umodes: the specific umodes this oper gets when they oper.
494 * If this is specified an oper will not be given oper_umodes
495 * These are described above oper_only_umodes in general {};
497 #umodes = locops, servnotice, operwall, wallop;
499 /* snomask: specific server notice mask on oper up.
500 * If this is specified an oper will not be given oper_snomask.
502 snomask = "+Zbfkrsuy";
504 /* flags: misc options for the operator. You may prefix an option
505 * with ~ to disable it, e.g. ~encrypted.
507 * Default flags are encrypted.
511 * encrypted: the password above is encrypted [DEFAULT]
512 * need_ssl: must be using SSL/TLS to oper up
516 /* privset: privileges set to grant */
520 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
521 connect "irc.uplink.com" {
522 /* the name must go above */
524 /* host: the host or IP to connect to. If a hostname is used it
525 * must match the reverse dns of the server.
527 host = "203.0.113.3";
529 /* vhost: the host or IP to bind to for this connection. If this
530 * is not specified, the default vhost (in serverinfo {}) is used.
532 #vhost = "192.0.2.131";
534 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
535 * The remote server will have these passwords reversed.
537 send_password = "password";
538 accept_password = "anotherpassword";
540 /* fingerprint: if specified, the server's client certificate
541 * fingerprint will be checked against the specified fingerprint
544 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
546 /* port: the port to connect to this server on */
549 /* hub mask: the mask of servers that this server may hub. Multiple
550 * entries are permitted
554 /* leaf mask: the mask of servers this server may not hub. Multiple
555 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
559 /* class: the class this server is in */
562 /* flags: controls special options for this server
563 * encrypted - marks the accept_password as being crypt()'d
564 * autoconn - automatically connect to this server
565 * compressed - compress traffic via ziplinks
566 * topicburst - burst topics between servers
567 * ssl - ssl/tls encrypted server connections
569 flags = compressed, topicburst;
572 connect "ipv6.lame.server" {
573 /* Hosts that are IPv6 addresses must be in :: shortened form
574 * if applicable. Addresses starting with a colon get an extra
575 * zero prepended, for example: 0::1
577 host = "2001:db8:3::8";
578 send_password = "password";
579 accept_password = "password";
582 /* aftype: controls whether the connection uses "ipv4" or "ipv6".
589 connect "ssl.uplink.com" {
590 /* Example of ssl server-to-server connection, ssl flag doesn't need
591 * compressed flag, 'cause it uses own compression
593 host = "203.0.113.129";
594 send_password = "password";
595 accept_password = "anotherpassword";
599 flags = ssl, topicburst;
602 /* cluster {}; servers that we propagate things to automatically.
603 * NOTE: This does NOT grant them privileges to apply anything locally,
604 * you must add a seperate shared block for that. Clustering will
605 * only be done for actions by LOCAL opers, that arent directed
609 /* name: the server to share with, this can be a wildcard and may be
612 /* flags: list of what to share, all the name lines above this (up
613 * until another flags entry) will receive these flags.
615 * kline - share perm klines
616 * tkline - share temp klines
617 * unkline - share unklines
618 * locops - share locops
619 * xline - share perm xlines
620 * txline - share temp xlines
621 * unxline - share unxlines
622 * resv - share perm resvs
623 * tresv - share temp resvs
624 * unresv - share unresvs
625 * all - share all of the above
628 /* share klines/unklines/xlines with *.lan */
630 flags = kline, unkline, xline;
632 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
633 name = "irc.ircd-ratbox.org";
634 name = "ircd.ircd-ratbox.org";
638 /* service{}: privileged servers (services). These servers have extra
639 * privileges such as setting login names on users and introducing clients
640 * with umode +S (unkickable, hide channels, etc). This does not allow them
641 * to set bans, you need a separate shared{} for that.
642 * Do not place normal servers here.
643 * There may be only one service{} block.
646 /* name: the server name. These may be stacked. */
647 name = "services.int";
650 /* shared {}: users that are allowed to place remote bans on our server.
651 * NOTE: These are ordered top down. The first one the user@host and server
652 * matches will be used. Their access will then be decided on that
653 * block and will not fall back to another block that matches.
656 /* oper: the user@host and server the user must be on to set klines.
657 * The first field must be a user@host, the second field is an
658 * optional server. These may be stacked.
660 /* flags: list of what to allow them to place, all the oper lines
661 * above this (up until another flags entry) will receive these
662 * flags. This *must* be present.
664 * kline - allow setting perm/temp klines
665 * tkline - allow setting temp klines
666 * unkline - allow removing klines
667 * xline - allow setting perm/temp xlines
668 * txline - allow setting temp xlines
669 * unxline - allow removing xlines
670 * resv - allow setting perm/temp resvs
671 * tresv - allow setting temp resvs
672 * unresv - allow removing xlines
673 * all - allow oper/server to do all of above.
674 * locops - allow locops - only used for servers who cluster
675 * rehash - allow rehashing
676 * dline - allow setting perm/temp dlines
677 * tdline - allow setting temp dlines
678 * undline - allow removing dlines
679 * grant - allow granting operator status
680 * die - allow remote DIE/RESTART
681 * module - allow remote module commands
682 * none - disallow everything
685 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
686 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
688 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
689 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
692 /* you may forbid certain opers/servers from doing anything */
693 oper = "irc@vanity.oper", "*";
694 oper = "*@*", "irc.vanity.server";
695 oper = "irc@another.vanity.oper", "bigger.vanity.server";
698 /* or allow everyone to place temp klines */
703 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
707 /* these may be stacked */
711 /* The channel block contains options pertaining to channels */
713 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
714 * that can join a +i channel without an invite.
718 /* except: Enable/disable channel mode +e, a n!u@h list of masks
719 * that can join a channel through a ban (+b).
723 /* forward: Enable/disable channel mode +f, a channel to forward
724 * users to if they can't join because of +i etc. Also enables ban
725 * forwarding, <mask>$<channel>.
729 /* knock: Allows users to request an invite to a channel that
730 * is locked somehow (+ikl). If the channel is +p or you are banned
731 * the knock will not be sent.
735 /* knock delay: The amount of time a user must wait between issuing
738 knock_delay = 5 minutes;
740 /* knock channel delay: How often a knock to any specific channel
741 * is permitted, regardless of the user sending the knock.
743 knock_delay_channel = 1 minute;
745 /* max chans: The maximum number of channels a user can join/be on. */
746 max_chans_per_user = 15;
748 /* max chans (large): The extended maximum number of channels a user can join. */
749 max_chans_per_user_large = 60;
751 /* max bans: maximum number of +b/e/I/q modes in a channel */
754 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
755 max_bans_large = 500;
757 /* splitcode: split users, split servers and either no join on split
758 * or no create on split must be enabled for split checking.
759 * splitmode will be entered on either split users or split servers
760 * dropping below the limit.
762 * you may force splitmode to be permanent by /quote set splitmode on
765 /* split users: when the usercount is lower than this level, consider
766 * ourselves split. this must be set for automatic splitmode
768 default_split_user_count = 0;
770 /* split servers: when the amount of servers that have acknowledged
771 * theyve finished bursting is lower than this, consider ourselves
772 * split. this must be set for automatic splitmode
774 default_split_server_count = 0;
776 /* split: no create: disallow users creating channels on split */
777 no_create_on_split = no;
779 /* split: no join: disallow users joining channels at all on a split */
780 no_join_on_split = no;
782 /* burst topicwho: when bursting topics, also burst the topic setter */
783 burst_topicwho = yes;
785 /* kick on split riding: kick users riding splits to join +i or +k
786 * channels. more precisely, if a bursting server sends an SJOIN
787 * for a channel with a lower TS with either a +i mode or a +k
788 * mode with a different key, kick all local users.
790 * note: this does not take +r, +b, +e and +I into account.
792 kick_on_split_riding = no;
794 /* only ascii channels: disable local users joining channels
795 * containing characters outside the range 33-126 (non-printable
798 only_ascii_channels = no;
800 /* resv_forcepart: force any local users to part a channel
801 * when a RESV is issued.
803 resv_forcepart = yes;
805 /* channel target change: restrict how many channels users can
806 * message per unit of time. IRC operators, channel operators and
807 * voiced users are exempt.
809 channel_target_change = yes;
811 /* disable local channels: if yes, then local channels will not be
814 disable_local_channels = no;
816 /* autochanmodes: the channel modes that should be automatically set
817 * when a channel is created.
819 autochanmodes = "+nt";
821 /* displayed_usercount: the minimum amount of users on a channel before it
822 * is displayed in LIST. this parameter can be overridden using ELIST parameters,
825 displayed_usercount = 3;
827 /* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */
828 strip_topic_colors = no;
832 /* The serverhide block contains the options regarding serverhiding */
834 /* flatten links: this option will hide various routing information
835 * and make all servers in /links appear that they are linked to
840 /* links delay: how long to wait before showing splits or new
841 * servers in a flattened /links output.
843 links_delay = 5 minutes;
845 /* hidden: hide this server from a /links output on servers with
846 * flatten_links enabled. this allows hub servers to be hidden etc.
850 /* disable hidden: prevent servers hiding themselves from a
856 /* These are the blacklist settings.
857 * You can have multiple combinations of host and rejection reasons.
858 * They are used in pairs of one host/rejection reason.
860 * These settings should be adequate for most networks, and are (presently)
861 * required for use on StaticBox.
863 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
866 * As of charybdis 2.2, you can do some keyword substitution on the rejection
867 * reason. The available keyword substitutions are:
869 * ${ip} - the user's IP
870 * ${host} - the user's canonical hostname
871 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
872 * ${nick} - the user's nickname
873 * ${network-name} - the name of the network
875 * As of charybdis 3.4, a type parameter is supported, which specifies the
876 * address families the blacklist supports. IPv4 and IPv6 are supported.
877 * IPv4 is currently the default as few blacklists support IPv6 operation
878 * as of this writing.
880 * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
881 * is considered a match. If included, a comma-separated list of *quoted*
882 * strings is allowed to match queries. They may be of the format "0" to "255"
883 * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
884 * an A record. The blacklist is only applied if it matches anything in the
885 * list. You may freely mix full IP's and final octets.
887 * Consult your blacklist provider for the meaning of these parameters; they
888 * are usually used to denote different ban types.
891 host = "rbl.efnetrbl.org";
893 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
895 /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
896 # host = "foobl.blacklist.invalid";
897 # matches = "4", "6", "127.0.0.10";
899 # 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";
903 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
904 * They send PRIVMSG to the given target. A real command takes
905 * precedence above an alias.
908 /* the name must go above */
910 /* target: the target nick (must be a network service) or
911 * user@server (cannot be this server, only opers can use
912 * user starting with "opers" reliably, interpreted on the target
913 * server only so you may need to use nick@server instead)
946 /* The general block contains many of the options that were once compiled
947 * in options in config.h. The general block is read at start time.
950 /* hide error messages: defines whether error messages from
951 * servers that are not deemed fully safe are hidden or not.
952 * These can sometimes contain IPs and can have an adverse
953 * effect on server ip hiding. Set to:
954 * yes: hide from opers and admin
955 * opers: hide from opers only
956 * no: do not hide error messages
957 * Admins on other servers count as opers.
959 hide_error_messages = opers;
961 /* hide spoof ips: hide the real ips of auth{} spoofed users
962 * If disabled, local opers can see them.
963 * Dynamic spoofs (e.g. set by services) are unaffected by this;
964 * any oper (local and remote) can see the real ip.
966 hide_spoof_ips = yes;
968 /* default umodes: umodes to set upon connection
969 * If you have enabled the ip_cloaking extension, and you wish for
970 * incoming clients to be set +h or +x upon connection, add +h or +x to the umode
973 default_umodes = "+i";
975 /* default operstring: defines the default oper response
976 * in /whois queries, eg "is an IRC Operator".
977 * After startup use /quote set operstring to change.
979 default_operstring = "is an IRC Operator";
981 /* default adminstring: defines the default admin response
982 * in /whois queries, eg "is a Server Administrator".
983 * After startup use /quote set adminstring to change.
985 default_adminstring = "is a Server Administrator";
987 /* servicestring: defines the response for opered services (+S)
988 * in /whois queries, eg "is a Network Service".
989 * This is updated on rehash.
991 servicestring = "is a Network Service";
994 * Nick of the network's SASL agent. Used to check whether services are here,
995 * SASL credentials are only sent to its server. Needs to be a service.
997 * Defaults to SaslServ if unspecified.
999 sasl_service = "SaslServ";
1001 /* disable fake channels: disable local users joining fake versions
1002 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
1003 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
1005 disable_fake_channels = no;
1007 /* tkline_expire_notices: give a notice to opers when a tkline
1010 tkline_expire_notices = no;
1012 /* floodcount: the default value of floodcount that is configurable
1013 * via /quote set floodcount. This is the amount of lines a user
1014 * may send to any other user/channel in one second.
1016 default_floodcount = 10;
1018 /* failed oper notice: send a notice to all opers on the server when
1019 * someone tries to OPER and uses the wrong password, host or ident.
1021 failed_oper_notice = yes;
1023 /* dots in ident: the amount of '.' characters permitted in an ident
1024 * reply before the user is rejected.
1028 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
1029 * placed via the server. klines hand placed are exempt from limits.
1030 * wildcard chars: '.' '*' '?' '@'
1032 min_nonwildcard = 4;
1034 /* min nonwildcard simple: the minimum non wildcard characters in
1035 * xlines/resvs placed via the server.
1036 * wildcard chars: '*' '?'
1038 min_nonwildcard_simple = 3;
1040 /* max accept: maximum allowed /accept's for +g usermode */
1043 /* max monitor: the maximum amount of nicknames a client may have in
1044 * their monitor (server-side notify) list.
1048 /* nick flood: enable the nickflood control code */
1049 anti_nick_flood = yes;
1051 /* nick flood: the nick changes allowed in the specified period */
1052 max_nick_time = 20 seconds;
1053 max_nick_changes = 5;
1055 /* anti spam time: the minimum time a user must be connected before
1056 * custom quit messages are allowed.
1058 anti_spam_exit_message_time = 5 minutes;
1060 /* ts delta: the time delta allowed between server clocks before
1061 * a warning is given, or before the link is dropped. all servers
1062 * should run ntpdate/rdate to keep clocks in sync
1064 ts_warn_delta = 30 seconds;
1065 ts_max_delta = 5 minutes;
1067 /* client exit: prepend a user's quit message with "Quit: " */
1070 /* collision fnc: change user's nick to their UID instead of
1071 * killing them, if possible. This setting only applies to nick
1072 * collisions detected on this server. Only enable this if
1073 * all servers on the network allow remote nicks to start with
1076 collision_fnc = yes;
1078 /* resv fnc: change a user's nick to a nick they have recently used
1079 * (or their UID, if no such nick can be found) when a resv matching
1080 * them is set by services. Only enable this if all servers on the
1081 * network allow remote nicks to start with a digit.
1085 /* global snotices: send out certain snotices (most +b, +f, +y,
1086 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1087 * displayed unconditionally.
1089 global_snotices = yes;
1091 /* dline reason: show the user the dline reason when they connect
1094 dline_with_reason = yes;
1096 /* kline delay: delay the checking of klines until a specified time.
1097 * Useful if large kline lists are applied often to prevent the
1098 * server eating CPU.
1100 kline_delay = 0 seconds;
1102 /* kline reason: show the user the reason why they are k/dlined
1103 * on exit. may give away who set k/dline when set via tcm.
1105 kline_with_reason = yes;
1107 /* kline reason: make the users quit message on channels this
1108 * reason instead of the oper's reason.
1110 kline_reason = "Connection closed";
1112 /* identify to services via server password
1113 * if auth{} block had no password but the user specified a
1114 * server password anyway, send a PRIVMSG to <identify_service>
1115 * with as text <identify_command> <password>.
1117 identify_service = "NickServ@services.int";
1118 identify_command = "IDENTIFY";
1120 /* non redundant klines: flag and ignore redundant klines */
1121 non_redundant_klines = yes;
1123 /* warn no nline: warn opers about servers that try to connect but
1124 * we dont have a connect {} block for. Twits with misconfigured
1125 * servers can get really annoying with this enabled.
1127 warn_no_nline = yes;
1129 /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
1130 * That means the bans are part of the netburst and restarted/split
1131 * servers will get them, but they will not apply to 3.2 and older
1134 use_propagated_bans = yes;
1136 /* stats e disabled: disable stats e. useful if server ips are
1137 * exempted and you dont want them listing on irc.
1139 stats_e_disabled = no;
1141 /* stats c oper only: make stats c (connect {}) oper only */
1142 stats_c_oper_only=no;
1144 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
1145 stats_h_oper_only=no;
1147 /* stats y oper only: make stats y (class {}) oper only */
1148 stats_y_oper_only=no;
1150 /* stats o oper only: make stats o (opers) oper only */
1151 stats_o_oper_only=yes;
1153 /* stats P oper only: make stats P (ports) oper only
1154 * NOTE: users doing stats P will never be given the ips that the
1155 * server listens on, simply the ports.
1157 stats_P_oper_only=no;
1159 /* stats i oper only: make stats i (auth {}) oper only. set to:
1160 * yes: show users no auth blocks, made oper only.
1161 * masked: show users first matching auth block
1162 * no: show users all auth blocks.
1164 stats_i_oper_only=masked;
1166 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1167 * yes: show users no auth blocks, made oper only
1168 * masked: show users first matching auth block
1169 * no: show users all auth blocks.
1171 stats_k_oper_only=masked;
1173 /* map oper only: make /map oper only */
1176 /* operspy admin only: make operspy notices to +Z admin only */
1177 operspy_admin_only = no;
1179 /* operspy dont care user info: treat /who mask as if there was
1180 * an '!' always; do not log or server notice about operspy
1181 * /who mask, /masktrace and /scan. channel information is still
1183 operspy_dont_care_user_info = no;
1185 /* caller id wait: time between notifying a +g user that somebody
1186 * is messaging them.
1188 caller_id_wait = 1 minute;
1190 /* pace wait simple: time between use of less intensive commands
1191 * (HELP, remote WHOIS, WHOWAS)
1193 pace_wait_simple = 1 second;
1195 /* pace wait: time between more intensive commands
1196 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1198 pace_wait = 10 seconds;
1200 /* short motd: send clients a notice telling them to read the motd
1201 * instead of forcing a motd to clients who may simply ignore it.
1205 /* ping cookies: require clients to respond exactly to a ping command,
1206 * can help block certain types of drones and FTP PASV mode spoofing.
1210 /* connect timeout: sets how long we should wait for a connection
1211 * request to succeed
1213 connect_timeout = 30 seconds;
1215 /* ident timeout: Amount of time (in seconds) that the IRCd will
1216 * wait for a user to respond to an ident request.
1218 default_ident_timeout = 5;
1220 /* disable auth: disables identd checking */
1223 /* no oper flood: increase flood limits for opers. */
1224 no_oper_flood = yes;
1226 /* REMOVE ME. The following line checks you've been reading. */
1227 havent_read_conf = yes;
1229 /* max targets: the maximum amount of targets in a single
1230 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1234 /* use_whois_actually: send clients requesting a whois a numeric
1235 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1237 use_whois_actually = yes;
1239 /* usermodes configurable: a list of usermodes for the options below
1241 * +g - callerid - Server Side Ignore
1242 * +D - deaf - Don't see channel messages
1243 * +i - invisible - Not shown in NAMES or WHO unless you share a
1245 * +l - locops - See LOCOPS messages
1246 * +Q - noforward - Unaffected by channel forwarding
1247 * +R - regonlymsg - No messages from unindentified
1248 * +s - servnotice - See server notices
1249 * +w - wallop - See oper and server generated WALLOPS
1250 * +z - operwall - See operwalls
1253 /* oper only umodes: usermodes only opers may set */
1254 oper_only_umodes = operwall, locops, servnotice;
1256 /* oper umodes: default usermodes opers get when they /oper */
1257 oper_umodes = locops, servnotice, operwall, wallop;
1259 /* oper snomask: default snomask opers get when they /oper,
1260 * provided they have umode +s set */
1261 oper_snomask = "+s";
1263 /* compression level: level of compression for compressed links between
1266 * values are between: 1 (least compression, fastest)
1267 * and: 9 (most compression, slowest).
1269 #compression_level = 6;
1271 /* burst_away: This enables bursting away messages to servers.
1272 * With this disabled, we will only propogate AWAY messages
1273 * as users send them, but never burst them. Be warned though
1274 * enabling this could increase the size of a burst significantly
1275 * for a large network, like EFnet.
1279 /* nick delay: This locks nicks of split clients for the given time
1280 * or until a remote client uses the nick. This significantly
1281 * reduces nick collisions on short splits but it can be annoying.
1282 * To make things as fair as possible, this should be the same on
1283 * all servers. If you enable this, the suggested value is 15 minutes.
1285 nick_delay = 0 seconds;
1287 /* reject time: the amount of rejections through klines/dlines etc
1288 * allowed in the given time before the rejection is cached and
1289 * a pseudo temp dline is placed
1291 reject_ban_time = 1 minute;
1292 reject_after_count = 3;
1294 /* reject duration: the amount of time to cache the rejection */
1295 reject_duration = 5 minutes;
1297 /* throttle_duration: Amount of time that throttling will be applied to an IP
1300 throttle_duration = 60;
1302 /* throttle_count: Number of connections within throttle_duration that it takes
1303 * for throttling to take effect */
1306 /* client flood_max_lines: maximum number of lines in a clients queue before
1307 * they are dropped for flooding.
1309 client_flood_max_lines = 20;
1311 /* Flood control settings. DO NOT CHANGE THESE without extensive discussion
1312 * and testing by someone who knows exactly what they do.
1314 * These settings replicate charybdis-3.3 behaviour.
1316 client_flood_burst_rate = 40;
1317 client_flood_burst_max = 5;
1318 client_flood_message_time = 1;
1319 client_flood_message_num = 2;
1321 /* max_ratelimit_tokens: the maximum number of ratelimit tokens that one
1322 * user can accumulate. This attempts to limit the amount of outbound
1323 * bandwidth one user can consume. Do not change unless you know what
1326 max_ratelimit_tokens = 30;
1328 /* away_interval: the minimum interval between AWAY commands. One
1329 * additional AWAY command is allowed, and only marking as away
1334 /* certfp_method: the method that should be used for computing certificate fingerprints.
1335 * Acceptable options are sha1, sha256 and sha512. Networks running versions of charybdis
1336 * prior to charybdis 3.5 MUST use sha1 for certfp_method.
1338 certfp_method = sha1;
1340 /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
1341 hide_opers_in_whois = no;
1345 /* module path: paths to search for modules specified below and
1348 path = "/usr/local/ircd/modules";
1349 path = "/usr/local/ircd/modules/autoload";
1351 /* module: the name of a module to load on startup/rehash */
1352 #module = "some_module.la";