1 /* doc/ircd.conf.example - brief 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 * See reference.conf for more information.
11 #loadmodule "extensions/chm_nonotice";
12 #loadmodule "extensions/chm_operonly_compat";
13 #loadmodule "extensions/chm_quietunreg_compat";
14 #loadmodule "extensions/chm_sslonly_compat";
15 #loadmodule "extensions/chm_operpeace";
16 #loadmodule "extensions/createauthonly";
17 #loadmodule "extensions/extb_account";
18 #loadmodule "extensions/extb_canjoin";
19 #loadmodule "extensions/extb_channel";
20 #loadmodule "extensions/extb_combi";
21 #loadmodule "extensions/extb_extgecos";
22 #loadmodule "extensions/extb_hostmask";
23 #loadmodule "extensions/extb_oper";
24 #loadmodule "extensions/extb_realname";
25 #loadmodule "extensions/extb_server";
26 #loadmodule "extensions/extb_ssl";
27 #loadmodule "extensions/extb_usermode";
28 #loadmodule "extensions/hurt";
29 #loadmodule "extensions/m_extendchans";
30 #loadmodule "extensions/m_findforwards";
31 #loadmodule "extensions/m_identify";
32 #loadmodule "extensions/m_locops";
33 #loadmodule "extensions/no_oper_invis";
34 #loadmodule "extensions/sno_farconnect";
35 #loadmodule "extensions/sno_globalkline";
36 #loadmodule "extensions/sno_globalnickchange";
37 #loadmodule "extensions/sno_globaloper";
38 #loadmodule "extensions/sno_whois";
39 #loadmodule "extensions/override";
40 #loadmodule "extensions/no_kill_services";
43 * IP cloaking extensions: use ip_cloaking_4.0
44 * if you're linking 3.2 and later, otherwise use
45 * ip_cloaking, for compatibility with older 3.x
49 #loadmodule "extensions/ip_cloaking_4.0";
50 #loadmodule "extensions/ip_cloaking";
55 description = "charybdis test server";
56 network_name = "StaticBox";
58 /* On multi-homed hosts you may need the following. These define
59 * the addresses we connect from to other servers. */
63 #vhost6 = "2001:db8:2::6";
65 /* ssl_cert: certificate (and optionally key) for our ssl server */
66 ssl_cert = "etc/ssl.pem";
68 /* ssl_private_key: our ssl private key (if not contained in ssl_cert file) */
69 #ssl_private_key = "etc/ssl.key";
71 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 2048
72 * In general, the DH parameters size should be the same as your key's size.
73 * However it has been reported that some clients have broken TLS implementations which may
74 * choke on keysizes larger than 2048-bit, so we would recommend using 2048-bit DH parameters
75 * for now if your keys are larger than 2048-bit.
77 * If you do not provide parameters, some TLS backends will fail on DHE- ciphers,
78 * and some will succeed but use weak, common DH groups! */
79 ssl_dh_params = "etc/dh.pem";
81 /* ssld_count: number of ssld processes you want to start, if you
82 * have a really busy server, using N-1 where N is the number of
83 * cpu/cpu cores you have might be useful. A number greater than one
84 * can also be useful in case of bugs in ssld and because ssld needs
85 * two file descriptors per SSL connection.
89 /* default max clients: the default maximum number of clients
90 * allowed to connect. This can be changed once ircd has started by
92 * /quote set maxclients <limit>
94 default_max_clients = 1024;
96 /* nicklen: enforced nickname length (for this server only; must not
97 * be longer than the maximum length set while building).
103 name = "Lazy admin (lazya)";
104 description = "StaticBox client server";
105 email = "nobody@127.0.0.1";
109 fname_userlog = "logs/userlog";
110 #fname_fuserlog = "logs/fuserlog";
111 fname_operlog = "logs/operlog";
112 #fname_foperlog = "logs/foperlog";
113 fname_serverlog = "logs/serverlog";
114 #fname_klinelog = "logs/klinelog";
115 fname_killlog = "logs/killlog";
116 fname_operspylog = "logs/operspylog";
117 #fname_ioerrorlog = "logs/ioerror";
120 /* class {} blocks MUST be specified before anything that uses them. That
121 * means they must be defined before auth {} and before connect {}.
124 ping_time = 2 minutes;
125 number_per_ident = 10;
127 number_per_ip_global = 50;
128 cidr_ipv4_bitlen = 24;
129 cidr_ipv6_bitlen = 64;
130 number_per_cidr = 200;
136 ping_time = 5 minutes;
143 ping_time = 5 minutes;
144 connectfreq = 5 minutes;
150 /* defer_accept: wait for clients to send IRC handshake data before
151 * accepting them. if you intend to use software which depends on the
152 * server replying first, such as BOPM, you should disable this feature.
153 * otherwise, you probably want to leave it on.
157 /* If you want to listen on a specific IP only, specify host.
158 * host definitions apply only to the following port line.
161 port = 5000, 6665 .. 6669;
164 /* Listen on IPv6 (if you used host= above). */
165 #host = "2001:db8:2::6";
166 #port = 5000, 6665 .. 6669;
169 /* wsock: listeners defined with this option enabled will be websocket listeners,
170 * and will not accept normal clients.
176 /* auth {}: allow users to connect to the ircd (OLD I:)
177 * auth {} blocks MUST be specified in order of precedence. The first one
178 * that matches a user will be used. So place spoofs first, then specials,
179 * then general access, then restricted.
182 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
183 * lines are permitted per auth block. This is matched against the
184 * hostname and IP address (using :: shortening for IPv6 and
185 * prepending a 0 if it starts with a colon) and can also use CIDR
188 user = "*@198.51.100.0/24";
189 user = "*test@2001:db8:1:*";
191 /* password: an optional password that is required to use this block.
192 * By default this is not encrypted, specify the flag "encrypted" in
193 * flags = ...; below if it is.
195 password = "letmein";
197 /* spoof: fake the users user@host to be be this. You may either
198 * specify a host or a user@host to spoof to. This is free-form,
199 * just do everyone a favour and dont abuse it. (OLD I: = flag)
201 spoof = "I.still.hate.packets";
203 /* Possible flags in auth:
205 * encrypted | password is encrypted with mkpasswd
206 * spoof_notice | give a notice when spoofing hosts
207 * exceed_limit (old > flag) | allow user to exceed class user limits
208 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines,
209 * | dnsbls, and proxies
210 * proxy_exempt | exempt this user from proxies
211 * dnsbl_exempt | exempt this user from dnsbls
212 * spambot_exempt | exempt this user from spambot checks
213 * shide_exempt | exempt this user from serverhiding
214 * jupe_exempt | exempt this user from generating
215 * warnings joining juped channels
216 * resv_exempt | exempt this user from resvs
217 * flood_exempt | exempt this user from flood limits
219 * no_tilde (old - flag) | don't prefix ~ to username if no ident
220 * need_ident (old + flag) | require ident for user in this class
221 * need_ssl | require SSL/TLS for user in this class
222 * need_sasl | require SASL id for user in this class
224 flags = kline_exempt, exceed_limit;
226 /* class: the class the user is placed in */
235 /* privset {} blocks MUST be specified before anything that uses them. That
236 * means they must be defined before operator {}.
239 privs = oper:local_kill, oper:operwall;
242 privset "server_bot" {
243 extends = "local_op";
244 privs = oper:kline, oper:remoteban, snomask:nick_changes;
247 privset "global_op" {
248 extends = "local_op";
249 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
250 oper:resv, oper:mass_notice, oper:remoteban;
254 extends = "global_op";
255 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
259 /* name: the name of the oper must go above */
261 /* user: the user@host required for this operator. CIDR *is*
262 * supported now. auth{} spoofs work here, other spoofs do not.
263 * multiple user="" lines are supported.
265 user = "*god@127.0.0.1";
267 /* password: the password required to oper. Unless ~encrypted is
268 * contained in flags = ...; this will need to be encrypted using
269 * mkpasswd, MD5 is supported
271 password = "etcnjl8juSU1E";
273 /* rsa key: the public key for this oper when using Challenge.
274 * A password should not be defined when this is used, see
275 * doc/challenge.txt for more information.
277 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
279 /* umodes: the specific umodes this oper gets when they oper.
280 * If this is specified an oper will not be given oper_umodes
281 * These are described above oper_only_umodes in general {};
283 #umodes = locops, servnotice, operwall, wallop;
285 /* fingerprint: if specified, the oper's client certificate
286 * fingerprint will be checked against the specified fingerprint
289 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
291 /* snomask: specific server notice mask on oper up.
292 * If this is specified an oper will not be given oper_snomask.
294 snomask = "+Zbfkrsuy";
296 /* flags: misc options for the operator. You may prefix an option
297 * with ~ to disable it, e.g. ~encrypted.
299 * Default flags are encrypted.
303 * encrypted: the password above is encrypted [DEFAULT]
304 * need_ssl: must be using SSL/TLS to oper up
308 /* privset: privileges set to grant */
312 connect "irc.uplink.com" {
313 host = "203.0.113.3";
314 send_password = "password";
315 accept_password = "anotherpassword";
319 flags = compressed, topicburst;
321 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
324 connect "ssl.uplink.com" {
325 host = "203.0.113.129";
326 send_password = "password";
327 accept_password = "anotherpassword";
331 flags = ssl, topicburst;
335 name = "services.int";
340 flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
348 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
358 knock_delay = 5 minutes;
359 knock_delay_channel = 1 minute;
360 max_chans_per_user = 15;
361 max_chans_per_user_large = 60;
363 max_bans_large = 500;
364 default_split_user_count = 0;
365 default_split_server_count = 0;
366 no_create_on_split = no;
367 no_join_on_split = no;
368 burst_topicwho = yes;
369 kick_on_split_riding = no;
370 only_ascii_channels = no;
371 resv_forcepart = yes;
372 channel_target_change = yes;
373 disable_local_channels = no;
374 autochanmodes = "+nt";
375 displayed_usercount = 3;
376 strip_topic_colors = no;
381 links_delay = 5 minutes;
386 /* These are the blacklist settings.
387 * You can have multiple combinations of host and rejection reasons.
388 * They are used in pairs of one host/rejection reason.
390 * These settings should be adequate for most networks.
392 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
395 * As of charybdis 2.2, you can do some keyword substitution on the rejection
396 * reason. The available keyword substitutions are:
398 * ${ip} - the user's IP
399 * ${host} - the user's canonical hostname
400 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
401 * ${nick} - the user's nickname
402 * ${network-name} - the name of the network
404 * As of charybdis 3.4, a type parameter is supported, which specifies the
405 * address families the blacklist supports. IPv4 and IPv6 are supported.
406 * IPv4 is currently the default as few blacklists support IPv6 operation
407 * as of this writing.
409 * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
410 * is considered a match. If included, a comma-separated list of *quoted*
411 * strings is allowed to match queries. They may be of the format "0" to "255"
412 * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
413 * an A record. The blacklist is only applied if it matches anything in the
414 * list. You may freely mix full IP's and final octets.
416 * Consult your blacklist provider for the meaning of these parameters; they
417 * are usually used to denote different ban types.
420 host = "rbl.efnetrbl.org";
422 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
424 /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
425 # host = "foobl.blacklist.invalid";
427 # matches = "4", "6", "127.0.0.10";
428 # 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";
431 /* These are the OPM settings.
432 * This is similar to the functionality provided by BOPM. It will scan incoming
433 * connections for open proxies by connecting to clients and attempting several
434 * different open proxy handshakes. If they connect back to us (via a dedicated
435 * listening port), and send back the data we send them, they are considered
436 * an open proxy. For politeness reasons (users may be confused by the incoming
437 * connection attempts if they are logging incoming connections), the user is
438 * notified upon connect if they are being scanned.
441 * These settings are considered experimental. Only the most common proxy types
442 * are checked for (Charybdis is immune from POST and GET proxies). If you are
443 * not comfortable with experimental code, do not use this feature.
446 /* IPv4 address to listen on. This must be a publicly facing IP address
448 * If omitted, it defaults to serverinfo::vhost.
450 #listen_ipv4 = "127.0.0.1";
452 /* IPv4 port to listen on.
453 * This should not be the same as any existing listeners.
457 /* IPv6 address to listen on. This must be a publicly facing IP address
459 * If omitted, it defaults to serverinfo::vhost6.
461 #listen_ipv6 = "::1";
463 /* IPv6 port to listen on.
464 * This should not be the same as any existing listeners.
468 /* You can also set the listen_port directive which will set both the
469 * IPv4 and IPv6 ports at once.
471 #listen_port = 32000;
473 /* This sets the timeout in seconds before ending open proxy scans.
474 * Values less than 1 or greater than 60 are ignored.
475 * It is advisable to keep it as short as feasible, so clients do not
476 * get held up by excessively long scan times.
480 /* These are the ports to scan for SOCKS4 proxies on. They may overlap
481 * with other scan types. Sensible defaults are given below.
483 #socks4_ports = 1080, 10800, 443, 80, 8080, 8000;
485 /* These are the ports to scan for SOCKS5 proxies on. They may overlap
486 * with other scan types. Sensible defaults are given below.
488 #socks5_ports = 1080, 10800, 443, 80, 8080, 8000;
490 /* These are the ports to scan for HTTP connect proxies on (plaintext).
491 * They may overlap with other scan types. Sensible defaults are given
494 #httpconnect_ports = 80, 8080, 8000;
496 /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
497 * They may overlap with other scan types. Sensible defaults are given
500 #httpsconnect_ports = 443, 4443;
536 hide_error_messages = opers;
537 hide_spoof_ips = yes;
540 * default_umodes: umodes to enable on connect.
541 * If you have enabled the new ip_cloaking_4.0 module, and you want
542 * to make use of it, add +x to this option, i.e.:
543 * default_umodes = "+ix";
545 * If you have enabled the old ip_cloaking module, and you want
546 * to make use of it, add +h to this option, i.e.:
547 * default_umodes = "+ih";
549 default_umodes = "+i";
551 default_operstring = "is an IRC Operator";
552 default_adminstring = "is a Server Administrator";
553 servicestring = "is a Network Service";
556 * Nick of the network's SASL agent. Used to check whether services are here,
557 * SASL credentials are only sent to its server. Needs to be a service.
559 * Defaults to SaslServ if unspecified.
561 sasl_service = "SaslServ";
562 disable_fake_channels = no;
563 tkline_expire_notices = no;
564 default_floodcount = 10;
565 failed_oper_notice = yes;
568 min_nonwildcard_simple = 3;
571 anti_nick_flood = yes;
572 max_nick_time = 20 seconds;
573 max_nick_changes = 5;
574 anti_spam_exit_message_time = 5 minutes;
575 ts_warn_delta = 30 seconds;
576 ts_max_delta = 5 minutes;
580 global_snotices = yes;
581 dline_with_reason = yes;
582 kline_with_reason = yes;
583 kline_reason = "K-Lined";
584 identify_service = "NickServ@services.int";
585 identify_command = "IDENTIFY";
586 non_redundant_klines = yes;
588 use_propagated_bans = yes;
589 stats_e_disabled = no;
590 stats_c_oper_only = no;
591 stats_h_oper_only = no;
592 stats_y_oper_only = no;
593 stats_o_oper_only = yes;
594 stats_P_oper_only = no;
595 stats_i_oper_only = masked;
596 stats_k_oper_only = masked;
598 operspy_admin_only = no;
599 operspy_dont_care_user_info = no;
600 caller_id_wait = 1 minute;
601 pace_wait_simple = 1 second;
602 pace_wait = 10 seconds;
605 connect_timeout = 30 seconds;
606 default_ident_timeout = 5;
610 client_flood_max_lines = 20;
611 use_whois_actually = no;
612 oper_only_umodes = operwall, locops, servnotice;
613 oper_umodes = locops, servnotice, operwall, wallop;
616 nick_delay = 0 seconds; # 15 minutes if you want to enable this
617 reject_ban_time = 1 minute;
618 reject_after_count = 3;
619 reject_duration = 5 minutes;
620 throttle_duration = 60;
622 max_ratelimit_tokens = 30;
624 certfp_method = spki_sha256;
625 hide_opers_in_whois = no;
630 path = "modules/autoload";