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 * Channel mode +-M (disallow KICK on IRC ops) -- chm_operpeace
51 * Restrict channel creation to logged in users -- createauthonly
52 * Account bans (+b $a[:mask]) -- extb_account
53 * Banned from another channel (+b $j:mask) -- extb_canjoin
54 * Other-channel bans (+b $c:mask) -- extb_channel
55 * Combination extbans -- extb_combi
56 * Extended ban (+b $x:mask) -- extb_extgecos
57 * Hostmask bans (for combination extbans) -- extb_hostmask
58 * Oper bans (+b $o) -- extb_oper
59 * Realname (gecos) bans (+b $r:mask) -- extb_realname
60 * Server bans (+b $s:mask) -- extb_server
61 * SSL bans (+b $z) -- extb_ssl
62 * User mode bans (+b $u:modes) -- extb_usermode
63 * Helpops system (umode +h) -- helpops
65 * New host mangling (umode +x) -- ip_cloaking_4.0
66 * Old host mangling (umode +h) -- ip_cloaking
67 * Dynamically extend channel limits -- m_extendchans
68 * Find channel forwards -- m_findforwards
69 * /identify support -- m_identify
70 * /locops support -- m_locops
71 * Opers cannot be invisible (umode +i) -- no_oper_invis
72 * Far connection notices (snomask +F) -- sno_farconnect
73 * Remote k/d/x line active notices -- sno_globalkline
74 * Remote oper up notices -- sno_globaloper
75 * Global nick-change notices -- sno_globalnickchange
76 * /whois notifications (snomask +W) -- sno_whois
77 * Oper-override (modehacking only) -- override
78 * Stop services kills -- no_kill_services
80 #loadmodule "extensions/chm_adminonly";
81 #loadmodule "extensions/chm_nonotice";
82 #loadmodule "extensions/chm_operonly";
83 #loadmodule "extensions/chm_sslonly";
84 #loadmodule "extensions/chm_operpeace";
85 #loadmodule "extensions/createauthonly";
86 #loadmodule "extensions/extb_account";
87 #loadmodule "extensions/extb_canjoin";
88 #loadmodule "extensions/extb_channel";
89 #loadmodule "extensions/extb_combi";
90 #loadmodule "extensions/extb_extgecos";
91 #loadmodule "extensions/extb_hostmask";
92 #loadmodule "extensions/extb_oper";
93 #loadmodule "extensions/extb_realname";
94 #loadmodule "extensions/extb_server";
95 #loadmodule "extensions/extb_ssl";
96 #loadmodule "extensions/extb_usermode";
97 #loadmodule "extensions/helpops";
98 #loadmodule "extensions/hurt";
99 #loadmodule "extensions/ip_cloaking_4.0";
100 #loadmodule "extensions/ip_cloaking";
101 #loadmodule "extensions/m_extendchans";
102 #loadmodule "extensions/m_findforwards";
103 #loadmodule "extensions/m_identify";
104 #loadmodule "extensions/m_locops";
105 #loadmodule "extensions/no_oper_invis";
106 #loadmodule "extensions/sno_farconnect";
107 #loadmodule "extensions/sno_globalkline";
108 #loadmodule "extensions/sno_globalnickchange";
109 #loadmodule "extensions/sno_globaloper";
110 #loadmodule "extensions/sno_whois";
111 #loadmodule "extensions/override";
112 #loadmodule "extensions/no_kill_services";
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 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
138 * This should be an ipv4 IP only.
140 #vhost = "192.0.2.6";
142 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
143 * This should be an ipv6 IP only.
145 #vhost6 = "2001:db8:2::6";
147 /* ssl_cert: certificate (and optionally key) for our ssl server */
148 ssl_cert = "etc/ssl.pem";
150 /* ssl_private_key: our ssl private key (if not contained in ssl_cert file) */
151 #ssl_private_key = "etc/ssl.key";
153 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 2048 */
154 /* If you do not provide parameters, some TLS backends will fail on DHE- ciphers,
155 and some will succeed but use weak, common DH groups! */
156 ssl_dh_params = "etc/dh.pem";
158 /* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
159 #ssl_cipher_list = "EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
161 /* ssld_count: number of ssld processes you want to start, if you
162 * have a really busy server, using N-1 where N is the number of
163 * cpu/cpu cores you have might be useful. A number greater than one
164 * can also be useful in case of bugs in ssld and because ssld needs
165 * two file descriptors per SSL connection.
169 /* default max clients: the default maximum number of clients
170 * allowed to connect. This can be changed once ircd has started by
172 * /quote set maxclients <limit>
174 default_max_clients = 1024;
176 /* nicklen: enforced nickname length (for this server only; must not
177 * be longer than the maximum length set while building).
182 /* admin {}: contains admin information about the server. (OLD A:) */
184 name = "Smurf target";
185 description = "Main Server Administrator";
186 email = "<syn@packets.r.us>";
189 /* log {}: contains information about logfiles. */
191 /* logfiles: the logfiles to use for specific activity. if these
192 * paths are defined, then ircd will log to them, otherwise it wont.
194 * The confs are, in order:
195 * - userlog: user exits
196 * - fuserlog: failed user connections
197 * - operlog: /oper usage
198 * - foperlog: failed /oper usage
199 * - serverlog: server connects/disconnects
200 * - klinelog: klines, etc
202 * - operspylog: operspy usage
203 * - ioerrorlog: IO errors
205 fname_userlog = "logs/userlog";
206 #fname_fuserlog = "logs/fuserlog";
207 fname_operlog = "logs/operlog";
208 #fname_foperlog = "logs/foperlog";
209 fname_serverlog = "logs/serverlog";
210 #fname_klinelog = "logs/klinelog";
211 fname_killlog = "logs/killlog";
212 fname_operspylog = "logs/operspylog";
213 #fname_ioerrorlog = "logs/ioerror";
216 /* class {}: contain information about classes for users (OLD Y:) */
218 /* class name must go above */
220 /* ping time: how often a client must reply to a PING from the
221 * server before they are dropped.
223 ping_time = 2 minutes;
225 /* number per ident: the number of users per user@host networkwide
226 * allowed to connect. Unidented connections are classified as
229 number_per_ident = 2;
231 /* number per ip: the number of local users per host allowed */
234 /* number per ip global: the number of network wide connections
235 * per host allowed for a user, including connections to the
238 number_per_ip_global = 5;
240 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
242 cidr_ipv4_bitlen = 24;
244 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
245 * the following example makes the subnet /64 this is useful
246 * for IPv6 connections in particular
248 cidr_ipv6_bitlen = 64;
250 /* number_per_cidr: Number of connections to allow from a subnet of the
251 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
252 * 4 seems to be a good default to me.
256 /* max number: the maximum number of users allowed in this class */
259 /* sendq: the amount of data allowed in a clients queue before
266 ping_time = 1 minute 30 seconds;
273 ping_time = 5 minutes;
280 ping_time = 5 minutes;
282 /* connectfreq: only used in server classes. specifies the delay
283 * between autoconnecting to servers.
285 connectfreq = 5 minutes;
287 /* max_autoconn: the amount of servers to autoconnect to. if the number
288 * of servers in the class is or exceeds this, no more servers in the
289 * class are autoconnected. oper initiated connects are unaffected.
290 * this should usually be set to either 0 or 1. (autoconnecting from
291 * hubs to leaves may cause leaves to function as hubs by having
292 * multiple servers connected to them.)
296 /* max_number: the maximum number of servers allowed in this class */
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 6697 */
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";
338 /* wsock: listeners defined with this option enabled will be websocket listeners,
339 * and will not accept normal clients.
345 /* auth {}: allow users to connect to the ircd (OLD I:) */
347 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
348 * lines are permitted per auth block. This is matched against the
349 * hostname and IP address (using :: shortening for IPv6 and
350 * prepending a 0 if it starts with a colon) and can also use CIDR
353 user = "*@198.51.100.0/24";
354 user = "*test@2001:db8:1:*";
356 /* auth_user: This allows specifying a username:password instead of
357 * just a password in PASS, so that a fixed user@host is not
358 * necessary for a specific auth{} block.
360 #auth_user = "SomeUser";
362 /* password: an optional password that is required to use this block.
363 * By default this is not encrypted, specify the flag "encrypted" in
364 * flags = ...; below if it is.
366 password = "letmein";
368 /* spoof: fake the users user@host to be be this. You may either
369 * specify a host or a user@host to spoof to. This is free-form,
370 * just do everyone a favour and dont abuse it. (OLD I: = flag)
372 spoof = "I.still.hate.packets";
374 /* Possible flags in auth:
376 * encrypted | password is encrypted with mkpasswd
377 * spoof_notice | give a notice when spoofing hosts
378 * exceed_limit (old > flag) | allow user to exceed class user limits
379 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines,
380 * | dnsbls, and proxies
381 * dnsbl_exempt | exempt this user from dnsbls
382 * proxy_exempt | exempt this user from proxies
383 * spambot_exempt | exempt this user from spambot checks
384 * shide_exempt | exempt this user from serverhiding
385 * jupe_exempt | exempt this user from generating
386 * warnings joining juped channels
387 * resv_exempt | exempt this user from resvs
388 * flood_exempt | exempt this user from flood limits
390 * no_tilde (old - flag) | don't prefix ~ to username if no ident
391 * need_ident (old + flag) | require ident for user in this class
392 * need_ssl | require SSL/TLS for user in this class
393 * need_sasl | require SASL id for user in this class
394 * extend_chans | allow this user to join more channels than normal
395 * kline_spoof_ip | if this block has a spoof host, klines match only
396 * | the spoof and not the underlying IP
398 flags = kline_exempt, exceed_limit;
400 /* class: the class the user is placed in */
405 /* redirect: the server and port to redirect a user to. A user does
406 * not have to obey the redirection, the ircd just suggests to them
407 * an alternative server.
409 redirserv = "irc.example.net";
412 user = "*.example.com";
414 /* class: a class is required even though it is not used */
423 /* privset{}: defines operator privilege sets. */
425 /* privs: controls the activities and commands an oper is
426 * allowed to do on the server
430 * oper:general: enable most general oper privileges that came
431 * with +o in older releases
432 * auspex:oper: allows the oper to see through oper hiding
433 * auspex:umodes: allows viewing other users' modes
434 * auspex:cmodes: shows privileged cmodes
435 * auspex:hostname: shows hidden hostnames/ips
436 * oper:privs: allows /stats o/O and seeing privset in /whois
437 * oper:testline: allows /testline and /testgecos
438 * oper:kill: allows local and remote users to be /KILL'd
439 * oper:routing: allows remote SQUIT and CONNECT
440 * oper:kline: allows KLINE and DLINE
441 * oper:unkline: allows UNKLINE and UNDLINE
442 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
443 * oper:rehash: allows oper to REHASH config
444 * oper:die: allows DIE and RESTART
445 * oper:admin: gives admin privileges. admins
446 * may (un)load modules and see various
447 * additional information.
448 * oper:hidden_admin: gives admin privileges except
449 * will not have the admin lines in
451 * oper:xline: allows use of /quote xline/unxline
452 * oper:resv: allows /quote resv/unresv
453 * oper:cmodes: allows cmode +LP
454 * oper:operwall: allows the oper to send/receive operwalls
455 * oper:spy: allows 'operspy' features to see through +s
456 * channels etc. see /quote help operspy
457 * oper:hidden: hides the oper from /stats p
458 * oper:remoteban: allows remote kline etc
459 * oper:mass_notice: allows sending wallops and mass notices
460 * oper:grant: allows using the GRANT command
461 * usermode:servnotice: allows setting +s
463 * Privileges provided by extensions include:
465 * oper:dehelper: allows the DEHELPER command (from extensions/helpops)
466 * oper:override: enables oper override via umode +p (from extensions/override)
467 * oper:receive_immunity:
468 * confers the benefits of chmode +M (operpeace) (from extensions/chm_operpeace)
469 * usermode:helpops allows setting +h (from extensions/helpops)
471 privs = oper:general, oper:privs, oper:testline, oper:kill, oper:operwall, usermode:servnotice,
472 auspex:oper, auspex:hostname, auspex:umodes, auspex:cmodes;
475 privset "server_bot" {
476 /* extends: a privset to inherit in this privset */
477 extends = "local_op";
478 privs = oper:kline, oper:remoteban, snomask:nick_changes;
481 privset "global_op" {
482 extends = "local_op";
483 privs = oper:routing, oper:kline, oper:unkline, oper:xline,
484 oper:resv, oper:cmodes, oper:mass_notice, oper:remoteban;
488 extends = "global_op";
489 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
492 /* operator {}: defines ircd operators. (OLD O:) */
494 /* name: the name of the oper must go above */
496 /* user: the user@host required for this operator. CIDR *is*
497 * supported now. auth{} spoofs work here, other spoofs do not.
498 * multiple user="" lines are supported.
501 user = "*@127.0.0.1";
503 /* password: the password required to oper. Unless ~encrypted is
504 * contained in flags = ...; this will need to be encrypted using
505 * mkpasswd, MD5 is supported
507 password = "etcnjl8juSU1E";
509 /* rsa key: the public key for this oper when using Challenge.
510 * A password should not be defined when this is used, see
511 * doc/challenge.txt for more information.
513 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
515 /* fingerprint: if specified, the oper's client certificate
516 * fingerprint will be checked against the specified fingerprint
519 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
521 /* umodes: the specific umodes this oper gets when they oper.
522 * If this is specified an oper will not be given oper_umodes
523 * These are described above oper_only_umodes in general {};
525 #umodes = locops, servnotice, operwall, wallop;
527 /* snomask: specific server notice mask on oper up.
528 * If this is specified an oper will not be given oper_snomask.
530 snomask = "+Zbfkrsuy";
532 /* flags: misc options for the operator. You may prefix an option
533 * with ~ to disable it, e.g. ~encrypted.
535 * Default flags are encrypted.
539 * encrypted: the password above is encrypted [DEFAULT]
540 * need_ssl: must be using SSL/TLS to oper up
544 /* privset: privileges set to grant */
548 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
549 connect "irc.uplink.com" {
550 /* the name must go above */
552 /* host: the host or IP to connect to. If a hostname is used it
553 * must match the reverse dns of the server.
555 host = "203.0.113.3";
557 /* vhost: the host or IP to bind to for this connection. If this
558 * is not specified, the default vhost (in serverinfo {}) is used.
560 #vhost = "192.0.2.131";
562 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
563 * The remote server will have these passwords reversed.
565 send_password = "password";
566 accept_password = "anotherpassword";
568 /* fingerprint: if flags = ssl is specified, the server's
569 * certificate fingerprint will be checked against the fingerprint
570 * specified below. required if using flags = ssl.
572 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
574 /* port: the port to connect to this server on */
577 /* class: the class this server is in */
580 /* flags: controls special options for this server
581 * encrypted - marks the accept_password as being crypt()'d
582 * autoconn - automatically connect to this server
583 * compressed - compress traffic via ziplinks
584 * topicburst - burst topics between servers
585 * ssl - ssl/tls encrypted server connections
586 * no-export - marks the link as a no-export link (not exported to other links)
588 flags = compressed, topicburst;
591 connect "ipv6.lame.server" {
593 host = "2001:db8:3::8";
594 send_password = "password";
595 accept_password = "password";
598 /* aftype: controls whether the outgoing connection uses "ipv4" or "ipv6".
599 * Default is to try either at random.
605 connect "ssl.uplink.com" {
606 /* Example of ssl server-to-server connection, ssl flag doesn't need
607 * compressed flag, 'cause it uses own compression
609 host = "203.0.113.129";
610 send_password = "password";
611 accept_password = "anotherpassword";
614 flags = ssl, topicburst;
617 /* cluster {}; servers that we propagate things to automatically. */
619 /* name: the server to share with, this can be a wildcard and may be
622 /* flags: list of what to share, all the name lines above this (up
623 * until another flags entry) will receive these flags.
625 * kline - share perm klines
626 * tkline - share temp klines
627 * unkline - share unklines
628 * locops - share locops
629 * xline - share perm xlines
630 * txline - share temp xlines
631 * unxline - share unxlines
632 * resv - share perm resvs
633 * tresv - share temp resvs
634 * unresv - share unresvs
635 * all - share all of the above
638 /* share klines/unklines/xlines with *.lan */
640 flags = kline, unkline, xline;
642 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
643 name = "irc.ircd-ratbox.org";
644 name = "ircd.ircd-ratbox.org";
648 /* service{}: privileged servers (services). These servers have extra
649 * privileges such as setting login names on users and introducing clients
650 * with umode +S (unkickable, hide channels, etc).
651 * Do not place normal servers here.
652 * There may be only one service{} block.
655 /* name: the server name. These may be stacked. */
656 name = "services.int";
659 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
663 /* these may be stacked */
667 /* secure {}: IPs that are considered to be secure networks, and get
668 * +Z without using TLS */
673 /* The channel block contains options pertaining to channels */
675 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
676 * that can join a +i channel without an invite.
680 /* except: Enable/disable channel mode +e, a n!u@h list of masks
681 * that can join a channel through a ban (+b).
685 /* forward: Enable/disable channel mode +f, a channel to forward
686 * users to if they can't join because of +i etc. Also enables ban
687 * forwarding, <mask>$<channel>.
691 /* knock: Allows users to request an invite to a channel that
692 * is locked somehow (+ikl). If the channel is +p or you are banned
693 * the knock will not be sent.
697 /* knock delay: The amount of time a user must wait between issuing
700 knock_delay = 5 minutes;
702 /* knock channel delay: How often a knock to any specific channel
703 * is permitted, regardless of the user sending the knock.
705 knock_delay_channel = 1 minute;
707 /* max chans: The maximum number of channels a user can join/be on. */
708 max_chans_per_user = 15;
710 /* max chans (large): The extended maximum number of channels a user can join. */
711 max_chans_per_user_large = 60;
713 /* max bans: maximum number of +b/e/I/q modes in a channel */
716 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
717 max_bans_large = 500;
719 /* splitcode: split users, split servers and either no join on split
720 * or no create on split must be enabled for split checking.
721 * splitmode will be entered on either split users or split servers
722 * dropping below the limit.
724 * you may force splitmode to be permanent by /quote set splitmode on
727 /* split users: when the usercount is lower than this level, consider
728 * ourselves split. this must be set for automatic splitmode
730 default_split_user_count = 0;
732 /* split servers: when the amount of servers that have acknowledged
733 * theyve finished bursting is lower than this, consider ourselves
734 * split. this must be set for automatic splitmode
736 default_split_server_count = 0;
738 /* split: no create: disallow users creating channels on split */
739 no_create_on_split = no;
741 /* split: no join: disallow users joining channels at all on a split */
742 no_join_on_split = no;
744 /* burst topicwho: when bursting topics, also burst the topic setter */
745 burst_topicwho = yes;
747 /* kick on split riding: kick users riding splits to join +i or +k
748 * channels. more precisely, if a bursting server sends an SJOIN
749 * for a channel with a lower TS with either a +i mode or a +k
750 * mode with a different key, kick all local users.
752 * note: this does not take +r, +b, +e and +I into account.
754 kick_on_split_riding = no;
756 /* only ascii channels: disable local users joining channels
757 * containing characters outside the range 33-126 (non-printable
760 only_ascii_channels = no;
762 /* resv_forcepart: force any local users to part a channel
763 * when a RESV is issued.
765 resv_forcepart = yes;
767 /* channel target change: restrict how many channels users can
768 * message per unit of time. IRC operators, channel operators and
769 * voiced users are exempt.
771 channel_target_change = yes;
773 /* disable local channels: if yes, then local channels will not be
776 disable_local_channels = no;
778 /* autochanmodes: the channel modes that should be automatically set
779 * when a channel is created.
781 autochanmodes = "+nt";
783 /* displayed_usercount: the minimum amount of users on a channel before it
784 * is displayed in LIST. this parameter can be overridden using ELIST parameters,
787 displayed_usercount = 3;
789 /* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */
790 strip_topic_colors = no;
792 /* opmod_send_statusmsg: format messages sent to ops due to +z
793 * as PRIVMSG @#channel when sent to clients.
795 opmod_send_statusmsg = no;
799 /* The serverhide block contains the options regarding serverhiding */
801 /* flatten links: this option will hide various routing information
802 * and make all servers in /links appear that they are linked to
807 /* links delay: how long to wait before showing splits or new
808 * servers in a flattened /links output.
810 links_delay = 5 minutes;
812 /* hidden: hide this server from a /links output on servers with
813 * flatten_links enabled. this allows hub servers to be hidden etc.
817 /* disable hidden: prevent servers hiding themselves from a
823 /* These are the blacklist settings.
824 * You can have multiple combinations of host and rejection reasons.
825 * They are used in pairs of one host/rejection reason.
827 * These settings should be adequate for most networks.
829 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
832 * As of charybdis 2.2, you can do some keyword substitution on the rejection
833 * reason. The available keyword substitutions are:
835 * ${ip} - the user's IP
836 * ${host} - the user's canonical hostname
837 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
838 * ${nick} - the user's nickname
839 * ${network-name} - the name of the network
841 * As of charybdis 3.4, a type parameter is supported, which specifies the
842 * address families the blacklist supports. IPv4 and IPv6 are supported.
843 * IPv4 is currently the default as few blacklists support IPv6 operation
844 * as of this writing.
846 * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
847 * is considered a match. If included, a comma-separated list of *quoted*
848 * strings is allowed to match queries. They may be of the format "0" to "255"
849 * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
850 * an A record. The blacklist is only applied if it matches anything in the
851 * list. You may freely mix full IP's and final octets.
853 * Consult your blacklist provider for the meaning of these parameters; they
854 * are usually used to denote different ban types.
857 host = "rbl.efnetrbl.org";
859 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
861 /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
862 # host = "foobl.blacklist.invalid";
863 # matches = "4", "6", "127.0.0.10";
865 # reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for some reason. In order to protect ${network-name} from abuse, we are not allowing connections listed in ${dnsbl-host} to connect";
868 /* These are the OPM settings.
869 * This is similar to the functionality provided by BOPM. It will scan incoming
870 * connections for open proxies by connecting to clients and attempting several
871 * different open proxy handshakes. If they connect back to us (via a dedicated
872 * listening port), and send back the data we send them, they are considered
873 * an open proxy. For politeness reasons (users may be confused by the incoming
874 * connection attempts if they are logging incoming connections), the user is
875 * notified upon connect if they are being scanned.
878 * These settings are considered experimental. Only the most common proxy types
879 * are checked for (Charybdis is immune from POST and GET proxies). If you are
880 * not comfortable with experimental code, do not use this feature.
883 /* IPv4 address to listen on. This must be a publicly facing IP address
885 * If omitted, it defaults to serverinfo::vhost.
887 #listen_ipv4 = "127.0.0.1";
889 /* IPv4 port to listen on.
890 * This should not be the same as any existing listeners.
894 /* IPv6 address to listen on. This must be a publicly facing IP address
896 * If omitted, it defaults to serverinfo::vhost6.
898 #listen_ipv6 = "::1";
900 /* IPv6 port to listen on.
901 * This should not be the same as any existing listeners.
905 /* You can also set the listen_port directive which will set both the
906 * IPv4 and IPv6 ports at once.
908 #listen_port = 32000;
910 /* This sets the timeout in seconds before ending open proxy scans.
911 * Values less than 1 or greater than 60 are ignored.
912 * It is advisable to keep it as short as feasible, so clients do not
913 * get held up by excessively long scan times.
917 /* These are the ports to scan for SOCKS4 proxies on. They may overlap
918 * with other scan types. Sensible defaults are given below.
920 #socks4_ports = 80, 443, 1080, 8000, 8080, 10800;
922 /* These are the ports to scan for SOCKS5 proxies on. They may overlap
923 * with other scan types. Sensible defaults are given below.
925 #socks5_ports = 80, 443, 1080, 8000, 8080, 10800;
927 /* These are the ports to scan for HTTP CONNECT proxies on (plaintext).
928 * They may overlap with other scan types. Sensible defaults are given
931 #httpconnect_ports = 80, 8080, 8000;
933 /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
934 * They may overlap with other scan types. Sensible defaults are given
937 #httpsconnect_ports = 443, 4443;
941 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
942 * They send PRIVMSG to the given target. A real command takes
943 * precedence above an alias.
946 /* the name must go above */
948 /* target: the target nick (must be a network service) or
949 * user@server (cannot be this server, only opers can use
950 * user starting with "opers" reliably, interpreted on the target
951 * server only so you may need to use nick@server instead)
984 /* The general block contains many of the options that were once compiled
985 * in options in config.h. The general block is read at start time.
988 /* hide error messages: defines whether error messages from
989 * servers that are not deemed fully safe are hidden or not.
990 * These can sometimes contain IPs and can have an adverse
991 * effect on server ip hiding. Set to:
992 * yes: hide from opers and admin
993 * opers: hide from opers only
994 * no: do not hide error messages
995 * Admins on other servers count as opers.
997 hide_error_messages = opers;
999 /* hide spoof ips: hide the real ips of auth{} spoofed users
1000 * If disabled, local opers can see them.
1001 * Dynamic spoofs (e.g. set by services) are unaffected by this;
1002 * any oper (local and remote) can see the real ip.
1004 hide_spoof_ips = yes;
1006 /* default umodes: umodes to set upon connection
1007 * If you have enabled the ip_cloaking extension, and you wish for
1008 * incoming clients to be set +h or +x upon connection, add +h or +x to the umode
1011 default_umodes = "+i";
1013 /* default operstring: defines the default oper response
1014 * in /whois queries, eg "is an IRC Operator".
1015 * After startup use /quote set operstring to change.
1017 default_operstring = "is an IRC Operator";
1019 /* default adminstring: defines the default admin response
1020 * in /whois queries, eg "is a Server Administrator".
1021 * After startup use /quote set adminstring to change.
1023 default_adminstring = "is a Server Administrator";
1025 /* servicestring: defines the response for opered services (+S)
1026 * in /whois queries, eg "is a Network Service".
1027 * This is updated on rehash.
1029 servicestring = "is a Network Service";
1032 * Nick of the network's SASL agent. Used to check whether services are here,
1033 * SASL credentials are only sent to its server. Needs to be a service.
1035 * Defaults to SaslServ if unspecified.
1037 sasl_service = "SaslServ";
1039 /* disable fake channels: disable local users joining fake versions
1040 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
1041 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
1043 disable_fake_channels = no;
1045 /* tkline_expire_notices: give a notice to opers when a tkline
1048 tkline_expire_notices = no;
1050 /* floodcount: the default value of floodcount that is configurable
1051 * via /quote set floodcount. This is the amount of lines a user
1052 * may send to any other user/channel in one second.
1054 default_floodcount = 10;
1056 /* failed oper notice: send a notice to all opers on the server when
1057 * someone tries to OPER and uses the wrong password, host or ident.
1059 failed_oper_notice = yes;
1061 /* dots in ident: the amount of '.' characters permitted in an ident
1062 * reply before the user is rejected.
1066 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
1067 * placed via the server. klines hand placed are exempt from limits.
1068 * wildcard chars: '.' '*' '?' '@'
1070 min_nonwildcard = 4;
1072 /* min nonwildcard simple: the minimum non wildcard characters in
1073 * xlines/resvs placed via the server.
1074 * wildcard chars: '*' '?'
1076 min_nonwildcard_simple = 3;
1078 /* max accept: maximum allowed /accept's for +g usermode */
1081 /* max monitor: the maximum amount of nicknames a client may have in
1082 * their monitor (server-side notify) list.
1086 /* nick flood: enable the nickflood control code */
1087 anti_nick_flood = yes;
1089 /* nick flood: the nick changes allowed in the specified period */
1090 max_nick_time = 20 seconds;
1091 max_nick_changes = 5;
1093 /* anti spam time: the minimum time a user must be connected before
1094 * custom quit messages are allowed.
1096 anti_spam_exit_message_time = 5 minutes;
1098 /* ts delta: the time delta allowed between server clocks before
1099 * a warning is given, or before the link is dropped. all servers
1100 * should run ntpdate/rdate to keep clocks in sync
1102 ts_warn_delta = 30 seconds;
1103 ts_max_delta = 5 minutes;
1105 /* client exit: prepend a user's quit message with "Quit: " */
1108 /* collision fnc: change user's nick to their UID instead of
1109 * killing them, if possible. This setting only applies to nick
1110 * collisions detected on this server. Only enable this if
1111 * all servers on the network allow remote nicks to start with
1114 collision_fnc = yes;
1116 /* resv fnc: change a user's nick to a nick they have recently used
1117 * (or their UID, if no such nick can be found) when a resv matching
1118 * them is set by services. Only enable this if all servers on the
1119 * network allow remote nicks to start with a digit.
1123 /* global snotices: send out certain snotices (most +b, +f, +y,
1124 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1125 * displayed unconditionally.
1127 global_snotices = yes;
1129 /* dline reason: show the user the dline reason when they connect
1132 dline_with_reason = yes;
1134 /* kline reason: show the user the reason why they are k/dlined
1135 * on exit. may give away who set k/dline when set via tcm.
1137 kline_with_reason = yes;
1139 /* tkline duration: when showing users their k/dline reason (see
1140 * kline_with_reason), don't add "Temporary K-line 123 min."
1142 hide_tkdline_duration = no;
1144 /* kline reason: make the users quit message on channels this
1145 * reason instead of the oper's reason.
1147 kline_reason = "Connection closed";
1149 /* identify to services via server password
1150 * if auth{} block had no password but the user specified a
1151 * server password anyway, send a PRIVMSG to <identify_service>
1152 * with as text <identify_command> <password>.
1154 identify_service = "NickServ@services.int";
1155 identify_command = "IDENTIFY";
1157 /* non redundant klines: flag and ignore redundant klines */
1158 non_redundant_klines = yes;
1160 /* warn no nline: warn opers about servers that try to connect but
1161 * we dont have a connect {} block for. Twits with misconfigured
1162 * servers can get really annoying with this enabled.
1164 warn_no_nline = yes;
1166 /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
1167 * That means the bans are part of the netburst and restarted/split
1168 * servers will get them, but they will not apply to 3.2 and older
1171 use_propagated_bans = yes;
1173 /* stats e disabled: disable stats e. useful if server ips are
1174 * exempted and you dont want them listing on irc.
1176 stats_e_disabled = no;
1178 /* stats c oper only: make stats c (connect {}) oper only */
1179 stats_c_oper_only = no;
1181 /* stats y oper only: make stats y (class {}) oper only */
1182 stats_y_oper_only = no;
1184 /* stats o oper only: make stats o (opers) oper only */
1185 stats_o_oper_only = yes;
1187 /* stats P oper only: make stats P (ports) oper only
1188 * NOTE: users doing stats P will never be given the ips that the
1189 * server listens on, simply the ports.
1191 stats_P_oper_only = no;
1193 /* stats i oper only: make stats i (auth {}) oper only. set to:
1194 * yes: show users no auth blocks, made oper only.
1195 * masked: show users first matching auth block
1196 * no: show users all auth blocks.
1198 stats_i_oper_only = masked;
1200 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1201 * yes: show users no auth blocks, made oper only
1202 * masked: show users first matching auth block
1203 * no: show users all auth blocks.
1205 stats_k_oper_only = masked;
1207 /* stats l/L oper only:
1208 * yes: non-opers can't use this at all
1209 * self: non-opers see only themselves
1210 * no: show targeted users or non-hidden opers to everyone
1212 stats_l_oper_only = self;
1214 /* map oper only: make /map oper only */
1217 /* operspy admin only: make operspy notices to +Z admin only */
1218 operspy_admin_only = no;
1220 /* operspy dont care user info: treat /who mask as if there was
1221 * an '!' always; do not log or server notice about operspy
1222 * /who mask, /masktrace and /scan. channel information is still
1224 operspy_dont_care_user_info = no;
1226 /* caller id wait: time between notifying a +g user that somebody
1227 * is messaging them.
1229 caller_id_wait = 1 minute;
1231 /* pace wait simple: time between use of less intensive commands
1232 * (HELP, remote WHOIS, WHOWAS)
1234 pace_wait_simple = 1 second;
1236 /* pace wait: time between more intensive commands
1237 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1239 pace_wait = 10 seconds;
1241 /* short motd: send clients a notice telling them to read the motd
1242 * instead of forcing a motd to clients who may simply ignore it.
1246 /* ping cookies: require clients to respond exactly to a ping command,
1247 * can help block certain types of drones and FTP PASV mode spoofing.
1251 /* connect timeout: sets how long we should wait for a connection
1252 * request to succeed
1254 connect_timeout = 30 seconds;
1256 /* ident timeout: Amount of time (in seconds) that the IRCd will
1257 * wait for a user to respond to an ident request.
1259 default_ident_timeout = 5;
1261 /* disable auth: disables identd checking */
1264 /* no oper flood: increase flood limits for opers. */
1265 no_oper_flood = yes;
1267 /* REMOVE ME. The following line checks you've been reading. */
1268 havent_read_conf = yes;
1270 /* max targets: the maximum amount of targets in a single
1271 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1275 /* post-registration delay: wait this long before processing commands from a newly
1276 * registered user. Used to allow network utility bots to perform any actions
1277 * (such as host changes or proxy scanning) before the user can join channels.
1279 post_registration_delay = 2 seconds;
1281 /* use_whois_actually: send clients requesting a whois a numeric
1282 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1284 use_whois_actually = yes;
1286 /* usermodes configurable: a list of usermodes for the options below
1288 * +g - callerid - Server-side private message allow list
1289 * +D - deaf - Don't see channel messages
1290 * +i - invisible - Not shown in NAMES or WHO unless you share a
1292 * +l - locops - See LOCOPS messages
1293 * +Q - noforward - Unaffected by channel forwarding
1294 * +R - regonlymsg - No messages from unindentified
1295 * +s - servnotice - See server notices
1296 * +w - wallop - See oper and server generated WALLOPS
1297 * +z - operwall - See operwalls
1300 /* oper only umodes: usermodes only opers may set */
1301 oper_only_umodes = operwall, locops, servnotice;
1303 /* oper umodes: default usermodes opers get when they /oper */
1304 oper_umodes = locops, servnotice, operwall, wallop;
1306 /* oper snomask: default snomask opers get when they /oper,
1307 * provided they have umode +s set */
1308 oper_snomask = "+s";
1310 /* compression level: level of compression for compressed links between
1313 * values are between: 1 (least compression, fastest)
1314 * and: 9 (most compression, slowest).
1316 #compression_level = 6;
1318 /* burst_away: This enables bursting away messages to servers.
1319 * With this disabled, we will only propogate AWAY messages
1320 * as users send them, but never burst them. Be warned though
1321 * enabling this could increase the size of a burst significantly
1322 * for a large network, like EFnet.
1326 /* nick delay: This locks nicks of split clients for the given time
1327 * or until a remote client uses the nick. This significantly
1328 * reduces nick collisions on short splits but it can be annoying.
1329 * To make things as fair as possible, this should be the same on
1330 * all servers. If you enable this, the suggested value is 15 minutes.
1332 nick_delay = 0 seconds;
1334 /* reject time: the amount of rejections through klines/dlines etc
1335 * allowed in the given time before the rejection is cached and
1336 * a pseudo temp dline is placed
1338 reject_ban_time = 1 minute;
1339 reject_after_count = 3;
1341 /* reject duration: the amount of time to cache the rejection */
1342 reject_duration = 5 minutes;
1344 /* throttle_duration: Amount of time that throttling will be applied to an IP
1347 throttle_duration = 60;
1349 /* throttle_count: Number of connections within throttle_duration that it takes
1350 * for throttling to take effect */
1353 /* client flood_max_lines: maximum number of lines in a clients queue before
1354 * they are dropped for flooding.
1356 client_flood_max_lines = 20;
1358 /* Flood control settings. DO NOT CHANGE THESE without extensive discussion
1359 * and testing by someone who knows exactly what they do.
1361 * These settings replicate charybdis-3.3 behaviour.
1363 client_flood_burst_rate = 40;
1364 client_flood_burst_max = 5;
1365 client_flood_message_time = 1;
1366 client_flood_message_num = 2;
1368 /* max_ratelimit_tokens: the maximum number of ratelimit tokens that one
1369 * user can accumulate. This attempts to limit the amount of outbound
1370 * bandwidth one user can consume. Do not change unless you know what
1373 max_ratelimit_tokens = 30;
1375 /* away_interval: the minimum interval between AWAY commands. One
1376 * additional AWAY command is allowed, and only marking as away
1381 /* certfp_method: the method that should be used for computing certificate fingerprints.
1382 * Acceptable options are sha1, sha256, spki_sha256, sha512 and spki_sha512. Networks
1383 * running versions of charybdis prior to charybdis 3.5 MUST use sha1 for certfp_method.
1385 * The spki_* variants operate on the SubjectPublicKeyInfo of the certificate, which does
1386 * not change unless the private key is changed. This allows the fingerprint to stay
1387 * constant even if the certificate is reissued. These fingerprints will be prefixed with
1388 * "SPKI:SHA2-256:" or "SPKI:SHA2-512:" depending on the hash type. These fingerprints
1389 * are not supported on servers running charybdis 3.5.3 or earlier.
1391 * To generate a fingerprint from a certificate file, please use the mkfingerprint utility
1392 * program located in the bin/ subdirectory of your IRCd installation. Running it with no
1393 * arguments will give you a brief usage message; it takes method and filename arguments.
1395 certfp_method = spki_sha256;
1397 /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
1398 hide_opers_in_whois = no;
1400 /* tls_ciphers_oper_only: show the TLS cipher string in /WHOIS only to opers and self */
1401 tls_ciphers_oper_only = no;
1403 /* hidden_caps: client capabilities we'll pretend we don't support until they're requested */
1404 #hidden_caps = "userhost-in-names";
1408 /* module path: paths to search for modules specified below and
1411 path = "/usr/local/ircd/modules";
1412 path = "/usr/local/ircd/modules/autoload";
1414 /* module: the name of a module to load on startup/rehash */
1415 #module = "some_module";