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/hurt";
27 #loadmodule "extensions/m_extendchans";
28 #loadmodule "extensions/m_findforwards";
29 #loadmodule "extensions/m_identify";
30 #loadmodule "extensions/no_oper_invis";
31 #loadmodule "extensions/sno_farconnect";
32 #loadmodule "extensions/sno_globalkline";
33 #loadmodule "extensions/sno_globalnickchange";
34 #loadmodule "extensions/sno_globaloper";
35 #loadmodule "extensions/sno_whois";
36 #loadmodule "extensions/override";
37 #loadmodule "extensions/no_kill_services";
40 * IP cloaking extensions: use ip_cloaking_4.0
41 * if you're linking 3.2 and later, otherwise use
42 * ip_cloaking, for compatibility with older 3.x
46 #loadmodule "extensions/ip_cloaking_4.0";
47 #loadmodule "extensions/ip_cloaking";
52 description = "charybdis test server";
53 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&dnsbls
199 * dnsbl_exempt | exempt this user from dnsbls
200 * spambot_exempt | exempt this user from spambot checks
201 * shide_exempt | exempt this user from serverhiding
202 * jupe_exempt | exempt this user from generating
203 * warnings joining juped channels
204 * resv_exempt | exempt this user from resvs
205 * flood_exempt | exempt this user from flood limits
207 * no_tilde (old - flag) | don't prefix ~ to username if no ident
208 * need_ident (old + flag) | require ident for user in this class
209 * need_ssl | require SSL/TLS for user in this class
210 * need_sasl | require SASL id for user in this class
212 flags = kline_exempt, exceed_limit;
214 /* class: the class the user is placed in */
223 /* privset {} blocks MUST be specified before anything that uses them. That
224 * means they must be defined before operator {}.
227 privs = oper:local_kill, oper:operwall;
230 privset "server_bot" {
231 extends = "local_op";
232 privs = oper:kline, oper:remoteban, snomask:nick_changes;
235 privset "global_op" {
236 extends = "local_op";
237 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
238 oper:resv, oper:mass_notice, oper:remoteban;
242 extends = "global_op";
243 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
247 /* name: the name of the oper must go above */
249 /* user: the user@host required for this operator. CIDR *is*
250 * supported now. auth{} spoofs work here, other spoofs do not.
251 * multiple user="" lines are supported.
253 user = "*god@127.0.0.1";
255 /* password: the password required to oper. Unless ~encrypted is
256 * contained in flags = ...; this will need to be encrypted using
257 * mkpasswd, MD5 is supported
259 password = "etcnjl8juSU1E";
261 /* rsa key: the public key for this oper when using Challenge.
262 * A password should not be defined when this is used, see
263 * doc/challenge.txt for more information.
265 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
267 /* umodes: the specific umodes this oper gets when they oper.
268 * If this is specified an oper will not be given oper_umodes
269 * These are described above oper_only_umodes in general {};
271 #umodes = locops, servnotice, operwall, wallop;
273 /* fingerprint: if specified, the oper's client certificate
274 * fingerprint will be checked against the specified fingerprint
277 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
279 /* snomask: specific server notice mask on oper up.
280 * If this is specified an oper will not be given oper_snomask.
282 snomask = "+Zbfkrsuy";
284 /* flags: misc options for the operator. You may prefix an option
285 * with ~ to disable it, e.g. ~encrypted.
287 * Default flags are encrypted.
291 * encrypted: the password above is encrypted [DEFAULT]
292 * need_ssl: must be using SSL/TLS to oper up
296 /* privset: privileges set to grant */
300 connect "irc.uplink.com" {
301 host = "203.0.113.3";
302 send_password = "password";
303 accept_password = "anotherpassword";
307 flags = compressed, topicburst;
309 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
311 /* If the connection is IPv6, uncomment below.
312 * Use 0::1, not ::1, for IPv6 localhost. */
316 connect "ssl.uplink.com" {
317 host = "203.0.113.129";
318 send_password = "password";
319 accept_password = "anotherpassword";
323 flags = ssl, topicburst;
327 name = "services.int";
332 flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
340 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
350 knock_delay = 5 minutes;
351 knock_delay_channel = 1 minute;
352 max_chans_per_user = 15;
353 max_chans_per_user_large = 60;
355 max_bans_large = 500;
356 default_split_user_count = 0;
357 default_split_server_count = 0;
358 no_create_on_split = no;
359 no_join_on_split = no;
360 burst_topicwho = yes;
361 kick_on_split_riding = no;
362 only_ascii_channels = no;
363 resv_forcepart = yes;
364 channel_target_change = yes;
365 disable_local_channels = no;
366 autochanmodes = "+nt";
367 displayed_usercount = 3;
368 strip_topic_colors = no;
373 links_delay = 5 minutes;
378 /* These are the blacklist settings.
379 * You can have multiple combinations of host and rejection reasons.
380 * They are used in pairs of one host/rejection reason.
382 * These settings should be adequate for most networks, and are (presently)
383 * required for use on StaticBox.
385 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
388 * As of charybdis 2.2, you can do some keyword substitution on the rejection
389 * reason. The available keyword substitutions are:
391 * ${ip} - the user's IP
392 * ${host} - the user's canonical hostname
393 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
394 * ${nick} - the user's nickname
395 * ${network-name} - the name of the network
397 * As of charybdis 3.4, a type parameter is supported, which specifies the
398 * address families the blacklist supports. IPv4 and IPv6 are supported.
399 * IPv4 is currently the default as few blacklists support IPv6 operation
400 * as of this writing.
402 * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
403 * is considered a match. If included, a comma-separated list of *quoted*
404 * strings is allowed to match queries. They may be of the format "0" to "255"
405 * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
406 * an A record. The blacklist is only applied if it matches anything in the
407 * list. You may freely mix full IP's and final octets.
409 * Consult your blacklist provider for the meaning of these parameters; they
410 * are usually used to denote different ban types.
413 host = "rbl.efnetrbl.org";
415 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
417 /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
418 # host = "foobl.blacklist.invalid";
420 # matches = "4", "6", "127.0.0.10";
421 # 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";
457 hide_error_messages = opers;
458 hide_spoof_ips = yes;
461 * default_umodes: umodes to enable on connect.
462 * If you have enabled the new ip_cloaking_4.0 module, and you want
463 * to make use of it, add +x to this option, i.e.:
464 * default_umodes = "+ix";
466 * If you have enabled the old ip_cloaking module, and you want
467 * to make use of it, add +h to this option, i.e.:
468 * default_umodes = "+ih";
470 default_umodes = "+i";
472 default_operstring = "is an IRC Operator";
473 default_adminstring = "is a Server Administrator";
474 servicestring = "is a Network Service";
477 * Nick of the network's SASL agent. Used to check whether services are here,
478 * SASL credentials are only sent to its server. Needs to be a service.
480 * Defaults to SaslServ if unspecified.
482 sasl_service = "SaslServ";
483 disable_fake_channels = no;
484 tkline_expire_notices = no;
485 default_floodcount = 10;
486 failed_oper_notice = yes;
489 min_nonwildcard_simple = 3;
492 anti_nick_flood = yes;
493 max_nick_time = 20 seconds;
494 max_nick_changes = 5;
495 anti_spam_exit_message_time = 5 minutes;
496 ts_warn_delta = 30 seconds;
497 ts_max_delta = 5 minutes;
501 global_snotices = yes;
502 dline_with_reason = yes;
503 kline_delay = 0 seconds;
504 kline_with_reason = yes;
505 kline_reason = "K-Lined";
506 identify_service = "NickServ@services.int";
507 identify_command = "IDENTIFY";
508 non_redundant_klines = yes;
510 use_propagated_bans = yes;
511 stats_e_disabled = no;
512 stats_c_oper_only=no;
513 stats_h_oper_only=no;
514 stats_y_oper_only=no;
515 stats_o_oper_only=yes;
516 stats_P_oper_only=no;
517 stats_i_oper_only=masked;
518 stats_k_oper_only=masked;
520 operspy_admin_only = no;
521 operspy_dont_care_user_info = no;
522 caller_id_wait = 1 minute;
523 pace_wait_simple = 1 second;
524 pace_wait = 10 seconds;
527 connect_timeout = 30 seconds;
528 default_ident_timeout = 5;
532 client_flood_max_lines = 20;
533 use_whois_actually = no;
534 oper_only_umodes = operwall, locops, servnotice;
535 oper_umodes = locops, servnotice, operwall, wallop;
538 nick_delay = 0 seconds; # 15 minutes if you want to enable this
539 reject_ban_time = 1 minute;
540 reject_after_count = 3;
541 reject_duration = 5 minutes;
542 throttle_duration = 60;
544 max_ratelimit_tokens = 30;
546 certfp_method = sha1;
547 hide_opers_in_whois = no;
552 path = "modules/autoload";