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
47 * Channel mode +-O (oper only) -- chm_operonly
48 * Channel mode +-S (ssl only) -- chm_sslonly
49 * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat
50 * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat
51 * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat
52 * Channel mode +-M (disallow KICK on IRC ops) -- chm_operpeace
53 * Restrict channel creation to logged in users -- createauthonly
54 * Account bans (+b $a[:mask]) -- extb_account
55 * Banned from another channel (+b $j:mask) -- extb_canjoin
56 * Other-channel bans (+b $c:mask) -- extb_channel
57 * Combination extbans -- extb_combi
58 * Extended ban (+b $x:mask) -- extb_extgecos
59 * Hostmask bans (for combination extbans) -- extb_hostmask
60 * Oper bans (+b $o) -- extb_oper
61 * Realname (gecos) bans (+b $r:mask) -- extb_realname
62 * Server bans (+b $s:mask) -- extb_server
63 * SSL bans (+b $z) -- extb_ssl
64 * User mode bans (+b $u:modes) -- extb_usermode
65 * Helpops system (umode +H) -- helpops
67 * New host mangling (umode +x) -- ip_cloaking_4.0
68 * Old host mangling (umode +h) -- ip_cloaking
69 * Dynamically extend channel limits -- m_extendchans
70 * Find channel forwards -- m_findforwards
71 * /identify support -- m_identify
72 * /locops support -- m_locops
73 * Opers cannot be invisible (umode +i) -- no_oper_invis
74 * Far connection notices (snomask +F) -- sno_farconnect
75 * Remote k/d/x line active notices -- sno_globalkline
76 * Remote oper up notices -- sno_globaloper
77 * Global nick-change notices -- sno_globalnickchange
78 * /whois notifications (snomask +W) -- sno_whois
79 * Oper-override (modehacking only) -- override
80 * Stop services kills -- no_kill_services
82 #loadmodule "extensions/chm_adminonly";
83 #loadmodule "extensions/chm_operonly";
84 #loadmodule "extensions/chm_sslonly";
85 #loadmodule "extensions/chm_operonly_compat";
86 #loadmodule "extensions/chm_quietunreg_compat";
87 #loadmodule "extensions/chm_sslonly_compat";
88 #loadmodule "extensions/chm_operpeace";
89 #loadmodule "extensions/createauthonly";
90 #loadmodule "extensions/extb_account";
91 #loadmodule "extensions/extb_canjoin";
92 #loadmodule "extensions/extb_channel";
93 #loadmodule "extensions/extb_combi";
94 #loadmodule "extensions/extb_extgecos";
95 #loadmodule "extensions/extb_hostmask";
96 #loadmodule "extensions/extb_oper";
97 #loadmodule "extensions/extb_realname";
98 #loadmodule "extensions/extb_server";
99 #loadmodule "extensions/extb_ssl";
100 #loadmodule "extensions/extb_usermode";
101 #loadmodule "extensions/helpops";
102 #loadmodule "extensions/hurt";
103 #loadmodule "extensions/ip_cloaking_4.0";
104 #loadmodule "extensions/ip_cloaking";
105 #loadmodule "extensions/m_extendchans";
106 #loadmodule "extensions/m_findforwards";
107 #loadmodule "extensions/m_identify";
108 #loadmodule "extensions/m_locops";
109 #loadmodule "extensions/no_oper_invis";
110 #loadmodule "extensions/sno_farconnect";
111 #loadmodule "extensions/sno_globalkline";
112 #loadmodule "extensions/sno_globalnickchange";
113 #loadmodule "extensions/sno_globaloper";
114 #loadmodule "extensions/sno_whois";
115 #loadmodule "extensions/override";
116 #loadmodule "extensions/no_kill_services";
118 /* serverinfo {}: Contains information about the server. (OLD M:) */
120 /* name: the name of our server */
123 /* sid: the unique server id of our server. This must be three
124 * characters long. The first character must be a digit [0-9], the
125 * remaining two chars may be letters [A-Z] or digits [0-9].
127 * This parameter must be specified for the server to start.
131 /* description: the description of our server. '[' and ']' may not
132 * be used here for compatibility with older servers.
134 description = "charybdis test server";
136 /* network info: the name and description of the network this server
137 * is on. Shown in the 005 reply and used with serverhiding.
139 network_name = "MyNet";
141 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
142 * This should be an ipv4 IP only.
144 #vhost = "192.0.2.6";
146 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
147 * This should be an ipv6 IP only.
149 #vhost6 = "2001:db7:2::6";
151 /* ssl_private_key: our ssl private key */
152 ssl_private_key = "etc/ssl.key";
154 /* ssl_cert: certificate for our ssl server */
155 ssl_cert = "etc/ssl.pem";
157 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
158 ssl_dh_params = "etc/dh.pem";
160 /* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
161 #ssl_cipher_list = "EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
163 /* ssld_count: number of ssld processes you want to start, if you
164 * have a really busy server, using N-1 where N is the number of
165 * cpu/cpu cores you have might be useful. A number greater than one
166 * can also be useful in case of bugs in ssld and because ssld needs
167 * two file descriptors per SSL connection.
171 /* default max clients: the default maximum number of clients
172 * allowed to connect. This can be changed once ircd has started by
174 * /quote set maxclients <limit>
176 default_max_clients = 1024;
178 /* nicklen: enforced nickname length (for this server only; must not
179 * be longer than the maximum length set while building).
184 /* admin {}: contains admin information about the server. (OLD A:) */
186 name = "Smurf target";
187 description = "Main Server Administrator";
188 email = "<syn@packets.r.us>";
191 /* log {}: contains information about logfiles. */
193 /* logfiles: the logfiles to use for specific activity. if these
194 * paths are defined, then ircd will log to them, otherwise it wont.
196 * The confs are, in order:
197 * - userlog: user exits
198 * - fuserlog: failed user connections
199 * - operlog: /oper usage
200 * - foperlog: failed /oper usage
201 * - serverlog: server connects/disconnects
202 * - klinelog: klines, etc
204 * - operspylog: operspy usage
205 * - ioerrorlog: IO errors
207 fname_userlog = "logs/userlog";
208 #fname_fuserlog = "logs/fuserlog";
209 fname_operlog = "logs/operlog";
210 #fname_foperlog = "logs/foperlog";
211 fname_serverlog = "logs/serverlog";
212 #fname_klinelog = "logs/klinelog";
213 fname_killlog = "logs/killlog";
214 fname_operspylog = "logs/operspylog";
215 #fname_ioerrorlog = "logs/ioerror";
218 /* class {}: contain information about classes for users (OLD Y:) */
220 /* class name must go above */
222 /* ping time: how often a client must reply to a PING from the
223 * server before they are dropped.
225 ping_time = 2 minutes;
227 /* number per ident: the number of users per user@host networkwide
228 * allowed to connect. Unidented connections are classified as
231 number_per_ident = 2;
233 /* number per ip: the number of local users per host allowed */
236 /* number per ip global: the number of network wide connections
237 * per host allowed for a user, including connections to the
240 number_per_ip_global = 5;
242 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
244 cidr_ipv4_bitlen = 24;
246 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
247 * the following example makes the subnet /64 this is useful
248 * for IPv6 connections in particular
250 cidr_ipv6_bitlen = 64;
252 /* number_per_cidr: Number of connections to allow from a subnet of the
253 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
254 * 4 seems to be a good default to me.
258 /* max number: the maximum number of users allowed in this class */
261 /* sendq: the amount of data allowed in a clients queue before
268 ping_time = 1 minute 30 seconds;
275 ping_time = 5 minutes;
282 ping_time = 5 minutes;
284 /* connectfreq: only used in server classes. specifies the delay
285 * between autoconnecting to servers.
287 connectfreq = 5 minutes;
289 /* max number: the amount of servers to autoconnect to. if the number
290 * of servers in the class is or exceeds this, no more servers in the
291 * class are autoconnected. oper initiated connects are unaffected.
292 * this should usually be set to either 0 or 1. (autoconnecting from
293 * hubs to leaves may cause leaves to function as hubs by having
294 * multiple servers connected to them.)
298 /* sendq: servers need a higher sendq as they are sent more data */
302 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
304 /* defer_accept: wait for clients to send IRC handshake data before
305 * accepting them. if you intend to use software which depends on the
306 * server replying first, such as BOPM, you should disable this feature.
307 * otherwise, you probably want to leave it on.
311 /* port: the specific port to listen on. if no host is specified
312 * before, it will listen on all available IPs.
314 * sslport: the specific port to listen ssl connections on. if no
315 * host is specified before, it will listen on all available IPs.
317 * ports are seperated via a comma, a range may be specified using ".."
320 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
321 port = 5000, 6665 .. 6669;
323 /* sslport: listen for ssl connections on all available IPs, port 9999 */
326 /* host: set a specific IP/host the ports after the line will listen
327 * on. This may be ipv4 or ipv6.
331 sslport = 9000, 9001;
333 host = "2001:db8:2::6";
338 /* auth {}: allow users to connect to the ircd (OLD I:) */
340 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
341 * lines are permitted per auth block. This is matched against the
342 * hostname and IP address (using :: shortening for IPv6 and
343 * prepending a 0 if it starts with a colon) and can also use CIDR
346 user = "*@198.51.100.0/24";
347 user = "*test@2001:db8:1:*";
349 /* auth_user: This allows specifying a username:password instead of
350 * just a password in PASS, so that a fixed user@host is not
351 * necessary for a specific auth{} block.
353 #auth_user = "SomeUser";
355 /* password: an optional password that is required to use this block.
356 * By default this is not encrypted, specify the flag "encrypted" in
357 * flags = ...; below if it is.
359 password = "letmein";
361 /* spoof: fake the users user@host to be be this. You may either
362 * specify a host or a user@host to spoof to. This is free-form,
363 * just do everyone a favour and dont abuse it. (OLD I: = flag)
365 spoof = "I.still.hate.packets";
367 /* Possible flags in auth:
369 * encrypted | password is encrypted with mkpasswd
370 * spoof_notice | give a notice when spoofing hosts
371 * exceed_limit (old > flag) | allow user to exceed class user limits
372 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines,
373 * | dnsbls, and proxies
374 * dnsbl_exempt | exempt this user from dnsbls
375 * proxy_exempt | exempt this user from proxies
376 * spambot_exempt | exempt this user from spambot checks
377 * shide_exempt | exempt this user from serverhiding
378 * jupe_exempt | exempt this user from generating
379 * warnings joining juped channels
380 * resv_exempt | exempt this user from resvs
381 * flood_exempt | exempt this user from flood limits
383 * no_tilde (old - flag) | don't prefix ~ to username if no ident
384 * need_ident (old + flag) | require ident for user in this class
385 * need_ssl | require SSL/TLS for user in this class
386 * need_sasl | require SASL id for user in this class
387 * extend_chans | allow this user to join more channels than normal
389 flags = kline_exempt, exceed_limit;
391 /* class: the class the user is placed in */
396 /* redirect: the server and port to redirect a user to. A user does
397 * not have to obey the redirection, the ircd just suggests to them
398 * an alternative server.
400 redirserv = "irc.example.net";
403 user = "*.example.com";
405 /* class: a class is required even though it is not used */
414 /* privset{}: defines operator privilege sets. */
416 /* privs: controls the activities and commands an oper is
417 * allowed to do on the server
421 * oper:local_kill: allows local users to be /KILL'd
422 * oper:global_kill: allows local and remote users to be /KILL'd
423 * oper:routing: allows remote SQUIT and CONNECT
424 * oper:kline: allows KLINE and DLINE
425 * oper:unkline: allows UNKLINE and UNDLINE
426 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
427 * oper:rehash: allows oper to REHASH config
428 * oper:die: allows DIE and RESTART
429 * oper:admin: gives admin privileges. admins
430 * may (un)load modules and see various
431 * additional information.
432 * oper:hidden_admin: gives admin privileges except
433 * will not have the admin lines in
435 * oper:xline: allows use of /quote xline/unxline
436 * oper:resv: allows /quote resv/unresv and cmode +LP
437 * oper:operwall: allows the oper to send/receive operwalls
438 * oper:spy: allows 'operspy' features to see through +s
439 * channels etc. see /quote help operspy
440 * oper:hidden: hides the oper from /stats p
441 * oper:remoteban: allows remote kline etc
442 * oper:mass_notice: allows sending wallops and mass notices
443 * oper:grant: allows using the GRANT command
445 privs = oper:local_kill, oper:operwall;
448 privset "server_bot" {
449 /* extends: a privset to inherit in this privset */
450 extends = "local_op";
451 privs = oper:kline, oper:remoteban, snomask:nick_changes;
454 privset "global_op" {
455 extends = "local_op";
456 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
457 oper:resv, oper:mass_notice, oper:remoteban;
461 extends = "global_op";
462 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
465 /* operator {}: defines ircd operators. (OLD O:) */
467 /* name: the name of the oper must go above */
469 /* user: the user@host required for this operator. CIDR *is*
470 * supported now. auth{} spoofs work here, other spoofs do not.
471 * multiple user="" lines are supported.
474 user = "*@127.0.0.1";
476 /* password: the password required to oper. Unless ~encrypted is
477 * contained in flags = ...; this will need to be encrypted using
478 * mkpasswd, MD5 is supported
480 password = "etcnjl8juSU1E";
482 /* rsa key: the public key for this oper when using Challenge.
483 * A password should not be defined when this is used, see
484 * doc/challenge.txt for more information.
486 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
488 /* fingerprint: if specified, the oper's client certificate
489 * fingerprint will be checked against the specified fingerprint
492 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
494 /* umodes: the specific umodes this oper gets when they oper.
495 * If this is specified an oper will not be given oper_umodes
496 * These are described above oper_only_umodes in general {};
498 #umodes = locops, servnotice, operwall, wallop;
500 /* snomask: specific server notice mask on oper up.
501 * If this is specified an oper will not be given oper_snomask.
503 snomask = "+Zbfkrsuy";
505 /* flags: misc options for the operator. You may prefix an option
506 * with ~ to disable it, e.g. ~encrypted.
508 * Default flags are encrypted.
512 * encrypted: the password above is encrypted [DEFAULT]
513 * need_ssl: must be using SSL/TLS to oper up
517 /* privset: privileges set to grant */
521 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
522 connect "irc.uplink.com" {
523 /* the name must go above */
525 /* host: the host or IP to connect to. If a hostname is used it
526 * must match the reverse dns of the server.
528 host = "203.0.113.3";
530 /* vhost: the host or IP to bind to for this connection. If this
531 * is not specified, the default vhost (in serverinfo {}) is used.
533 #vhost = "192.0.2.131";
535 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
536 * The remote server will have these passwords reversed.
538 send_password = "password";
539 accept_password = "anotherpassword";
541 /* fingerprint: if specified, the server's client certificate
542 * fingerprint will be checked against the specified fingerprint
545 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
547 /* port: the port to connect to this server on */
550 /* hub mask: the mask of servers that this server may hub. Multiple
551 * entries are permitted
555 /* leaf mask: the mask of servers this server may not hub. Multiple
556 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
560 /* class: the class this server is in */
563 /* flags: controls special options for this server
564 * encrypted - marks the accept_password as being crypt()'d
565 * autoconn - automatically connect to this server
566 * compressed - compress traffic via ziplinks
567 * topicburst - burst topics between servers
568 * ssl - ssl/tls encrypted server connections
570 flags = compressed, topicburst;
573 connect "ipv6.lame.server" {
574 /* Hosts that are IPv6 addresses must be in :: shortened form
575 * if applicable. Addresses starting with a colon get an extra
576 * zero prepended, for example: 0::1
578 host = "2001:db8:3::8";
579 send_password = "password";
580 accept_password = "password";
583 /* aftype: controls whether the connection uses "ipv4" or "ipv6".
590 connect "ssl.uplink.com" {
591 /* Example of ssl server-to-server connection, ssl flag doesn't need
592 * compressed flag, 'cause it uses own compression
594 host = "203.0.113.129";
595 send_password = "password";
596 accept_password = "anotherpassword";
600 flags = ssl, topicburst;
603 /* cluster {}; servers that we propagate things to automatically.
604 * NOTE: This does NOT grant them privileges to apply anything locally,
605 * you must add a seperate shared block for that. Clustering will
606 * only be done for actions by LOCAL opers, that arent directed
610 /* name: the server to share with, this can be a wildcard and may be
613 /* flags: list of what to share, all the name lines above this (up
614 * until another flags entry) will receive these flags.
616 * kline - share perm klines
617 * tkline - share temp klines
618 * unkline - share unklines
619 * locops - share locops
620 * xline - share perm xlines
621 * txline - share temp xlines
622 * unxline - share unxlines
623 * resv - share perm resvs
624 * tresv - share temp resvs
625 * unresv - share unresvs
626 * all - share all of the above
629 /* share klines/unklines/xlines with *.lan */
631 flags = kline, unkline, xline;
633 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
634 name = "irc.ircd-ratbox.org";
635 name = "ircd.ircd-ratbox.org";
639 /* service{}: privileged servers (services). These servers have extra
640 * privileges such as setting login names on users and introducing clients
641 * with umode +S (unkickable, hide channels, etc). This does not allow them
642 * to set bans, you need a separate shared{} for that.
643 * Do not place normal servers here.
644 * There may be only one service{} block.
647 /* name: the server name. These may be stacked. */
648 name = "services.int";
651 /* shared {}: users that are allowed to place remote bans on our server.
652 * NOTE: These are ordered top down. The first one the user@host and server
653 * matches will be used. Their access will then be decided on that
654 * block and will not fall back to another block that matches.
657 /* oper: the user@host and server the user must be on to set klines.
658 * The first field must be a user@host, the second field is an
659 * optional server. These may be stacked.
661 /* flags: list of what to allow them to place, all the oper lines
662 * above this (up until another flags entry) will receive these
663 * flags. This *must* be present.
665 * kline - allow setting perm/temp klines
666 * tkline - allow setting temp klines
667 * unkline - allow removing klines
668 * xline - allow setting perm/temp xlines
669 * txline - allow setting temp xlines
670 * unxline - allow removing xlines
671 * resv - allow setting perm/temp resvs
672 * tresv - allow setting temp resvs
673 * unresv - allow removing xlines
674 * all - allow oper/server to do all of above.
675 * locops - allow locops - only used for servers who cluster
676 * rehash - allow rehashing
677 * dline - allow setting perm/temp dlines
678 * tdline - allow setting temp dlines
679 * undline - allow removing dlines
680 * grant - allow granting operator status
681 * die - allow remote DIE/RESTART
682 * module - allow remote module commands
683 * none - disallow everything
686 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
687 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
689 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
690 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
693 /* you may forbid certain opers/servers from doing anything */
694 oper = "irc@vanity.oper", "*";
695 oper = "*@*", "irc.vanity.server";
696 oper = "irc@another.vanity.oper", "bigger.vanity.server";
699 /* or allow everyone to place temp klines */
704 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
708 /* these may be stacked */
712 /* The channel block contains options pertaining to channels */
714 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
715 * that can join a +i channel without an invite.
719 /* except: Enable/disable channel mode +e, a n!u@h list of masks
720 * that can join a channel through a ban (+b).
724 /* forward: Enable/disable channel mode +f, a channel to forward
725 * users to if they can't join because of +i etc. Also enables ban
726 * forwarding, <mask>$<channel>.
730 /* knock: Allows users to request an invite to a channel that
731 * is locked somehow (+ikl). If the channel is +p or you are banned
732 * the knock will not be sent.
736 /* knock delay: The amount of time a user must wait between issuing
739 knock_delay = 5 minutes;
741 /* knock channel delay: How often a knock to any specific channel
742 * is permitted, regardless of the user sending the knock.
744 knock_delay_channel = 1 minute;
746 /* max chans: The maximum number of channels a user can join/be on. */
747 max_chans_per_user = 15;
749 /* max chans (large): The extended maximum number of channels a user can join. */
750 max_chans_per_user_large = 60;
752 /* max bans: maximum number of +b/e/I/q modes in a channel */
755 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
756 max_bans_large = 500;
758 /* splitcode: split users, split servers and either no join on split
759 * or no create on split must be enabled for split checking.
760 * splitmode will be entered on either split users or split servers
761 * dropping below the limit.
763 * you may force splitmode to be permanent by /quote set splitmode on
766 /* split users: when the usercount is lower than this level, consider
767 * ourselves split. this must be set for automatic splitmode
769 default_split_user_count = 0;
771 /* split servers: when the amount of servers that have acknowledged
772 * theyve finished bursting is lower than this, consider ourselves
773 * split. this must be set for automatic splitmode
775 default_split_server_count = 0;
777 /* split: no create: disallow users creating channels on split */
778 no_create_on_split = no;
780 /* split: no join: disallow users joining channels at all on a split */
781 no_join_on_split = no;
783 /* burst topicwho: when bursting topics, also burst the topic setter */
784 burst_topicwho = yes;
786 /* kick on split riding: kick users riding splits to join +i or +k
787 * channels. more precisely, if a bursting server sends an SJOIN
788 * for a channel with a lower TS with either a +i mode or a +k
789 * mode with a different key, kick all local users.
791 * note: this does not take +r, +b, +e and +I into account.
793 kick_on_split_riding = no;
795 /* only ascii channels: disable local users joining channels
796 * containing characters outside the range 33-126 (non-printable
799 only_ascii_channels = no;
801 /* resv_forcepart: force any local users to part a channel
802 * when a RESV is issued.
804 resv_forcepart = yes;
806 /* channel target change: restrict how many channels users can
807 * message per unit of time. IRC operators, channel operators and
808 * voiced users are exempt.
810 channel_target_change = yes;
812 /* disable local channels: if yes, then local channels will not be
815 disable_local_channels = no;
817 /* autochanmodes: the channel modes that should be automatically set
818 * when a channel is created.
820 autochanmodes = "+nt";
822 /* displayed_usercount: the minimum amount of users on a channel before it
823 * is displayed in LIST. this parameter can be overridden using ELIST parameters,
826 displayed_usercount = 3;
828 /* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */
829 strip_topic_colors = no;
833 /* The serverhide block contains the options regarding serverhiding */
835 /* flatten links: this option will hide various routing information
836 * and make all servers in /links appear that they are linked to
841 /* links delay: how long to wait before showing splits or new
842 * servers in a flattened /links output.
844 links_delay = 5 minutes;
846 /* hidden: hide this server from a /links output on servers with
847 * flatten_links enabled. this allows hub servers to be hidden etc.
851 /* disable hidden: prevent servers hiding themselves from a
857 /* These are the blacklist settings.
858 * You can have multiple combinations of host and rejection reasons.
859 * They are used in pairs of one host/rejection reason.
861 * These settings should be adequate for most networks.
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";
902 /* These are the OPM settings.
903 * This is similar to the functionality provided by BOPM. It will scan incoming
904 * connections for open proxies by connecting to clients and attempting several
905 * different open proxy handshakes. If they connect back to us (via a dedicated
906 * listening port), and send back the data we send them, they are considered
907 * an open proxy. For politeness reasons (users may be confused by the incoming
908 * connection attempts if they are logging incoming connections), the user is
909 * notified upon connect if they are being scanned.
912 * These settings are considered experimental. Only the most common proxy types
913 * are checked for (Charybdis is immune from POST and GET proxies). If you are
914 * not comfortable with experimental code, remove or comment out the *entire*
915 * block below to disable the proxy scanner.
918 /* IPv4 address to listen on. This must be a publicly facing IP address
920 * If omitted, it defaults to serverinfo::vhost.
922 #listen_ipv4 = "127.0.0.1";
924 /* IPv4 port to listen on.
925 * This should not be the same as any existing listeners.
929 /* IPv6 address to listen on. This must be a publicly facing IP address
931 * If omitted, it defaults to serverinfo::vhost6.
933 #listen_ipv6 = "0::1";
935 /* IPv6 port to listen on.
936 * This should not be the same as any existing listeners.
940 /* You can also set the listen_port directive which will set both the
941 * IPv4 and IPv6 ports at once.
945 /* This sets the timeout in seconds before ending open proxy scans.
946 * Values less than 1 or greater than 60 are ignored.
947 * It is advisable to keep it as short as feasible, so clients do not
948 * get held up by excessively long scan times.
952 /* These are the ports to scan for SOCKS4 proxies on. They may overlap
953 * with other scan types. Sensible defaults are given below.
955 socks4_ports = 80, 443, 1080, 8000, 8080, 10800;
957 /* These are the ports to scan for SOCKS5 proxies on. They may overlap
958 * with other scan types. Sensible defaults are given below.
960 socks5_ports = 80, 443, 1080, 8000, 8080, 10800;
962 /* These are the ports to scan for HTTP CONNECT proxies on (plaintext).
963 * They may overlap with other scan types. Sensible defaults are given
966 httpconnect_ports = 80, 8080, 8000;
968 /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
969 * They may overlap with other scan types. Sensible defaults are given
972 httpsconnect_ports = 443, 4443;
976 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
977 * They send PRIVMSG to the given target. A real command takes
978 * precedence above an alias.
981 /* the name must go above */
983 /* target: the target nick (must be a network service) or
984 * user@server (cannot be this server, only opers can use
985 * user starting with "opers" reliably, interpreted on the target
986 * server only so you may need to use nick@server instead)
1000 target = "MemoServ";
1004 target = "NickServ";
1008 target = "ChanServ";
1012 target = "OperServ";
1016 target = "MemoServ";
1019 /* The general block contains many of the options that were once compiled
1020 * in options in config.h. The general block is read at start time.
1023 /* hide error messages: defines whether error messages from
1024 * servers that are not deemed fully safe are hidden or not.
1025 * These can sometimes contain IPs and can have an adverse
1026 * effect on server ip hiding. Set to:
1027 * yes: hide from opers and admin
1028 * opers: hide from opers only
1029 * no: do not hide error messages
1030 * Admins on other servers count as opers.
1032 hide_error_messages = opers;
1034 /* hide spoof ips: hide the real ips of auth{} spoofed users
1035 * If disabled, local opers can see them.
1036 * Dynamic spoofs (e.g. set by services) are unaffected by this;
1037 * any oper (local and remote) can see the real ip.
1039 hide_spoof_ips = yes;
1041 /* default umodes: umodes to set upon connection
1042 * If you have enabled the ip_cloaking extension, and you wish for
1043 * incoming clients to be set +h or +x upon connection, add +h or +x to the umode
1046 default_umodes = "+i";
1048 /* default operstring: defines the default oper response
1049 * in /whois queries, eg "is an IRC Operator".
1050 * After startup use /quote set operstring to change.
1052 default_operstring = "is an IRC Operator";
1054 /* default adminstring: defines the default admin response
1055 * in /whois queries, eg "is a Server Administrator".
1056 * After startup use /quote set adminstring to change.
1058 default_adminstring = "is a Server Administrator";
1060 /* servicestring: defines the response for opered services (+S)
1061 * in /whois queries, eg "is a Network Service".
1062 * This is updated on rehash.
1064 servicestring = "is a Network Service";
1067 * Nick of the network's SASL agent. Used to check whether services are here,
1068 * SASL credentials are only sent to its server. Needs to be a service.
1070 * Defaults to SaslServ if unspecified.
1072 sasl_service = "SaslServ";
1074 /* disable fake channels: disable local users joining fake versions
1075 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
1076 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
1078 disable_fake_channels = no;
1080 /* tkline_expire_notices: give a notice to opers when a tkline
1083 tkline_expire_notices = no;
1085 /* floodcount: the default value of floodcount that is configurable
1086 * via /quote set floodcount. This is the amount of lines a user
1087 * may send to any other user/channel in one second.
1089 default_floodcount = 10;
1091 /* failed oper notice: send a notice to all opers on the server when
1092 * someone tries to OPER and uses the wrong password, host or ident.
1094 failed_oper_notice = yes;
1096 /* dots in ident: the amount of '.' characters permitted in an ident
1097 * reply before the user is rejected.
1101 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
1102 * placed via the server. klines hand placed are exempt from limits.
1103 * wildcard chars: '.' '*' '?' '@'
1105 min_nonwildcard = 4;
1107 /* min nonwildcard simple: the minimum non wildcard characters in
1108 * xlines/resvs placed via the server.
1109 * wildcard chars: '*' '?'
1111 min_nonwildcard_simple = 3;
1113 /* max accept: maximum allowed /accept's for +g usermode */
1116 /* max monitor: the maximum amount of nicknames a client may have in
1117 * their monitor (server-side notify) list.
1121 /* nick flood: enable the nickflood control code */
1122 anti_nick_flood = yes;
1124 /* nick flood: the nick changes allowed in the specified period */
1125 max_nick_time = 20 seconds;
1126 max_nick_changes = 5;
1128 /* anti spam time: the minimum time a user must be connected before
1129 * custom quit messages are allowed.
1131 anti_spam_exit_message_time = 5 minutes;
1133 /* ts delta: the time delta allowed between server clocks before
1134 * a warning is given, or before the link is dropped. all servers
1135 * should run ntpdate/rdate to keep clocks in sync
1137 ts_warn_delta = 30 seconds;
1138 ts_max_delta = 5 minutes;
1140 /* client exit: prepend a user's quit message with "Quit: " */
1143 /* collision fnc: change user's nick to their UID instead of
1144 * killing them, if possible. This setting only applies to nick
1145 * collisions detected on this server. Only enable this if
1146 * all servers on the network allow remote nicks to start with
1149 collision_fnc = yes;
1151 /* resv fnc: change a user's nick to a nick they have recently used
1152 * (or their UID, if no such nick can be found) when a resv matching
1153 * them is set by services. Only enable this if all servers on the
1154 * network allow remote nicks to start with a digit.
1158 /* global snotices: send out certain snotices (most +b, +f, +y,
1159 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1160 * displayed unconditionally.
1162 global_snotices = yes;
1164 /* dline reason: show the user the dline reason when they connect
1167 dline_with_reason = yes;
1169 /* kline delay: delay the checking of klines until a specified time.
1170 * Useful if large kline lists are applied often to prevent the
1171 * server eating CPU.
1173 kline_delay = 0 seconds;
1175 /* kline reason: show the user the reason why they are k/dlined
1176 * on exit. may give away who set k/dline when set via tcm.
1178 kline_with_reason = yes;
1180 /* kline reason: make the users quit message on channels this
1181 * reason instead of the oper's reason.
1183 kline_reason = "Connection closed";
1185 /* identify to services via server password
1186 * if auth{} block had no password but the user specified a
1187 * server password anyway, send a PRIVMSG to <identify_service>
1188 * with as text <identify_command> <password>.
1190 identify_service = "NickServ@services.int";
1191 identify_command = "IDENTIFY";
1193 /* non redundant klines: flag and ignore redundant klines */
1194 non_redundant_klines = yes;
1196 /* warn no nline: warn opers about servers that try to connect but
1197 * we dont have a connect {} block for. Twits with misconfigured
1198 * servers can get really annoying with this enabled.
1200 warn_no_nline = yes;
1202 /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
1203 * That means the bans are part of the netburst and restarted/split
1204 * servers will get them, but they will not apply to 3.2 and older
1207 use_propagated_bans = yes;
1209 /* stats e disabled: disable stats e. useful if server ips are
1210 * exempted and you dont want them listing on irc.
1212 stats_e_disabled = no;
1214 /* stats c oper only: make stats c (connect {}) oper only */
1215 stats_c_oper_only = no;
1217 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
1218 stats_h_oper_only = no;
1220 /* stats y oper only: make stats y (class {}) oper only */
1221 stats_y_oper_only = no;
1223 /* stats o oper only: make stats o (opers) oper only */
1224 stats_o_oper_only = yes;
1226 /* stats P oper only: make stats P (ports) oper only
1227 * NOTE: users doing stats P will never be given the ips that the
1228 * server listens on, simply the ports.
1230 stats_P_oper_only = no;
1232 /* stats i oper only: make stats i (auth {}) oper only. set to:
1233 * yes: show users no auth blocks, made oper only.
1234 * masked: show users first matching auth block
1235 * no: show users all auth blocks.
1237 stats_i_oper_only = masked;
1239 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1240 * yes: show users no auth blocks, made oper only
1241 * masked: show users first matching auth block
1242 * no: show users all auth blocks.
1244 stats_k_oper_only = masked;
1246 /* map oper only: make /map oper only */
1249 /* operspy admin only: make operspy notices to +Z admin only */
1250 operspy_admin_only = no;
1252 /* operspy dont care user info: treat /who mask as if there was
1253 * an '!' always; do not log or server notice about operspy
1254 * /who mask, /masktrace and /scan. channel information is still
1256 operspy_dont_care_user_info = no;
1258 /* caller id wait: time between notifying a +g user that somebody
1259 * is messaging them.
1261 caller_id_wait = 1 minute;
1263 /* pace wait simple: time between use of less intensive commands
1264 * (HELP, remote WHOIS, WHOWAS)
1266 pace_wait_simple = 1 second;
1268 /* pace wait: time between more intensive commands
1269 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1271 pace_wait = 10 seconds;
1273 /* short motd: send clients a notice telling them to read the motd
1274 * instead of forcing a motd to clients who may simply ignore it.
1278 /* ping cookies: require clients to respond exactly to a ping command,
1279 * can help block certain types of drones and FTP PASV mode spoofing.
1283 /* connect timeout: sets how long we should wait for a connection
1284 * request to succeed
1286 connect_timeout = 30 seconds;
1288 /* ident timeout: Amount of time (in seconds) that the IRCd will
1289 * wait for a user to respond to an ident request.
1291 default_ident_timeout = 5;
1293 /* disable auth: disables identd checking */
1296 /* no oper flood: increase flood limits for opers. */
1297 no_oper_flood = yes;
1299 /* REMOVE ME. The following line checks you've been reading. */
1300 havent_read_conf = yes;
1302 /* max targets: the maximum amount of targets in a single
1303 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1307 /* use_whois_actually: send clients requesting a whois a numeric
1308 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1310 use_whois_actually = yes;
1312 /* usermodes configurable: a list of usermodes for the options below
1314 * +g - callerid - Server Side Ignore
1315 * +D - deaf - Don't see channel messages
1316 * +i - invisible - Not shown in NAMES or WHO unless you share a
1318 * +l - locops - See LOCOPS messages
1319 * +Q - noforward - Unaffected by channel forwarding
1320 * +R - regonlymsg - No messages from unindentified
1321 * +s - servnotice - See server notices
1322 * +w - wallop - See oper and server generated WALLOPS
1323 * +z - operwall - See operwalls
1326 /* oper only umodes: usermodes only opers may set */
1327 oper_only_umodes = operwall, locops, servnotice;
1329 /* oper umodes: default usermodes opers get when they /oper */
1330 oper_umodes = locops, servnotice, operwall, wallop;
1332 /* oper snomask: default snomask opers get when they /oper,
1333 * provided they have umode +s set */
1334 oper_snomask = "+s";
1336 /* compression level: level of compression for compressed links between
1339 * values are between: 1 (least compression, fastest)
1340 * and: 9 (most compression, slowest).
1342 #compression_level = 6;
1344 /* burst_away: This enables bursting away messages to servers.
1345 * With this disabled, we will only propogate AWAY messages
1346 * as users send them, but never burst them. Be warned though
1347 * enabling this could increase the size of a burst significantly
1348 * for a large network, like EFnet.
1352 /* nick delay: This locks nicks of split clients for the given time
1353 * or until a remote client uses the nick. This significantly
1354 * reduces nick collisions on short splits but it can be annoying.
1355 * To make things as fair as possible, this should be the same on
1356 * all servers. If you enable this, the suggested value is 15 minutes.
1358 nick_delay = 0 seconds;
1360 /* reject time: the amount of rejections through klines/dlines etc
1361 * allowed in the given time before the rejection is cached and
1362 * a pseudo temp dline is placed
1364 reject_ban_time = 1 minute;
1365 reject_after_count = 3;
1367 /* reject duration: the amount of time to cache the rejection */
1368 reject_duration = 5 minutes;
1370 /* throttle_duration: Amount of time that throttling will be applied to an IP
1373 throttle_duration = 60;
1375 /* throttle_count: Number of connections within throttle_duration that it takes
1376 * for throttling to take effect */
1379 /* client flood_max_lines: maximum number of lines in a clients queue before
1380 * they are dropped for flooding.
1382 client_flood_max_lines = 20;
1384 /* Flood control settings. DO NOT CHANGE THESE without extensive discussion
1385 * and testing by someone who knows exactly what they do.
1387 * These settings replicate charybdis-3.3 behaviour.
1389 client_flood_burst_rate = 40;
1390 client_flood_burst_max = 5;
1391 client_flood_message_time = 1;
1392 client_flood_message_num = 2;
1394 /* max_ratelimit_tokens: the maximum number of ratelimit tokens that one
1395 * user can accumulate. This attempts to limit the amount of outbound
1396 * bandwidth one user can consume. Do not change unless you know what
1399 max_ratelimit_tokens = 30;
1401 /* away_interval: the minimum interval between AWAY commands. One
1402 * additional AWAY command is allowed, and only marking as away
1407 /* certfp_method: the method that should be used for computing certificate fingerprints.
1408 * Acceptable options are sha1, sha256, spki_sha256, sha512 and spki_sha512. Networks
1409 * running versions of charybdis prior to charybdis 3.5 MUST use sha1 for certfp_method.
1411 * The spki_* variants operate on the SubjectPublicKeyInfo of the certificate, which does
1412 * not change unless the private key is changed. This allows the fingerprint to stay
1413 * constant even if the certificate is reissued.
1415 certfp_method = sha1;
1417 /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
1418 hide_opers_in_whois = no;
1422 /* module path: paths to search for modules specified below and
1425 path = "/usr/local/ircd/modules";
1426 path = "/usr/local/ircd/modules/autoload";
1428 /* module: the name of a module to load on startup/rehash */
1429 #module = "some_module";