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/no_oper_invis";
32 #loadmodule "extensions/sno_farconnect";
33 #loadmodule "extensions/sno_globalkline";
34 #loadmodule "extensions/sno_globalnickchange";
35 #loadmodule "extensions/sno_globaloper";
36 #loadmodule "extensions/sno_whois";
37 #loadmodule "extensions/override";
38 #loadmodule "extensions/no_kill_services";
41 * IP cloaking extensions: use ip_cloaking_4.0
42 * if you're linking 3.2 and later, otherwise use
43 * ip_cloaking, for compatibility with older 3.x
47 #loadmodule "extensions/ip_cloaking_4.0";
48 #loadmodule "extensions/ip_cloaking";
53 description = "charybdis test server";
54 network_name = "StaticBox";
56 /* On multi-homed hosts you may need the following. These define
57 * the addresses we connect from to other servers. */
61 #vhost6 = "2001:db8:2::6";
63 /* ssl_private_key: our ssl private key */
64 ssl_private_key = "etc/ssl.key";
66 /* ssl_cert: certificate for our ssl server */
67 ssl_cert = "etc/ssl.pem";
69 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 2048
70 * In general, the DH parameters size should be the same as your key's size.
71 * However it has been reported that some clients have broken TLS implementations which may
72 * choke on keysizes larger than 2048-bit, so we would recommend using 2048-bit DH parameters
73 * for now if your keys are larger than 2048-bit.
75 ssl_dh_params = "etc/dh.pem";
77 /* ssld_count: number of ssld processes you want to start, if you
78 * have a really busy server, using N-1 where N is the number of
79 * cpu/cpu cores you have might be useful. A number greater than one
80 * can also be useful in case of bugs in ssld and because ssld needs
81 * two file descriptors per SSL connection.
85 /* default max clients: the default maximum number of clients
86 * allowed to connect. This can be changed once ircd has started by
88 * /quote set maxclients <limit>
90 default_max_clients = 1024;
92 /* nicklen: enforced nickname length (for this server only; must not
93 * be longer than the maximum length set while building).
99 name = "Lazy admin (lazya)";
100 description = "StaticBox client server";
101 email = "nobody@127.0.0.1";
105 fname_userlog = "logs/userlog";
106 #fname_fuserlog = "logs/fuserlog";
107 fname_operlog = "logs/operlog";
108 #fname_foperlog = "logs/foperlog";
109 fname_serverlog = "logs/serverlog";
110 #fname_klinelog = "logs/klinelog";
111 fname_killlog = "logs/killlog";
112 fname_operspylog = "logs/operspylog";
113 #fname_ioerrorlog = "logs/ioerror";
116 /* class {} blocks MUST be specified before anything that uses them. That
117 * means they must be defined before auth {} and before connect {}.
120 ping_time = 2 minutes;
121 number_per_ident = 10;
123 number_per_ip_global = 50;
124 cidr_ipv4_bitlen = 24;
125 cidr_ipv6_bitlen = 64;
126 number_per_cidr = 200;
132 ping_time = 5 minutes;
139 ping_time = 5 minutes;
140 connectfreq = 5 minutes;
146 /* defer_accept: wait for clients to send IRC handshake data before
147 * accepting them. if you intend to use software which depends on the
148 * server replying first, such as BOPM, you should disable this feature.
149 * otherwise, you probably want to leave it on.
153 /* If you want to listen on a specific IP only, specify host.
154 * host definitions apply only to the following port line.
157 port = 5000, 6665 .. 6669;
160 /* Listen on IPv6 (if you used host= above). */
161 #host = "2001:db8:2::6";
162 #port = 5000, 6665 .. 6669;
166 /* auth {}: allow users to connect to the ircd (OLD I:)
167 * auth {} blocks MUST be specified in order of precedence. The first one
168 * that matches a user will be used. So place spoofs first, then specials,
169 * then general access, then restricted.
172 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
173 * lines are permitted per auth block. This is matched against the
174 * hostname and IP address (using :: shortening for IPv6 and
175 * prepending a 0 if it starts with a colon) and can also use CIDR
178 user = "*@198.51.100.0/24";
179 user = "*test@2001:db8:1:*";
181 /* password: an optional password that is required to use this block.
182 * By default this is not encrypted, specify the flag "encrypted" in
183 * flags = ...; below if it is.
185 password = "letmein";
187 /* spoof: fake the users user@host to be be this. You may either
188 * specify a host or a user@host to spoof to. This is free-form,
189 * just do everyone a favour and dont abuse it. (OLD I: = flag)
191 spoof = "I.still.hate.packets";
193 /* Possible flags in auth:
195 * encrypted | password is encrypted with mkpasswd
196 * spoof_notice | give a notice when spoofing hosts
197 * exceed_limit (old > flag) | allow user to exceed class user limits
198 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines,
199 * | dnsbls, and proxies
200 * proxy_exempt | exempt this user from proxies
201 * dnsbl_exempt | exempt this user from dnsbls
202 * spambot_exempt | exempt this user from spambot checks
203 * shide_exempt | exempt this user from serverhiding
204 * jupe_exempt | exempt this user from generating
205 * warnings joining juped channels
206 * resv_exempt | exempt this user from resvs
207 * flood_exempt | exempt this user from flood limits
209 * no_tilde (old - flag) | don't prefix ~ to username if no ident
210 * need_ident (old + flag) | require ident for user in this class
211 * need_ssl | require SSL/TLS for user in this class
212 * need_sasl | require SASL id for user in this class
214 flags = kline_exempt, exceed_limit;
216 /* class: the class the user is placed in */
225 /* privset {} blocks MUST be specified before anything that uses them. That
226 * means they must be defined before operator {}.
229 privs = oper:local_kill, oper:operwall;
232 privset "server_bot" {
233 extends = "local_op";
234 privs = oper:kline, oper:remoteban, snomask:nick_changes;
237 privset "global_op" {
238 extends = "local_op";
239 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
240 oper:resv, oper:mass_notice, oper:remoteban;
244 extends = "global_op";
245 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
249 /* name: the name of the oper must go above */
251 /* user: the user@host required for this operator. CIDR *is*
252 * supported now. auth{} spoofs work here, other spoofs do not.
253 * multiple user="" lines are supported.
255 user = "*god@127.0.0.1";
257 /* password: the password required to oper. Unless ~encrypted is
258 * contained in flags = ...; this will need to be encrypted using
259 * mkpasswd, MD5 is supported
261 password = "etcnjl8juSU1E";
263 /* rsa key: the public key for this oper when using Challenge.
264 * A password should not be defined when this is used, see
265 * doc/challenge.txt for more information.
267 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
269 /* umodes: the specific umodes this oper gets when they oper.
270 * If this is specified an oper will not be given oper_umodes
271 * These are described above oper_only_umodes in general {};
273 #umodes = locops, servnotice, operwall, wallop;
275 /* fingerprint: if specified, the oper's client certificate
276 * fingerprint will be checked against the specified fingerprint
279 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
281 /* snomask: specific server notice mask on oper up.
282 * If this is specified an oper will not be given oper_snomask.
284 snomask = "+Zbfkrsuy";
286 /* flags: misc options for the operator. You may prefix an option
287 * with ~ to disable it, e.g. ~encrypted.
289 * Default flags are encrypted.
293 * encrypted: the password above is encrypted [DEFAULT]
294 * need_ssl: must be using SSL/TLS to oper up
298 /* privset: privileges set to grant */
302 connect "irc.uplink.com" {
303 host = "203.0.113.3";
304 send_password = "password";
305 accept_password = "anotherpassword";
309 flags = compressed, topicburst;
311 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
313 /* If the connection is IPv6, uncomment below.
314 * Use 0::1, not ::1, for IPv6 localhost. */
318 connect "ssl.uplink.com" {
319 host = "203.0.113.129";
320 send_password = "password";
321 accept_password = "anotherpassword";
325 flags = ssl, topicburst;
329 name = "services.int";
334 flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
342 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
352 knock_delay = 5 minutes;
353 knock_delay_channel = 1 minute;
354 max_chans_per_user = 15;
355 max_chans_per_user_large = 60;
357 max_bans_large = 500;
358 default_split_user_count = 0;
359 default_split_server_count = 0;
360 no_create_on_split = no;
361 no_join_on_split = no;
362 burst_topicwho = yes;
363 kick_on_split_riding = no;
364 only_ascii_channels = no;
365 resv_forcepart = yes;
366 channel_target_change = yes;
367 disable_local_channels = no;
368 autochanmodes = "+nt";
369 displayed_usercount = 3;
370 strip_topic_colors = no;
375 links_delay = 5 minutes;
380 /* These are the blacklist settings.
381 * You can have multiple combinations of host and rejection reasons.
382 * They are used in pairs of one host/rejection reason.
384 * These settings should be adequate for most networks.
386 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
389 * As of charybdis 2.2, you can do some keyword substitution on the rejection
390 * reason. The available keyword substitutions are:
392 * ${ip} - the user's IP
393 * ${host} - the user's canonical hostname
394 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
395 * ${nick} - the user's nickname
396 * ${network-name} - the name of the network
398 * As of charybdis 3.4, a type parameter is supported, which specifies the
399 * address families the blacklist supports. IPv4 and IPv6 are supported.
400 * IPv4 is currently the default as few blacklists support IPv6 operation
401 * as of this writing.
403 * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
404 * is considered a match. If included, a comma-separated list of *quoted*
405 * strings is allowed to match queries. They may be of the format "0" to "255"
406 * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
407 * an A record. The blacklist is only applied if it matches anything in the
408 * list. You may freely mix full IP's and final octets.
410 * Consult your blacklist provider for the meaning of these parameters; they
411 * are usually used to denote different ban types.
414 host = "rbl.efnetrbl.org";
416 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
418 /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
419 # host = "foobl.blacklist.invalid";
421 # matches = "4", "6", "127.0.0.10";
422 # 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";
425 /* These are the OPM settings.
426 * This is similar to the functionality provided by BOPM. It will scan incoming
427 * connections for open proxies by connecting to clients and attempting several
428 * different open proxy handshakes. If they connect back to us (via a dedicated
429 * listening port), and send back the data we send them, they are considered
430 * an open proxy. For politeness reasons (users may be confused by the incoming
431 * connection attempts if they are logging incoming connections), the user is
432 * notified upon connect if they are being scanned.
435 * These settings are considered experimental, and as of this writing, the
436 * Charybdis scanner is not as comprehensive as the one available in HOPM. Only
437 * basic SOCKS4 and SOCKS5 scanning is performed on a few well-known ports. You
438 * may disable the open proxy scanning feature by deleting this block if you are
439 * uncomfortable with this.
442 /* IPv4 address to listen on. This must be a publicly facing IP address
444 * If omitted, it defaults to serverinfo::vhost.
446 #listen_ipv4 = "127.0.0.1";
448 /* IPv4 port to listen on.
449 * This should not be the same as any existing listeners.
453 /* IPv6 address to listen on. This must be a publicly facing IP address
455 * If omitted, it defaults to serverinfo::vhost6.
457 #listen_ipv6 = "0::1";
459 /* IPv6 port to listen on.
460 * This should not be the same as any existing listeners.
464 /* You can also set a port directive which will set both the IPv4 and
465 * IPv6 ports at once.
469 /* These are the ports to scan for SOCKS4 proxies on. They may overlap
470 * with other scan types. Sensible defaults are given below.
472 socks4_ports = 1080, 10800, 443, 80, 8080, 8000;
474 /* These are the ports to scan for SOCKS5 proxies on. They may overlap
475 * with other scan types. Sensible defaults are given below.
477 socks5_ports = 1080, 10800, 443, 80, 8080, 8000;
479 /* These are the ports to scan for HTTP connect proxies on (plaintext).
480 * They may overlap with other scan types. Sensible defaults are given
483 httpconnect_ports = 80, 8080, 8000;
519 hide_error_messages = opers;
520 hide_spoof_ips = yes;
523 * default_umodes: umodes to enable on connect.
524 * If you have enabled the new ip_cloaking_4.0 module, and you want
525 * to make use of it, add +x to this option, i.e.:
526 * default_umodes = "+ix";
528 * If you have enabled the old ip_cloaking module, and you want
529 * to make use of it, add +h to this option, i.e.:
530 * default_umodes = "+ih";
532 default_umodes = "+i";
534 default_operstring = "is an IRC Operator";
535 default_adminstring = "is a Server Administrator";
536 servicestring = "is a Network Service";
539 * Nick of the network's SASL agent. Used to check whether services are here,
540 * SASL credentials are only sent to its server. Needs to be a service.
542 * Defaults to SaslServ if unspecified.
544 sasl_service = "SaslServ";
545 disable_fake_channels = no;
546 tkline_expire_notices = no;
547 default_floodcount = 10;
548 failed_oper_notice = yes;
551 min_nonwildcard_simple = 3;
554 anti_nick_flood = yes;
555 max_nick_time = 20 seconds;
556 max_nick_changes = 5;
557 anti_spam_exit_message_time = 5 minutes;
558 ts_warn_delta = 30 seconds;
559 ts_max_delta = 5 minutes;
563 global_snotices = yes;
564 dline_with_reason = yes;
565 kline_delay = 0 seconds;
566 kline_with_reason = yes;
567 kline_reason = "K-Lined";
568 identify_service = "NickServ@services.int";
569 identify_command = "IDENTIFY";
570 non_redundant_klines = yes;
572 use_propagated_bans = yes;
573 stats_e_disabled = no;
574 stats_c_oper_only=no;
575 stats_h_oper_only=no;
576 stats_y_oper_only=no;
577 stats_o_oper_only=yes;
578 stats_P_oper_only=no;
579 stats_i_oper_only=masked;
580 stats_k_oper_only=masked;
582 operspy_admin_only = no;
583 operspy_dont_care_user_info = no;
584 caller_id_wait = 1 minute;
585 pace_wait_simple = 1 second;
586 pace_wait = 10 seconds;
589 connect_timeout = 30 seconds;
590 default_ident_timeout = 5;
594 client_flood_max_lines = 20;
595 use_whois_actually = no;
596 oper_only_umodes = operwall, locops, servnotice;
597 oper_umodes = locops, servnotice, operwall, wallop;
600 nick_delay = 0 seconds; # 15 minutes if you want to enable this
601 reject_ban_time = 1 minute;
602 reject_after_count = 3;
603 reject_duration = 5 minutes;
604 throttle_duration = 60;
606 max_ratelimit_tokens = 30;
608 certfp_method = sha1;
609 hide_opers_in_whois = no;
614 path = "modules/autoload";