1 /* doc/reference.conf - solanum 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
47 * Channel mode +-T (blocks notices) -- chm_nonotice
48 * Channel mode +-O (oper only) -- chm_operonly
49 * Channel mode +-S (ssl only) -- chm_sslonly
50 * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat
51 * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat
52 * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat
53 * Channel mode +-M (disallow KICK on IRC ops) -- chm_operpeace
54 * Restrict channel creation to logged in users -- createauthonly
55 * Account bans (+b $a[:mask]) -- extb_account
56 * Banned from another channel (+b $j:mask) -- extb_canjoin
57 * Other-channel bans (+b $c:mask) -- extb_channel
58 * Combination extbans -- extb_combi
59 * Extended ban (+b $x:mask) -- extb_extgecos
60 * Hostmask bans (for combination extbans) -- extb_hostmask
61 * Oper bans (+b $o) -- extb_oper
62 * Realname (gecos) bans (+b $r:mask) -- extb_realname
63 * Server bans (+b $s:mask) -- extb_server
64 * SSL bans (+b $z) -- extb_ssl
65 * User mode bans (+b $u:modes) -- extb_usermode
66 * Helpops system (umode +h) -- helpops
68 * New host mangling (umode +x) -- ip_cloaking_4.0
69 * Old host mangling (umode +h) -- ip_cloaking
70 * Dynamically extend channel limits -- m_extendchans
71 * Find channel forwards -- m_findforwards
72 * /identify support -- m_identify
73 * /locops support -- m_locops
74 * Opers cannot be invisible (umode +i) -- no_oper_invis
75 * Far connection notices (snomask +F) -- sno_farconnect
76 * Remote k/d/x line active notices -- sno_globalkline
77 * Remote oper up notices -- sno_globaloper
78 * Global nick-change notices -- sno_globalnickchange
79 * /whois notifications (snomask +W) -- sno_whois
80 * Oper-override (modehacking only) -- override
81 * Stop services kills -- no_kill_services
83 #loadmodule "extensions/chm_adminonly";
84 #loadmodule "extensions/chm_nonotice";
85 #loadmodule "extensions/chm_operonly";
86 #loadmodule "extensions/chm_sslonly";
87 #loadmodule "extensions/chm_operonly_compat";
88 #loadmodule "extensions/chm_quietunreg_compat";
89 #loadmodule "extensions/chm_sslonly_compat";
90 #loadmodule "extensions/chm_operpeace";
91 #loadmodule "extensions/createauthonly";
92 #loadmodule "extensions/extb_account";
93 #loadmodule "extensions/extb_canjoin";
94 #loadmodule "extensions/extb_channel";
95 #loadmodule "extensions/extb_combi";
96 #loadmodule "extensions/extb_extgecos";
97 #loadmodule "extensions/extb_hostmask";
98 #loadmodule "extensions/extb_oper";
99 #loadmodule "extensions/extb_realname";
100 #loadmodule "extensions/extb_server";
101 #loadmodule "extensions/extb_ssl";
102 #loadmodule "extensions/extb_usermode";
103 #loadmodule "extensions/helpops";
104 #loadmodule "extensions/hurt";
105 #loadmodule "extensions/ip_cloaking_4.0";
106 #loadmodule "extensions/ip_cloaking";
107 #loadmodule "extensions/m_extendchans";
108 #loadmodule "extensions/m_findforwards";
109 #loadmodule "extensions/m_identify";
110 #loadmodule "extensions/m_locops";
111 #loadmodule "extensions/no_oper_invis";
112 #loadmodule "extensions/sno_farconnect";
113 #loadmodule "extensions/sno_globalkline";
114 #loadmodule "extensions/sno_globalnickchange";
115 #loadmodule "extensions/sno_globaloper";
116 #loadmodule "extensions/sno_whois";
117 #loadmodule "extensions/override";
118 #loadmodule "extensions/no_kill_services";
120 /* serverinfo {}: Contains information about the server. (OLD M:) */
122 /* name: the name of our server */
125 /* sid: the unique server id of our server. This must be three
126 * characters long. The first character must be a digit [0-9], the
127 * remaining two chars may be letters [A-Z] or digits [0-9].
129 * This parameter must be specified for the server to start.
133 /* description: the description of our server. '[' and ']' may not
134 * be used here for compatibility with older servers.
136 description = "charybdis test server";
138 /* network info: the name and description of the network this server
139 * is on. Shown in the 005 reply and used with serverhiding.
141 network_name = "MyNet";
143 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
144 * This should be an ipv4 IP only.
146 #vhost = "192.0.2.6";
148 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
149 * This should be an ipv6 IP only.
151 #vhost6 = "2001:db8:2::6";
153 /* ssl_cert: certificate (and optionally key) for our ssl server */
154 ssl_cert = "etc/ssl.pem";
156 /* ssl_private_key: our ssl private key (if not contained in ssl_cert file) */
157 #ssl_private_key = "etc/ssl.key";
159 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 2048 */
160 /* If you do not provide parameters, some TLS backends will fail on DHE- ciphers,
161 and some will succeed but use weak, common DH groups! */
162 ssl_dh_params = "etc/dh.pem";
164 /* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
165 #ssl_cipher_list = "EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
167 /* ssld_count: number of ssld processes you want to start, if you
168 * have a really busy server, using N-1 where N is the number of
169 * cpu/cpu cores you have might be useful. A number greater than one
170 * can also be useful in case of bugs in ssld and because ssld needs
171 * two file descriptors per SSL connection.
175 /* default max clients: the default maximum number of clients
176 * allowed to connect. This can be changed once ircd has started by
178 * /quote set maxclients <limit>
180 default_max_clients = 1024;
182 /* nicklen: enforced nickname length (for this server only; must not
183 * be longer than the maximum length set while building).
188 /* admin {}: contains admin information about the server. (OLD A:) */
190 name = "Smurf target";
191 description = "Main Server Administrator";
192 email = "<syn@packets.r.us>";
195 /* log {}: contains information about logfiles. */
197 /* logfiles: the logfiles to use for specific activity. if these
198 * paths are defined, then ircd will log to them, otherwise it wont.
200 * The confs are, in order:
201 * - userlog: user exits
202 * - fuserlog: failed user connections
203 * - operlog: /oper usage
204 * - foperlog: failed /oper usage
205 * - serverlog: server connects/disconnects
206 * - klinelog: klines, etc
208 * - operspylog: operspy usage
209 * - ioerrorlog: IO errors
211 fname_userlog = "logs/userlog";
212 #fname_fuserlog = "logs/fuserlog";
213 fname_operlog = "logs/operlog";
214 #fname_foperlog = "logs/foperlog";
215 fname_serverlog = "logs/serverlog";
216 #fname_klinelog = "logs/klinelog";
217 fname_killlog = "logs/killlog";
218 fname_operspylog = "logs/operspylog";
219 #fname_ioerrorlog = "logs/ioerror";
222 /* class {}: contain information about classes for users (OLD Y:) */
224 /* class name must go above */
226 /* ping time: how often a client must reply to a PING from the
227 * server before they are dropped.
229 ping_time = 2 minutes;
231 /* number per ident: the number of users per user@host networkwide
232 * allowed to connect. Unidented connections are classified as
235 number_per_ident = 2;
237 /* number per ip: the number of local users per host allowed */
240 /* number per ip global: the number of network wide connections
241 * per host allowed for a user, including connections to the
244 number_per_ip_global = 5;
246 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
248 cidr_ipv4_bitlen = 24;
250 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
251 * the following example makes the subnet /64 this is useful
252 * for IPv6 connections in particular
254 cidr_ipv6_bitlen = 64;
256 /* number_per_cidr: Number of connections to allow from a subnet of the
257 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
258 * 4 seems to be a good default to me.
262 /* max number: the maximum number of users allowed in this class */
265 /* sendq: the amount of data allowed in a clients queue before
272 ping_time = 1 minute 30 seconds;
279 ping_time = 5 minutes;
286 ping_time = 5 minutes;
288 /* connectfreq: only used in server classes. specifies the delay
289 * between autoconnecting to servers.
291 connectfreq = 5 minutes;
293 /* max_autoconn: the amount of servers to autoconnect to. if the number
294 * of servers in the class is or exceeds this, no more servers in the
295 * class are autoconnected. oper initiated connects are unaffected.
296 * this should usually be set to either 0 or 1. (autoconnecting from
297 * hubs to leaves may cause leaves to function as hubs by having
298 * multiple servers connected to them.)
302 /* max_number: the maximum number of servers allowed in this class */
305 /* sendq: servers need a higher sendq as they are sent more data */
309 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
311 /* defer_accept: wait for clients to send IRC handshake data before
312 * accepting them. if you intend to use software which depends on the
313 * server replying first, such as BOPM, you should disable this feature.
314 * otherwise, you probably want to leave it on.
318 /* port: the specific port to listen on. if no host is specified
319 * before, it will listen on all available IPs.
321 * sslport: the specific port to listen ssl connections on. if no
322 * host is specified before, it will listen on all available IPs.
324 * ports are seperated via a comma, a range may be specified using ".."
327 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
328 port = 5000, 6665 .. 6669;
330 /* sslport: listen for ssl connections on all available IPs, port 6697 */
333 /* host: set a specific IP/host the ports after the line will listen
334 * on. This may be ipv4 or ipv6.
338 sslport = 9000, 9001;
340 host = "2001:db8:2::6";
344 /* wsock: listeners defined with this option enabled will be websocket listeners,
345 * and will not accept normal clients.
351 /* auth {}: allow users to connect to the ircd (OLD I:) */
353 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
354 * lines are permitted per auth block. This is matched against the
355 * hostname and IP address (using :: shortening for IPv6 and
356 * prepending a 0 if it starts with a colon) and can also use CIDR
359 user = "*@198.51.100.0/24";
360 user = "*test@2001:db8:1:*";
362 /* auth_user: This allows specifying a username:password instead of
363 * just a password in PASS, so that a fixed user@host is not
364 * necessary for a specific auth{} block.
366 #auth_user = "SomeUser";
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 /* Possible flags in auth:
382 * encrypted | password is encrypted with mkpasswd
383 * spoof_notice | give a notice when spoofing hosts
384 * exceed_limit (old > flag) | allow user to exceed class user limits
385 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines,
386 * | dnsbls, and proxies
387 * dnsbl_exempt | exempt this user from dnsbls
388 * proxy_exempt | exempt this user from proxies
389 * spambot_exempt | exempt this user from spambot checks
390 * shide_exempt | exempt this user from serverhiding
391 * jupe_exempt | exempt this user from generating
392 * warnings joining juped channels
393 * resv_exempt | exempt this user from resvs
394 * flood_exempt | exempt this user from flood limits
396 * no_tilde (old - flag) | don't prefix ~ to username if no ident
397 * need_ident (old + flag) | require ident for user in this class
398 * need_ssl | require SSL/TLS for user in this class
399 * need_sasl | require SASL id for user in this class
400 * extend_chans | allow this user to join more channels than normal
401 * kline_spoof_ip | if this block has a spoof host, klines match only
402 * | the spoof and not the underlying IP
404 flags = kline_exempt, exceed_limit;
406 /* class: the class the user is placed in */
411 /* redirect: the server and port to redirect a user to. A user does
412 * not have to obey the redirection, the ircd just suggests to them
413 * an alternative server.
415 redirserv = "irc.example.net";
418 user = "*.example.com";
420 /* class: a class is required even though it is not used */
429 /* privset{}: defines operator privilege sets. */
431 /* privs: controls the activities and commands an oper is
432 * allowed to do on the server
436 * oper:general: enable most general oper privileges that came
437 * with +o in older releases
438 * auspex:oper: allows the oper to see through oper hiding
439 * auspex:umodes: allows viewing other users' modes
440 * auspex:cmodes: shows privileged cmodes
441 * auspex:hostname: shows hidden hostnames/ips
442 * oper:privs: allows /stats o/O and seeing privset in /whois
443 * oper:testline: allows /testline and /testgecos
444 * oper:kill: allows local and remote users to be /KILL'd
445 * oper:routing: allows remote SQUIT and CONNECT
446 * oper:kline: allows KLINE and DLINE
447 * oper:unkline: allows UNKLINE and UNDLINE
448 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
449 * oper:rehash: allows oper to REHASH config
450 * oper:die: allows DIE and RESTART
451 * oper:admin: gives admin privileges. admins
452 * may (un)load modules and see various
453 * additional information.
454 * oper:hidden_admin: gives admin privileges except
455 * will not have the admin lines in
457 * oper:xline: allows use of /quote xline/unxline
458 * oper:resv: allows /quote resv/unresv
459 * oper:cmodes: allows cmode +LP
460 * oper:operwall: allows the oper to send/receive operwalls
461 * oper:spy: allows 'operspy' features to see through +s
462 * channels etc. see /quote help operspy
463 * oper:hidden: hides the oper from /stats p
464 * oper:remoteban: allows remote kline etc
465 * oper:mass_notice: allows sending wallops and mass notices
466 * oper:grant: allows using the GRANT command
467 * usermode:servnotice: allows setting +s
469 * Privileges provided by extensions include:
471 * oper:dehelper: allows the DEHELPER command (from extensions/helpops)
472 * oper:override: enables oper override via umode +p (from extensions/override)
473 * oper:receive_immunity:
474 * confers the benefits of chmode +M (operpeace) (from extensions/chm_operpeace)
475 * usermode:helpops allows setting +h (from extensions/helpops)
477 privs = oper:general, oper:privs, oper:testline, oper:kill, oper:operwall, usermode:servnotice,
478 auspex:oper, auspex:hostname, auspex:umodes, auspex:cmodes;
481 privset "server_bot" {
482 /* extends: a privset to inherit in this privset */
483 extends = "local_op";
484 privs = oper:kline, oper:remoteban, snomask:nick_changes;
487 privset "global_op" {
488 extends = "local_op";
489 privs = oper:routing, oper:kline, oper:unkline, oper:xline,
490 oper:resv, oper:cmodes, oper:mass_notice, oper:remoteban;
494 extends = "global_op";
495 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
498 /* operator {}: defines ircd operators. (OLD O:) */
500 /* name: the name of the oper must go above */
502 /* user: the user@host required for this operator. CIDR *is*
503 * supported now. auth{} spoofs work here, other spoofs do not.
504 * multiple user="" lines are supported.
507 user = "*@127.0.0.1";
509 /* password: the password required to oper. Unless ~encrypted is
510 * contained in flags = ...; this will need to be encrypted using
511 * mkpasswd, MD5 is supported
513 password = "etcnjl8juSU1E";
515 /* rsa key: the public key for this oper when using Challenge.
516 * A password should not be defined when this is used, see
517 * doc/challenge.txt for more information.
519 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
521 /* fingerprint: if specified, the oper's client certificate
522 * fingerprint will be checked against the specified fingerprint
525 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
527 /* umodes: the specific umodes this oper gets when they oper.
528 * If this is specified an oper will not be given oper_umodes
529 * These are described above oper_only_umodes in general {};
531 #umodes = locops, servnotice, operwall, wallop;
533 /* snomask: specific server notice mask on oper up.
534 * If this is specified an oper will not be given oper_snomask.
536 snomask = "+Zbfkrsuy";
538 /* flags: misc options for the operator. You may prefix an option
539 * with ~ to disable it, e.g. ~encrypted.
541 * Default flags are encrypted.
545 * encrypted: the password above is encrypted [DEFAULT]
546 * need_ssl: must be using SSL/TLS to oper up
550 /* privset: privileges set to grant */
554 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
555 connect "irc.uplink.com" {
556 /* the name must go above */
558 /* host: the host or IP to connect to. If a hostname is used it
559 * must match the reverse dns of the server.
561 host = "203.0.113.3";
563 /* vhost: the host or IP to bind to for this connection. If this
564 * is not specified, the default vhost (in serverinfo {}) is used.
566 #vhost = "192.0.2.131";
568 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
569 * The remote server will have these passwords reversed.
571 send_password = "password";
572 accept_password = "anotherpassword";
574 /* fingerprint: if flags = ssl is specified, the server's
575 * certificate fingerprint will be checked against the fingerprint
576 * specified below. required if using flags = ssl.
578 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
580 /* port: the port to connect to this server on */
583 /* hub mask: the mask of servers that this server may hub. Multiple
584 * entries are permitted
588 /* leaf mask: the mask of servers this server may not hub. Multiple
589 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
593 /* class: the class this server is in */
596 /* flags: controls special options for this server
597 * encrypted - marks the accept_password as being crypt()'d
598 * autoconn - automatically connect to this server
599 * compressed - compress traffic via ziplinks
600 * topicburst - burst topics between servers
601 * ssl - ssl/tls encrypted server connections
602 * no-export - marks the link as a no-export link (not exported to other links)
604 flags = compressed, topicburst;
607 connect "ipv6.lame.server" {
609 host = "2001:db8:3::8";
610 send_password = "password";
611 accept_password = "password";
614 /* aftype: controls whether the outgoing connection uses "ipv4" or "ipv6".
615 * Default is to try either at random.
621 connect "ssl.uplink.com" {
622 /* Example of ssl server-to-server connection, ssl flag doesn't need
623 * compressed flag, 'cause it uses own compression
625 host = "203.0.113.129";
626 send_password = "password";
627 accept_password = "anotherpassword";
631 flags = ssl, topicburst;
634 /* cluster {}; servers that we propagate things to automatically. */
636 /* name: the server to share with, this can be a wildcard and may be
639 /* flags: list of what to share, all the name lines above this (up
640 * until another flags entry) will receive these flags.
642 * kline - share perm klines
643 * tkline - share temp klines
644 * unkline - share unklines
645 * locops - share locops
646 * xline - share perm xlines
647 * txline - share temp xlines
648 * unxline - share unxlines
649 * resv - share perm resvs
650 * tresv - share temp resvs
651 * unresv - share unresvs
652 * all - share all of the above
655 /* share klines/unklines/xlines with *.lan */
657 flags = kline, unkline, xline;
659 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
660 name = "irc.ircd-ratbox.org";
661 name = "ircd.ircd-ratbox.org";
665 /* service{}: privileged servers (services). These servers have extra
666 * privileges such as setting login names on users and introducing clients
667 * with umode +S (unkickable, hide channels, etc).
668 * Do not place normal servers here.
669 * There may be only one service{} block.
672 /* name: the server name. These may be stacked. */
673 name = "services.int";
676 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
680 /* these may be stacked */
684 /* secure {}: IPs that are considered to be secure networks, and get
685 * +Z without using TLS */
690 /* The channel block contains options pertaining to channels */
692 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
693 * that can join a +i channel without an invite.
697 /* except: Enable/disable channel mode +e, a n!u@h list of masks
698 * that can join a channel through a ban (+b).
702 /* forward: Enable/disable channel mode +f, a channel to forward
703 * users to if they can't join because of +i etc. Also enables ban
704 * forwarding, <mask>$<channel>.
708 /* knock: Allows users to request an invite to a channel that
709 * is locked somehow (+ikl). If the channel is +p or you are banned
710 * the knock will not be sent.
714 /* knock delay: The amount of time a user must wait between issuing
717 knock_delay = 5 minutes;
719 /* knock channel delay: How often a knock to any specific channel
720 * is permitted, regardless of the user sending the knock.
722 knock_delay_channel = 1 minute;
724 /* max chans: The maximum number of channels a user can join/be on. */
725 max_chans_per_user = 15;
727 /* max chans (large): The extended maximum number of channels a user can join. */
728 max_chans_per_user_large = 60;
730 /* max bans: maximum number of +b/e/I/q modes in a channel */
733 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
734 max_bans_large = 500;
736 /* splitcode: split users, split servers and either no join on split
737 * or no create on split must be enabled for split checking.
738 * splitmode will be entered on either split users or split servers
739 * dropping below the limit.
741 * you may force splitmode to be permanent by /quote set splitmode on
744 /* split users: when the usercount is lower than this level, consider
745 * ourselves split. this must be set for automatic splitmode
747 default_split_user_count = 0;
749 /* split servers: when the amount of servers that have acknowledged
750 * theyve finished bursting is lower than this, consider ourselves
751 * split. this must be set for automatic splitmode
753 default_split_server_count = 0;
755 /* split: no create: disallow users creating channels on split */
756 no_create_on_split = no;
758 /* split: no join: disallow users joining channels at all on a split */
759 no_join_on_split = no;
761 /* burst topicwho: when bursting topics, also burst the topic setter */
762 burst_topicwho = yes;
764 /* kick on split riding: kick users riding splits to join +i or +k
765 * channels. more precisely, if a bursting server sends an SJOIN
766 * for a channel with a lower TS with either a +i mode or a +k
767 * mode with a different key, kick all local users.
769 * note: this does not take +r, +b, +e and +I into account.
771 kick_on_split_riding = no;
773 /* only ascii channels: disable local users joining channels
774 * containing characters outside the range 33-126 (non-printable
777 only_ascii_channels = no;
779 /* resv_forcepart: force any local users to part a channel
780 * when a RESV is issued.
782 resv_forcepart = yes;
784 /* channel target change: restrict how many channels users can
785 * message per unit of time. IRC operators, channel operators and
786 * voiced users are exempt.
788 channel_target_change = yes;
790 /* disable local channels: if yes, then local channels will not be
793 disable_local_channels = no;
795 /* autochanmodes: the channel modes that should be automatically set
796 * when a channel is created.
798 autochanmodes = "+nt";
800 /* displayed_usercount: the minimum amount of users on a channel before it
801 * is displayed in LIST. this parameter can be overridden using ELIST parameters,
804 displayed_usercount = 3;
806 /* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */
807 strip_topic_colors = no;
809 /* opmod_send_statusmsg: format messages sent to ops due to +z
810 * as PRIVMSG @#channel when sent to clients.
812 opmod_send_statusmsg = no;
816 /* The serverhide block contains the options regarding serverhiding */
818 /* flatten links: this option will hide various routing information
819 * and make all servers in /links appear that they are linked to
824 /* links delay: how long to wait before showing splits or new
825 * servers in a flattened /links output.
827 links_delay = 5 minutes;
829 /* hidden: hide this server from a /links output on servers with
830 * flatten_links enabled. this allows hub servers to be hidden etc.
834 /* disable hidden: prevent servers hiding themselves from a
840 /* These are the blacklist settings.
841 * You can have multiple combinations of host and rejection reasons.
842 * They are used in pairs of one host/rejection reason.
844 * These settings should be adequate for most networks.
846 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
849 * As of charybdis 2.2, you can do some keyword substitution on the rejection
850 * reason. The available keyword substitutions are:
852 * ${ip} - the user's IP
853 * ${host} - the user's canonical hostname
854 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
855 * ${nick} - the user's nickname
856 * ${network-name} - the name of the network
858 * As of charybdis 3.4, a type parameter is supported, which specifies the
859 * address families the blacklist supports. IPv4 and IPv6 are supported.
860 * IPv4 is currently the default as few blacklists support IPv6 operation
861 * as of this writing.
863 * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
864 * is considered a match. If included, a comma-separated list of *quoted*
865 * strings is allowed to match queries. They may be of the format "0" to "255"
866 * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
867 * an A record. The blacklist is only applied if it matches anything in the
868 * list. You may freely mix full IP's and final octets.
870 * Consult your blacklist provider for the meaning of these parameters; they
871 * are usually used to denote different ban types.
874 host = "rbl.efnetrbl.org";
876 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
878 /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
879 # host = "foobl.blacklist.invalid";
880 # matches = "4", "6", "127.0.0.10";
882 # 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";
885 /* These are the OPM settings.
886 * This is similar to the functionality provided by BOPM. It will scan incoming
887 * connections for open proxies by connecting to clients and attempting several
888 * different open proxy handshakes. If they connect back to us (via a dedicated
889 * listening port), and send back the data we send them, they are considered
890 * an open proxy. For politeness reasons (users may be confused by the incoming
891 * connection attempts if they are logging incoming connections), the user is
892 * notified upon connect if they are being scanned.
895 * These settings are considered experimental. Only the most common proxy types
896 * are checked for (Charybdis is immune from POST and GET proxies). If you are
897 * not comfortable with experimental code, do not use this feature.
900 /* IPv4 address to listen on. This must be a publicly facing IP address
902 * If omitted, it defaults to serverinfo::vhost.
904 #listen_ipv4 = "127.0.0.1";
906 /* IPv4 port to listen on.
907 * This should not be the same as any existing listeners.
911 /* IPv6 address to listen on. This must be a publicly facing IP address
913 * If omitted, it defaults to serverinfo::vhost6.
915 #listen_ipv6 = "::1";
917 /* IPv6 port to listen on.
918 * This should not be the same as any existing listeners.
922 /* You can also set the listen_port directive which will set both the
923 * IPv4 and IPv6 ports at once.
925 #listen_port = 32000;
927 /* This sets the timeout in seconds before ending open proxy scans.
928 * Values less than 1 or greater than 60 are ignored.
929 * It is advisable to keep it as short as feasible, so clients do not
930 * get held up by excessively long scan times.
934 /* These are the ports to scan for SOCKS4 proxies on. They may overlap
935 * with other scan types. Sensible defaults are given below.
937 #socks4_ports = 80, 443, 1080, 8000, 8080, 10800;
939 /* These are the ports to scan for SOCKS5 proxies on. They may overlap
940 * with other scan types. Sensible defaults are given below.
942 #socks5_ports = 80, 443, 1080, 8000, 8080, 10800;
944 /* These are the ports to scan for HTTP CONNECT proxies on (plaintext).
945 * They may overlap with other scan types. Sensible defaults are given
948 #httpconnect_ports = 80, 8080, 8000;
950 /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
951 * They may overlap with other scan types. Sensible defaults are given
954 #httpsconnect_ports = 443, 4443;
958 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
959 * They send PRIVMSG to the given target. A real command takes
960 * precedence above an alias.
963 /* the name must go above */
965 /* target: the target nick (must be a network service) or
966 * user@server (cannot be this server, only opers can use
967 * user starting with "opers" reliably, interpreted on the target
968 * server only so you may need to use nick@server instead)
1001 /* The general block contains many of the options that were once compiled
1002 * in options in config.h. The general block is read at start time.
1005 /* hide error messages: defines whether error messages from
1006 * servers that are not deemed fully safe are hidden or not.
1007 * These can sometimes contain IPs and can have an adverse
1008 * effect on server ip hiding. Set to:
1009 * yes: hide from opers and admin
1010 * opers: hide from opers only
1011 * no: do not hide error messages
1012 * Admins on other servers count as opers.
1014 hide_error_messages = opers;
1016 /* hide spoof ips: hide the real ips of auth{} spoofed users
1017 * If disabled, local opers can see them.
1018 * Dynamic spoofs (e.g. set by services) are unaffected by this;
1019 * any oper (local and remote) can see the real ip.
1021 hide_spoof_ips = yes;
1023 /* default umodes: umodes to set upon connection
1024 * If you have enabled the ip_cloaking extension, and you wish for
1025 * incoming clients to be set +h or +x upon connection, add +h or +x to the umode
1028 default_umodes = "+i";
1030 /* default operstring: defines the default oper response
1031 * in /whois queries, eg "is an IRC Operator".
1032 * After startup use /quote set operstring to change.
1034 default_operstring = "is an IRC Operator";
1036 /* default adminstring: defines the default admin response
1037 * in /whois queries, eg "is a Server Administrator".
1038 * After startup use /quote set adminstring to change.
1040 default_adminstring = "is a Server Administrator";
1042 /* servicestring: defines the response for opered services (+S)
1043 * in /whois queries, eg "is a Network Service".
1044 * This is updated on rehash.
1046 servicestring = "is a Network Service";
1049 * Nick of the network's SASL agent. Used to check whether services are here,
1050 * SASL credentials are only sent to its server. Needs to be a service.
1052 * Defaults to SaslServ if unspecified.
1054 sasl_service = "SaslServ";
1056 /* disable fake channels: disable local users joining fake versions
1057 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
1058 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
1060 disable_fake_channels = no;
1062 /* tkline_expire_notices: give a notice to opers when a tkline
1065 tkline_expire_notices = no;
1067 /* floodcount: the default value of floodcount that is configurable
1068 * via /quote set floodcount. This is the amount of lines a user
1069 * may send to any other user/channel in one second.
1071 default_floodcount = 10;
1073 /* failed oper notice: send a notice to all opers on the server when
1074 * someone tries to OPER and uses the wrong password, host or ident.
1076 failed_oper_notice = yes;
1078 /* dots in ident: the amount of '.' characters permitted in an ident
1079 * reply before the user is rejected.
1083 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
1084 * placed via the server. klines hand placed are exempt from limits.
1085 * wildcard chars: '.' '*' '?' '@'
1087 min_nonwildcard = 4;
1089 /* min nonwildcard simple: the minimum non wildcard characters in
1090 * xlines/resvs placed via the server.
1091 * wildcard chars: '*' '?'
1093 min_nonwildcard_simple = 3;
1095 /* max accept: maximum allowed /accept's for +g usermode */
1098 /* max monitor: the maximum amount of nicknames a client may have in
1099 * their monitor (server-side notify) list.
1103 /* nick flood: enable the nickflood control code */
1104 anti_nick_flood = yes;
1106 /* nick flood: the nick changes allowed in the specified period */
1107 max_nick_time = 20 seconds;
1108 max_nick_changes = 5;
1110 /* anti spam time: the minimum time a user must be connected before
1111 * custom quit messages are allowed.
1113 anti_spam_exit_message_time = 5 minutes;
1115 /* ts delta: the time delta allowed between server clocks before
1116 * a warning is given, or before the link is dropped. all servers
1117 * should run ntpdate/rdate to keep clocks in sync
1119 ts_warn_delta = 30 seconds;
1120 ts_max_delta = 5 minutes;
1122 /* client exit: prepend a user's quit message with "Quit: " */
1125 /* collision fnc: change user's nick to their UID instead of
1126 * killing them, if possible. This setting only applies to nick
1127 * collisions detected on this server. Only enable this if
1128 * all servers on the network allow remote nicks to start with
1131 collision_fnc = yes;
1133 /* resv fnc: change a user's nick to a nick they have recently used
1134 * (or their UID, if no such nick can be found) when a resv matching
1135 * them is set by services. Only enable this if all servers on the
1136 * network allow remote nicks to start with a digit.
1140 /* global snotices: send out certain snotices (most +b, +f, +y,
1141 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1142 * displayed unconditionally.
1144 global_snotices = yes;
1146 /* dline reason: show the user the dline reason when they connect
1149 dline_with_reason = yes;
1151 /* kline reason: show the user the reason why they are k/dlined
1152 * on exit. may give away who set k/dline when set via tcm.
1154 kline_with_reason = yes;
1156 /* tkline duration: when showing users their k/dline reason (see
1157 * kline_with_reason), don't add "Temporary K-line 123 min."
1159 hide_tkdline_duration = no;
1161 /* kline reason: make the users quit message on channels this
1162 * reason instead of the oper's reason.
1164 kline_reason = "Connection closed";
1166 /* identify to services via server password
1167 * if auth{} block had no password but the user specified a
1168 * server password anyway, send a PRIVMSG to <identify_service>
1169 * with as text <identify_command> <password>.
1171 identify_service = "NickServ@services.int";
1172 identify_command = "IDENTIFY";
1174 /* non redundant klines: flag and ignore redundant klines */
1175 non_redundant_klines = yes;
1177 /* warn no nline: warn opers about servers that try to connect but
1178 * we dont have a connect {} block for. Twits with misconfigured
1179 * servers can get really annoying with this enabled.
1181 warn_no_nline = yes;
1183 /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
1184 * That means the bans are part of the netburst and restarted/split
1185 * servers will get them, but they will not apply to 3.2 and older
1188 use_propagated_bans = yes;
1190 /* stats e disabled: disable stats e. useful if server ips are
1191 * exempted and you dont want them listing on irc.
1193 stats_e_disabled = no;
1195 /* stats c oper only: make stats c (connect {}) oper only */
1196 stats_c_oper_only = no;
1198 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
1199 stats_h_oper_only = no;
1201 /* stats y oper only: make stats y (class {}) oper only */
1202 stats_y_oper_only = no;
1204 /* stats o oper only: make stats o (opers) oper only */
1205 stats_o_oper_only = yes;
1207 /* stats P oper only: make stats P (ports) oper only
1208 * NOTE: users doing stats P will never be given the ips that the
1209 * server listens on, simply the ports.
1211 stats_P_oper_only = no;
1213 /* stats i oper only: make stats i (auth {}) oper only. set to:
1214 * yes: show users no auth blocks, made oper only.
1215 * masked: show users first matching auth block
1216 * no: show users all auth blocks.
1218 stats_i_oper_only = masked;
1220 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1221 * yes: show users no auth blocks, made oper only
1222 * masked: show users first matching auth block
1223 * no: show users all auth blocks.
1225 stats_k_oper_only = masked;
1227 /* map oper only: make /map oper only */
1230 /* operspy admin only: make operspy notices to +Z admin only */
1231 operspy_admin_only = no;
1233 /* operspy dont care user info: treat /who mask as if there was
1234 * an '!' always; do not log or server notice about operspy
1235 * /who mask, /masktrace and /scan. channel information is still
1237 operspy_dont_care_user_info = no;
1239 /* caller id wait: time between notifying a +g user that somebody
1240 * is messaging them.
1242 caller_id_wait = 1 minute;
1244 /* pace wait simple: time between use of less intensive commands
1245 * (HELP, remote WHOIS, WHOWAS)
1247 pace_wait_simple = 1 second;
1249 /* pace wait: time between more intensive commands
1250 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1252 pace_wait = 10 seconds;
1254 /* short motd: send clients a notice telling them to read the motd
1255 * instead of forcing a motd to clients who may simply ignore it.
1259 /* ping cookies: require clients to respond exactly to a ping command,
1260 * can help block certain types of drones and FTP PASV mode spoofing.
1264 /* connect timeout: sets how long we should wait for a connection
1265 * request to succeed
1267 connect_timeout = 30 seconds;
1269 /* ident timeout: Amount of time (in seconds) that the IRCd will
1270 * wait for a user to respond to an ident request.
1272 default_ident_timeout = 5;
1274 /* disable auth: disables identd checking */
1277 /* no oper flood: increase flood limits for opers. */
1278 no_oper_flood = yes;
1280 /* REMOVE ME. The following line checks you've been reading. */
1281 havent_read_conf = yes;
1283 /* max targets: the maximum amount of targets in a single
1284 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1288 /* post-registration delay: wait this long before processing commands from a newly
1289 * registered user. Used to allow network utility bots to perform any actions
1290 * (such as host changes or proxy scanning) before the user can join channels.
1292 post_registration_delay = 2 seconds;
1294 /* use_whois_actually: send clients requesting a whois a numeric
1295 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1297 use_whois_actually = yes;
1299 /* usermodes configurable: a list of usermodes for the options below
1301 * +g - callerid - Server-side private message allow list
1302 * +D - deaf - Don't see channel messages
1303 * +i - invisible - Not shown in NAMES or WHO unless you share a
1305 * +l - locops - See LOCOPS messages
1306 * +Q - noforward - Unaffected by channel forwarding
1307 * +R - regonlymsg - No messages from unindentified
1308 * +s - servnotice - See server notices
1309 * +w - wallop - See oper and server generated WALLOPS
1310 * +z - operwall - See operwalls
1313 /* oper only umodes: usermodes only opers may set */
1314 oper_only_umodes = operwall, locops, servnotice;
1316 /* oper umodes: default usermodes opers get when they /oper */
1317 oper_umodes = locops, servnotice, operwall, wallop;
1319 /* oper snomask: default snomask opers get when they /oper,
1320 * provided they have umode +s set */
1321 oper_snomask = "+s";
1323 /* compression level: level of compression for compressed links between
1326 * values are between: 1 (least compression, fastest)
1327 * and: 9 (most compression, slowest).
1329 #compression_level = 6;
1331 /* burst_away: This enables bursting away messages to servers.
1332 * With this disabled, we will only propogate AWAY messages
1333 * as users send them, but never burst them. Be warned though
1334 * enabling this could increase the size of a burst significantly
1335 * for a large network, like EFnet.
1339 /* nick delay: This locks nicks of split clients for the given time
1340 * or until a remote client uses the nick. This significantly
1341 * reduces nick collisions on short splits but it can be annoying.
1342 * To make things as fair as possible, this should be the same on
1343 * all servers. If you enable this, the suggested value is 15 minutes.
1345 nick_delay = 0 seconds;
1347 /* reject time: the amount of rejections through klines/dlines etc
1348 * allowed in the given time before the rejection is cached and
1349 * a pseudo temp dline is placed
1351 reject_ban_time = 1 minute;
1352 reject_after_count = 3;
1354 /* reject duration: the amount of time to cache the rejection */
1355 reject_duration = 5 minutes;
1357 /* throttle_duration: Amount of time that throttling will be applied to an IP
1360 throttle_duration = 60;
1362 /* throttle_count: Number of connections within throttle_duration that it takes
1363 * for throttling to take effect */
1366 /* client flood_max_lines: maximum number of lines in a clients queue before
1367 * they are dropped for flooding.
1369 client_flood_max_lines = 20;
1371 /* Flood control settings. DO NOT CHANGE THESE without extensive discussion
1372 * and testing by someone who knows exactly what they do.
1374 * These settings replicate charybdis-3.3 behaviour.
1376 client_flood_burst_rate = 40;
1377 client_flood_burst_max = 5;
1378 client_flood_message_time = 1;
1379 client_flood_message_num = 2;
1381 /* max_ratelimit_tokens: the maximum number of ratelimit tokens that one
1382 * user can accumulate. This attempts to limit the amount of outbound
1383 * bandwidth one user can consume. Do not change unless you know what
1386 max_ratelimit_tokens = 30;
1388 /* away_interval: the minimum interval between AWAY commands. One
1389 * additional AWAY command is allowed, and only marking as away
1394 /* certfp_method: the method that should be used for computing certificate fingerprints.
1395 * Acceptable options are sha1, sha256, spki_sha256, sha512 and spki_sha512. Networks
1396 * running versions of charybdis prior to charybdis 3.5 MUST use sha1 for certfp_method.
1398 * The spki_* variants operate on the SubjectPublicKeyInfo of the certificate, which does
1399 * not change unless the private key is changed. This allows the fingerprint to stay
1400 * constant even if the certificate is reissued. These fingerprints will be prefixed with
1401 * "SPKI:SHA2-256:" or "SPKI:SHA2-512:" depending on the hash type. These fingerprints
1402 * are not supported on servers running charybdis 3.5.3 or earlier.
1404 * To generate a fingerprint from a certificate file, please use the mkfingerprint utility
1405 * program located in the bin/ subdirectory of your IRCd installation. Running it with no
1406 * arguments will give you a brief usage message; it takes method and filename arguments.
1408 certfp_method = spki_sha256;
1410 /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
1411 hide_opers_in_whois = no;
1413 /* tls_ciphers_oper_only: show the TLS cipher string in /WHOIS only to opers and self */
1414 tls_ciphers_oper_only = no;
1416 /* hidden_caps: client capabilities we'll pretend we don't support until they're requested */
1417 #hidden_caps = "userhost-in-names";
1421 /* module path: paths to search for modules specified below and
1424 path = "/usr/local/ircd/modules";
1425 path = "/usr/local/ircd/modules/autoload";
1427 /* module: the name of a module to load on startup/rehash */
1428 #module = "some_module";