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_operonly_compat";
12 #loadmodule "extensions/chm_quietunreg_compat";
13 #loadmodule "extensions/chm_sslonly_compat";
14 #loadmodule "extensions/chm_operpeace";
15 #loadmodule "extensions/createauthonly";
16 #loadmodule "extensions/extb_account";
17 #loadmodule "extensions/extb_canjoin";
18 #loadmodule "extensions/extb_channel";
19 #loadmodule "extensions/extb_combi";
20 #loadmodule "extensions/extb_extgecos";
21 #loadmodule "extensions/extb_hostmask";
22 #loadmodule "extensions/extb_oper";
23 #loadmodule "extensions/extb_realname";
24 #loadmodule "extensions/extb_server";
25 #loadmodule "extensions/extb_ssl";
26 #loadmodule "extensions/extb_usermode";
27 #loadmodule "extensions/hurt";
28 #loadmodule "extensions/m_extendchans";
29 #loadmodule "extensions/m_findforwards";
30 #loadmodule "extensions/m_identify";
31 #loadmodule "extensions/m_locops";
32 #loadmodule "extensions/no_oper_invis";
33 #loadmodule "extensions/sno_farconnect";
34 #loadmodule "extensions/sno_globalkline";
35 #loadmodule "extensions/sno_globalnickchange";
36 #loadmodule "extensions/sno_globaloper";
37 #loadmodule "extensions/sno_whois";
38 #loadmodule "extensions/override";
39 #loadmodule "extensions/no_kill_services";
42 * IP cloaking extensions: use ip_cloaking_4.0
43 * if you're linking 3.2 and later, otherwise use
44 * ip_cloaking, for compatibility with older 3.x
48 #loadmodule "extensions/ip_cloaking_4.0";
49 #loadmodule "extensions/ip_cloaking";
54 description = "charybdis test server";
55 network_name = "StaticBox";
57 /* On multi-homed hosts you may need the following. These define
58 * the addresses we connect from to other servers. */
62 #vhost6 = "2001:db8:2::6";
64 /* ssl_private_key: our ssl private key */
65 ssl_private_key = "etc/ssl.key";
67 /* ssl_cert: certificate for our ssl server */
68 ssl_cert = "etc/ssl.pem";
70 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 2048
71 * In general, the DH parameters size should be the same as your key's size.
72 * However it has been reported that some clients have broken TLS implementations which may
73 * choke on keysizes larger than 2048-bit, so we would recommend using 2048-bit DH parameters
74 * for now if your keys are larger than 2048-bit.
76 ssl_dh_params = "etc/dh.pem";
78 /* ssld_count: number of ssld processes you want to start, if you
79 * have a really busy server, using N-1 where N is the number of
80 * cpu/cpu cores you have might be useful. A number greater than one
81 * can also be useful in case of bugs in ssld and because ssld needs
82 * two file descriptors per SSL connection.
86 /* default max clients: the default maximum number of clients
87 * allowed to connect. This can be changed once ircd has started by
89 * /quote set maxclients <limit>
91 default_max_clients = 1024;
93 /* nicklen: enforced nickname length (for this server only; must not
94 * be longer than the maximum length set while building).
100 name = "Lazy admin (lazya)";
101 description = "StaticBox client server";
102 email = "nobody@127.0.0.1";
106 fname_userlog = "logs/userlog";
107 #fname_fuserlog = "logs/fuserlog";
108 fname_operlog = "logs/operlog";
109 #fname_foperlog = "logs/foperlog";
110 fname_serverlog = "logs/serverlog";
111 #fname_klinelog = "logs/klinelog";
112 fname_killlog = "logs/killlog";
113 fname_operspylog = "logs/operspylog";
114 #fname_ioerrorlog = "logs/ioerror";
117 /* class {} blocks MUST be specified before anything that uses them. That
118 * means they must be defined before auth {} and before connect {}.
121 ping_time = 2 minutes;
122 number_per_ident = 10;
124 number_per_ip_global = 50;
125 cidr_ipv4_bitlen = 24;
126 cidr_ipv6_bitlen = 64;
127 number_per_cidr = 200;
133 ping_time = 5 minutes;
140 ping_time = 5 minutes;
141 connectfreq = 5 minutes;
147 /* defer_accept: wait for clients to send IRC handshake data before
148 * accepting them. if you intend to use software which depends on the
149 * server replying first, such as BOPM, you should disable this feature.
150 * otherwise, you probably want to leave it on.
154 /* If you want to listen on a specific IP only, specify host.
155 * host definitions apply only to the following port line.
158 port = 5000, 6665 .. 6669;
161 /* Listen on IPv6 (if you used host= above). */
162 #host = "2001:db8:2::6";
163 #port = 5000, 6665 .. 6669;
167 /* auth {}: allow users to connect to the ircd (OLD I:)
168 * auth {} blocks MUST be specified in order of precedence. The first one
169 * that matches a user will be used. So place spoofs first, then specials,
170 * then general access, then restricted.
173 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
174 * lines are permitted per auth block. This is matched against the
175 * hostname and IP address (using :: shortening for IPv6 and
176 * prepending a 0 if it starts with a colon) and can also use CIDR
179 user = "*@198.51.100.0/24";
180 user = "*test@2001:db8:1:*";
182 /* password: an optional password that is required to use this block.
183 * By default this is not encrypted, specify the flag "encrypted" in
184 * flags = ...; below if it is.
186 password = "letmein";
188 /* spoof: fake the users user@host to be be this. You may either
189 * specify a host or a user@host to spoof to. This is free-form,
190 * just do everyone a favour and dont abuse it. (OLD I: = flag)
192 spoof = "I.still.hate.packets";
194 /* Possible flags in auth:
196 * encrypted | password is encrypted with mkpasswd
197 * spoof_notice | give a notice when spoofing hosts
198 * exceed_limit (old > flag) | allow user to exceed class user limits
199 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines,
200 * | dnsbls, and proxies
201 * proxy_exempt | exempt this user from proxies
202 * dnsbl_exempt | exempt this user from dnsbls
203 * spambot_exempt | exempt this user from spambot checks
204 * shide_exempt | exempt this user from serverhiding
205 * jupe_exempt | exempt this user from generating
206 * warnings joining juped channels
207 * resv_exempt | exempt this user from resvs
208 * flood_exempt | exempt this user from flood limits
210 * no_tilde (old - flag) | don't prefix ~ to username if no ident
211 * need_ident (old + flag) | require ident for user in this class
212 * need_ssl | require SSL/TLS for user in this class
213 * need_sasl | require SASL id for user in this class
215 flags = kline_exempt, exceed_limit;
217 /* class: the class the user is placed in */
226 /* privset {} blocks MUST be specified before anything that uses them. That
227 * means they must be defined before operator {}.
230 privs = oper:local_kill, oper:operwall;
233 privset "server_bot" {
234 extends = "local_op";
235 privs = oper:kline, oper:remoteban, snomask:nick_changes;
238 privset "global_op" {
239 extends = "local_op";
240 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
241 oper:resv, oper:mass_notice, oper:remoteban;
245 extends = "global_op";
246 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
250 /* name: the name of the oper must go above */
252 /* user: the user@host required for this operator. CIDR *is*
253 * supported now. auth{} spoofs work here, other spoofs do not.
254 * multiple user="" lines are supported.
256 user = "*god@127.0.0.1";
258 /* password: the password required to oper. Unless ~encrypted is
259 * contained in flags = ...; this will need to be encrypted using
260 * mkpasswd, MD5 is supported
262 password = "etcnjl8juSU1E";
264 /* rsa key: the public key for this oper when using Challenge.
265 * A password should not be defined when this is used, see
266 * doc/challenge.txt for more information.
268 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
270 /* umodes: the specific umodes this oper gets when they oper.
271 * If this is specified an oper will not be given oper_umodes
272 * These are described above oper_only_umodes in general {};
274 #umodes = locops, servnotice, operwall, wallop;
276 /* fingerprint: if specified, the oper's client certificate
277 * fingerprint will be checked against the specified fingerprint
280 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
282 /* snomask: specific server notice mask on oper up.
283 * If this is specified an oper will not be given oper_snomask.
285 snomask = "+Zbfkrsuy";
287 /* flags: misc options for the operator. You may prefix an option
288 * with ~ to disable it, e.g. ~encrypted.
290 * Default flags are encrypted.
294 * encrypted: the password above is encrypted [DEFAULT]
295 * need_ssl: must be using SSL/TLS to oper up
299 /* privset: privileges set to grant */
303 connect "irc.uplink.com" {
304 host = "203.0.113.3";
305 send_password = "password";
306 accept_password = "anotherpassword";
310 flags = compressed, topicburst;
312 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
314 /* If the connection is IPv6, uncomment below.
315 * Use 0::1, not ::1, for IPv6 localhost. */
319 connect "ssl.uplink.com" {
320 host = "203.0.113.129";
321 send_password = "password";
322 accept_password = "anotherpassword";
326 flags = ssl, topicburst;
330 name = "services.int";
335 flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
343 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
353 knock_delay = 5 minutes;
354 knock_delay_channel = 1 minute;
355 max_chans_per_user = 15;
356 max_chans_per_user_large = 60;
358 max_bans_large = 500;
359 default_split_user_count = 0;
360 default_split_server_count = 0;
361 no_create_on_split = no;
362 no_join_on_split = no;
363 burst_topicwho = yes;
364 kick_on_split_riding = no;
365 only_ascii_channels = no;
366 resv_forcepart = yes;
367 channel_target_change = yes;
368 disable_local_channels = no;
369 autochanmodes = "+nt";
370 displayed_usercount = 3;
371 strip_topic_colors = no;
376 links_delay = 5 minutes;
381 /* These are the blacklist settings.
382 * You can have multiple combinations of host and rejection reasons.
383 * They are used in pairs of one host/rejection reason.
385 * These settings should be adequate for most networks.
387 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
390 * As of charybdis 2.2, you can do some keyword substitution on the rejection
391 * reason. The available keyword substitutions are:
393 * ${ip} - the user's IP
394 * ${host} - the user's canonical hostname
395 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
396 * ${nick} - the user's nickname
397 * ${network-name} - the name of the network
399 * As of charybdis 3.4, a type parameter is supported, which specifies the
400 * address families the blacklist supports. IPv4 and IPv6 are supported.
401 * IPv4 is currently the default as few blacklists support IPv6 operation
402 * as of this writing.
404 * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
405 * is considered a match. If included, a comma-separated list of *quoted*
406 * strings is allowed to match queries. They may be of the format "0" to "255"
407 * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
408 * an A record. The blacklist is only applied if it matches anything in the
409 * list. You may freely mix full IP's and final octets.
411 * Consult your blacklist provider for the meaning of these parameters; they
412 * are usually used to denote different ban types.
415 host = "rbl.efnetrbl.org";
417 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
419 /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
420 # host = "foobl.blacklist.invalid";
422 # matches = "4", "6", "127.0.0.10";
423 # 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";
426 /* These are the OPM settings.
427 * This is similar to the functionality provided by BOPM. It will scan incoming
428 * connections for open proxies by connecting to clients and attempting several
429 * different open proxy handshakes. If they connect back to us (via a dedicated
430 * listening port), and send back the data we send them, they are considered
431 * an open proxy. For politeness reasons (users may be confused by the incoming
432 * connection attempts if they are logging incoming connections), the user is
433 * notified upon connect if they are being scanned.
436 * These settings are considered experimental, and as of this writing, the
437 * Charybdis scanner is not as comprehensive as the one available in HOPM. Only
438 * basic SOCKS4 and SOCKS5 scanning is performed on a few well-known ports. You
439 * may disable the open proxy scanning feature by deleting this block if you are
440 * uncomfortable with this.
443 /* IPv4 address to listen on. This must be a publicly facing IP address
445 * If omitted, it defaults to serverinfo::vhost.
447 #listen_ipv4 = "127.0.0.1";
449 /* IPv4 port to listen on.
450 * This should not be the same as any existing listeners.
454 /* IPv6 address to listen on. This must be a publicly facing IP address
456 * If omitted, it defaults to serverinfo::vhost6.
458 #listen_ipv6 = "0::1";
460 /* IPv6 port to listen on.
461 * This should not be the same as any existing listeners.
465 /* You can also set the listen_port directive which will set both the
466 * IPv4 and IPv6 ports at once.
470 /* This sets the timeout in seconds before ending open proxy scans.
471 * Values less than 1 or greater than 60 are ignored.
472 * It is advisable to keep it as short as feasible, so clients do not
473 * get held up by excessively long scan times.
477 /* These are the ports to scan for SOCKS4 proxies on. They may overlap
478 * with other scan types. Sensible defaults are given below.
480 socks4_ports = 1080, 10800, 443, 80, 8080, 8000;
482 /* These are the ports to scan for SOCKS5 proxies on. They may overlap
483 * with other scan types. Sensible defaults are given below.
485 socks5_ports = 1080, 10800, 443, 80, 8080, 8000;
487 /* These are the ports to scan for HTTP connect proxies on (plaintext).
488 * They may overlap with other scan types. Sensible defaults are given
491 httpconnect_ports = 80, 8080, 8000;
493 /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
494 * They may overlap with other scan types. Sensible defaults are given
497 httpsconnect_ports = 443, 4443;
533 hide_error_messages = opers;
534 hide_spoof_ips = yes;
537 * default_umodes: umodes to enable on connect.
538 * If you have enabled the new ip_cloaking_4.0 module, and you want
539 * to make use of it, add +x to this option, i.e.:
540 * default_umodes = "+ix";
542 * If you have enabled the old ip_cloaking module, and you want
543 * to make use of it, add +h to this option, i.e.:
544 * default_umodes = "+ih";
546 default_umodes = "+i";
548 default_operstring = "is an IRC Operator";
549 default_adminstring = "is a Server Administrator";
550 servicestring = "is a Network Service";
553 * Nick of the network's SASL agent. Used to check whether services are here,
554 * SASL credentials are only sent to its server. Needs to be a service.
556 * Defaults to SaslServ if unspecified.
558 sasl_service = "SaslServ";
559 disable_fake_channels = no;
560 tkline_expire_notices = no;
561 default_floodcount = 10;
562 failed_oper_notice = yes;
565 min_nonwildcard_simple = 3;
568 anti_nick_flood = yes;
569 max_nick_time = 20 seconds;
570 max_nick_changes = 5;
571 anti_spam_exit_message_time = 5 minutes;
572 ts_warn_delta = 30 seconds;
573 ts_max_delta = 5 minutes;
577 global_snotices = yes;
578 dline_with_reason = yes;
579 kline_delay = 0 seconds;
580 kline_with_reason = yes;
581 kline_reason = "K-Lined";
582 identify_service = "NickServ@services.int";
583 identify_command = "IDENTIFY";
584 non_redundant_klines = yes;
586 use_propagated_bans = yes;
587 stats_e_disabled = no;
588 stats_c_oper_only=no;
589 stats_h_oper_only=no;
590 stats_y_oper_only=no;
591 stats_o_oper_only=yes;
592 stats_P_oper_only=no;
593 stats_i_oper_only=masked;
594 stats_k_oper_only=masked;
596 operspy_admin_only = no;
597 operspy_dont_care_user_info = no;
598 caller_id_wait = 1 minute;
599 pace_wait_simple = 1 second;
600 pace_wait = 10 seconds;
603 connect_timeout = 30 seconds;
604 default_ident_timeout = 5;
608 client_flood_max_lines = 20;
609 use_whois_actually = no;
610 oper_only_umodes = operwall, locops, servnotice;
611 oper_umodes = locops, servnotice, operwall, wallop;
614 nick_delay = 0 seconds; # 15 minutes if you want to enable this
615 reject_ban_time = 1 minute;
616 reject_after_count = 3;
617 reject_duration = 5 minutes;
618 throttle_duration = 60;
620 max_ratelimit_tokens = 30;
622 certfp_method = sha1;
623 hide_opers_in_whois = no;
628 path = "modules/autoload";