]> jfr.im git - solanum.git/blame - doc/example.conf
Fix double-free when removing a ban.
[solanum.git] / doc / example.conf
CommitLineData
212380e3
AC
1/* doc/example.conf - brief example configuration file
2 *
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
6 *
407b1826 7 * $Id: example.conf 3582 2007-11-17 21:55:48Z jilles $
212380e3
AC
8 *
9 * See reference.conf for more information.
10 */
11
12/* Extensions */
dbbe26fa
VY
13#loadmodule "extensions/chm_operonly_compat.so";
14#loadmodule "extensions/chm_quietunreg_compat.so";
15#loadmodule "extensions/chm_sslonly_compat.so";
212380e3
AC
16#loadmodule "extensions/createauthonly.so";
17#loadmodule "extensions/extb_account.so";
18#loadmodule "extensions/extb_canjoin.so";
19#loadmodule "extensions/extb_channel.so";
20#loadmodule "extensions/extb_extgecos.so";
21#loadmodule "extensions/extb_oper.so";
22#loadmodule "extensions/extb_realname.so";
23#loadmodule "extensions/extb_server.so";
dbbe26fa 24#loadmodule "extensions/extb_ssl.so";
212380e3 25#loadmodule "extensions/hurt.so";
212380e3
AC
26#loadmodule "extensions/m_findforwards.so";
27#loadmodule "extensions/m_identify.so";
28#loadmodule "extensions/no_oper_invis.so";
29#loadmodule "extensions/sno_farconnect.so";
30#loadmodule "extensions/sno_globalkline.so";
31#loadmodule "extensions/sno_globaloper.so";
446d88dd 32#loadmodule "extensions/sno_whois.so";
429cf1b7 33#loadmodule "extensions/override.so";
212380e3 34
a8560aff
AC
35/*
36 * IP cloaking extensions: use ip_cloaking_4.0
37 * if you're linking 3.2 and later, otherwise use
38 * ip_cloaking.so, for compatibility with older 3.x
39 * releases.
40 */
41
42#loadmodule "extensions/ip_cloaking_4.0.so";
43#loadmodule "extensions/ip_cloaking.so";
44
212380e3
AC
45serverinfo {
46 name = "hades.arpa";
212380e3
AC
47 sid = "42X";
48 description = "charybdis test server";
765d839d 49 network_name = "StaticBox";
212380e3
AC
50 network_desc = "Your IRC network.";
51 hub = yes;
52
53 /* On multi-homed hosts you may need the following. These define
54 * the addresses we connect from to other servers. */
55 /* for IPv4 */
56 #vhost = "192.169.0.1";
57 /* for IPv6 */
58 #vhost6 = "3ffe:80e8:546::2";
c6d72037 59
b8730cbf 60 /* ssl_private_key: our ssl private key */
f1e5a317 61 ssl_private_key = "etc/ssl.key";
b8730cbf
VY
62
63 /* ssl_cert: certificate for our ssl server */
f1e5a317 64 ssl_cert = "etc/ssl.cert";
b8730cbf
VY
65
66 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
67 ssl_dh_params = "etc/dh.pem";
68
fa1a7bef
JT
69 /* ssld_count: number of ssld processes you want to start, if you
70 * have a really busy server, using N-1 where N is the number of
71 * cpu/cpu cores you have might be useful. A number greater than one
72 * can also be useful in case of bugs in ssld and because ssld needs
73 * two file descriptors per SSL connection.
b8730cbf
VY
74 */
75 ssld_count = 1;
76
77 /* default max clients: the default maximum number of clients
78 * allowed to connect. This can be changed once ircd has started by
79 * issuing:
80 * /quote set maxclients <limit>
c2d96fcb 81 */
101db4c4 82 default_max_clients = 1024;
212380e3
AC
83};
84
85admin {
86 name = "Lazy admin (lazya)";
765d839d 87 description = "StaticBox client server";
212380e3
AC
88 email = "nobody@127.0.0.1";
89};
90
91log {
92 fname_userlog = "logs/userlog";
93 #fname_fuserlog = "logs/fuserlog";
94 fname_operlog = "logs/operlog";
95 #fname_foperlog = "logs/foperlog";
96 fname_serverlog = "logs/serverlog";
212380e3
AC
97 #fname_klinelog = "logs/klinelog";
98 fname_killlog = "logs/killlog";
99 fname_operspylog = "logs/operspylog";
100 #fname_ioerrorlog = "logs/ioerror";
101};
102
103/* class {} blocks MUST be specified before anything that uses them. That
104 * means they must be defined before auth {} and before connect {}.
105 */
106class "users" {
107 ping_time = 2 minutes;
dffb83aa
JT
108 number_per_ident = 10;
109 number_per_ip = 10;
110 number_per_ip_global = 50;
e33e589c
JT
111 cidr_ipv4_bitlen = 24;
112 cidr_ipv6_bitlen = 64;
dffb83aa 113 number_per_cidr = 200;
212380e3
AC
114 max_number = 3000;
115 sendq = 400 kbytes;
116};
117
118class "opers" {
119 ping_time = 5 minutes;
120 number_per_ip = 10;
121 max_number = 1000;
122 sendq = 1 megabyte;
123};
124
125class "server" {
126 ping_time = 5 minutes;
127 connectfreq = 5 minutes;
128 max_number = 1;
129 sendq = 4 megabytes;
130};
131
132listen {
133 /* If you want to listen on a specific IP only, specify host.
134 * host definitions apply only to the following port line.
135 */
136 #host = "192.169.0.1";
137 port = 5000, 6665 .. 6669;
f42c7be6 138 sslport = 6697;
212380e3
AC
139
140 /* Listen on IPv6 (if you used host= above). */
141 #host = "3ffe:1234:a:b:c::d";
da1b891f
KB
142 #port = 5000, 6665 .. 6669;
143 #sslport = 9999;
212380e3
AC
144};
145
146/* auth {}: allow users to connect to the ircd (OLD I:)
147 * auth {} blocks MUST be specified in order of precedence. The first one
148 * that matches a user will be used. So place spoofs first, then specials,
149 * then general access, then restricted.
150 */
151auth {
b0dc8e03
JT
152 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
153 * lines are permitted per auth block. This is matched against the
154 * hostname and IP address (using :: shortening for IPv6 and
155 * prepending a 0 if it starts with a colon) and can also use CIDR
156 * masks.
212380e3
AC
157 */
158 user = "*@172.16.0.0/12";
159 user = "*test@123D:B567:*";
160
161 /* password: an optional password that is required to use this block.
162 * By default this is not encrypted, specify the flag "encrypted" in
163 * flags = ...; below if it is.
164 */
165 password = "letmein";
166
167 /* spoof: fake the users user@host to be be this. You may either
168 * specify a host or a user@host to spoof to. This is free-form,
169 * just do everyone a favour and dont abuse it. (OLD I: = flag)
170 */
da1b891f 171 spoof = "I.still.hate.packets";
212380e3
AC
172
173 /* Possible flags in auth:
174 *
175 * encrypted | password is encrypted with mkpasswd
176 * spoof_notice | give a notice when spoofing hosts
177 * exceed_limit (old > flag) | allow user to exceed class user limits
178 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
179 * dnsbl_exempt | exempt this user from dnsbls
212380e3
AC
180 * spambot_exempt | exempt this user from spambot checks
181 * shide_exempt | exempt this user from serverhiding
182 * jupe_exempt | exempt this user from generating
183 * warnings joining juped channels
184 * resv_exempt | exempt this user from resvs
da1b891f
KB
185 * flood_exempt | exempt this user from flood limits
186 * USE WITH CAUTION.
212380e3
AC
187 * no_tilde (old - flag) | don't prefix ~ to username if no ident
188 * need_ident (old + flag) | require ident for user in this class
3e664be3 189 * need_ssl | require SSL/TLS for user in this class
212380e3
AC
190 * need_sasl | require SASL id for user in this class
191 */
192 flags = kline_exempt, exceed_limit;
193
194 /* class: the class the user is placed in */
195 class = "opers";
196};
197
198auth {
199 user = "*@*";
200 class = "users";
201};
202
da77b103
JT
203/* privset {} blocks MUST be specified before anything that uses them. That
204 * means they must be defined before operator {}.
205 */
be525828
AC
206privset "local_op" {
207 privs = oper:local_kill, oper:operwall;
208};
209
b5010970
AC
210privset "server_bot" {
211 extends = "local_op";
d9e7ca49 212 privs = oper:kline, oper:remoteban, snomask:nick_changes;
b5010970
AC
213};
214
be525828
AC
215privset "global_op" {
216 extends = "local_op";
217 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
477dc2e9 218 oper:resv, oper:mass_notice, oper:remoteban;
be525828
AC
219};
220
221privset "admin" {
222 extends = "global_op";
3fe1c728 223 privs = oper:admin, oper:die, oper:rehash, oper:spy;
be525828
AC
224};
225
212380e3
AC
226operator "god" {
227 /* name: the name of the oper must go above */
228
229 /* user: the user@host required for this operator. CIDR *is*
230 * supported now. auth{} spoofs work here, other spoofs do not.
231 * multiple user="" lines are supported.
232 */
233 user = "*god@127.0.0.1";
234
235 /* password: the password required to oper. Unless ~encrypted is
236 * contained in flags = ...; this will need to be encrypted using
237 * mkpasswd, MD5 is supported
238 */
239 password = "etcnjl8juSU1E";
240
241 /* rsa key: the public key for this oper when using Challenge.
242 * A password should not be defined when this is used, see
243 * doc/challenge.txt for more information.
244 */
245 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
246
247 /* umodes: the specific umodes this oper gets when they oper.
248 * If this is specified an oper will not be given oper_umodes
249 * These are described above oper_only_umodes in general {};
250 */
251 #umodes = locops, servnotice, operwall, wallop;
252
ff31db84
AC
253 /* fingerprint: if specified, the oper's client certificate
254 * fingerprint will be checked against the specified fingerprint
255 * below.
256 */
257 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
258
212380e3
AC
259 /* snomask: specific server notice mask on oper up.
260 * If this is specified an oper will not be given oper_snomask.
261 */
262 snomask = "+Zbfkrsuy";
263
da77b103
JT
264 /* flags: misc options for the operator. You may prefix an option
265 * with ~ to disable it, e.g. ~encrypted.
212380e3 266 *
10847f65 267 * Default flags are encrypted.
212380e3
AC
268 *
269 * Available options:
270 *
271 * encrypted: the password above is encrypted [DEFAULT]
3e664be3 272 * need_ssl: must be using SSL/TLS to oper up
da1b891f 273 */
da77b103 274 flags = encrypted;
be525828 275
da77b103 276 /* privset: privileges set to grant */
be525828 277 privset = "admin";
212380e3
AC
278};
279
280connect "irc.uplink.com" {
281 host = "192.168.0.1";
282 send_password = "password";
283 accept_password = "anotherpassword";
284 port = 6666;
285 hub_mask = "*";
286 class = "server";
287 flags = compressed, topicburst;
288
ff0cc1e6
AC
289 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
290
b0dc8e03
JT
291 /* If the connection is IPv6, uncomment below.
292 * Use 0::1, not ::1, for IPv6 localhost. */
212380e3
AC
293 #aftype = ipv6;
294};
295
b8730cbf
VY
296connect "ssl.uplink.com" {
297 host = "192.168.0.1";
298 send_password = "password";
299 accept_password = "anotherpassword";
300 port = 9999;
301 hub_mask = "*";
302 class = "server";
303 flags = ssl, topicburst;
304};
305
212380e3
AC
306service {
307 name = "services.int";
308};
309
310cluster {
311 name = "*";
312 flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
313};
314
315shared {
316 oper = "*@*", "*";
317 flags = all, rehash;
318};
319
b808adf9 320/* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
212380e3
AC
321exempt {
322 ip = "127.0.0.1";
323};
324
325channel {
326 use_invex = yes;
327 use_except = yes;
328 use_knock = yes;
212380e3
AC
329 knock_delay = 5 minutes;
330 knock_delay_channel = 1 minute;
331 max_chans_per_user = 15;
da1b891f
KB
332 max_bans = 100;
333 max_bans_large = 500;
212380e3
AC
334 default_split_user_count = 0;
335 default_split_server_count = 0;
336 no_create_on_split = no;
337 no_join_on_split = no;
338 burst_topicwho = yes;
339 kick_on_split_riding = no;
6865c0b0 340 only_ascii_channels = no;
c2c25552 341 resv_forcepart = yes;
717238d2 342 channel_target_change = yes;
341f971e 343 disable_local_channels = no;
212380e3
AC
344};
345
346serverhide {
347 flatten_links = yes;
348 links_delay = 5 minutes;
da1b891f 349 hidden = no;
212380e3
AC
350 disable_hidden = no;
351};
352
353/* These are the blacklist settings.
354 * You can have multiple combinations of host and rejection reasons.
b2324470 355 * They are used in pairs of one host/rejection reason.
212380e3
AC
356 *
357 * These settings should be adequate for most networks, and are (presently)
765d839d 358 * required for use on StaticBox.
212380e3
AC
359 *
360 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
361 * connections.
362 *
0a1e77c2 363 * As of charybdis 2.2, you can do some keyword substitution on the rejection
92fb5c31
AC
364 * reason. The available keyword substitutions are:
365 *
366 * ${ip} - the user's IP
367 * ${host} - the user's canonical hostname
368 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
369 * ${nick} - the user's nickname
370 * ${network-name} - the name of the network
371 *
0a1e77c2
EM
372 * As of charybdis 3.4, a type parameter is supported, which specifies the
373 * address families the blacklist supports. IPv4 and IPv6 are supported.
374 * IPv4 is currently the default as few blacklists support IPv6 operation
375 * as of this writing.
376 *
57b8cb0f 377 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
212380e3
AC
378 * contacted, via email, at admins@2mbit.com before using these BLs.
379 * See <http://www.ahbl.org/services.php> for more information.
380 */
57b8cb0f 381blacklist {
40e92fca 382 host = "rbl.efnetrbl.org";
0a1e77c2 383 type = ipv4;
40e92fca 384 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
57b8cb0f 385
212380e3 386# host = "ircbl.ahbl.org";
0a1e77c2 387# type = ipv4;
92fb5c31 388# reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for having an open proxy. In order to protect ${network-name} from abuse, we are not allowing connections with open proxies to connect.";
212380e3
AC
389#
390# host = "tor.ahbl.org";
0a1e77c2 391# type = ipv4;
92fb5c31 392# reject_reason = "${nick}, your IP (${ip}) is listed as a TOR exit node. In order to protect ${network-name} from tor-based abuse, we are not allowing TOR exit nodes to connect to our network.";
0a1e77c2
EM
393#
394 /* Example of a blacklist that supports both IPv4 and IPv6 */
395# host = "foobl.blacklist.invalid";
396# type = ipv4, ipv6;
397# 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";
57b8cb0f 398};
212380e3
AC
399
400alias "NickServ" {
401 target = "NickServ";
402};
403
404alias "ChanServ" {
405 target = "ChanServ";
406};
407
408alias "OperServ" {
409 target = "OperServ";
410};
411
412alias "MemoServ" {
413 target = "MemoServ";
414};
415
416alias "NS" {
417 target = "NickServ";
418};
419
420alias "CS" {
421 target = "ChanServ";
422};
423
424alias "OS" {
425 target = "OperServ";
426};
427
428alias "MS" {
429 target = "MemoServ";
430};
431
432general {
433 hide_error_messages = opers;
434 hide_spoof_ips = yes;
435
436 /*
437 * default_umodes: umodes to enable on connect.
a8560aff
AC
438 * If you have enabled the new ip_cloaking_4.0 module, and you want
439 * to make use of it, add +x to this option, i.e.:
440 * default_umodes = "+ix";
441 *
442 * If you have enabled the old ip_cloaking module, and you want
212380e3
AC
443 * to make use of it, add +h to this option, i.e.:
444 * default_umodes = "+ih";
445 */
446 default_umodes = "+i";
447
448 default_operstring = "is an IRC Operator";
449 default_adminstring = "is a Server Administrator";
450 servicestring = "is a Network Service";
451 disable_fake_channels = no;
da1b891f
KB
452 tkline_expire_notices = no;
453 default_floodcount = 10;
212380e3
AC
454 failed_oper_notice = yes;
455 dots_in_ident=2;
212380e3
AC
456 min_nonwildcard = 4;
457 min_nonwildcard_simple = 3;
da1b891f 458 max_accept = 100;
212380e3
AC
459 max_monitor = 100;
460 anti_nick_flood = yes;
461 max_nick_time = 20 seconds;
462 max_nick_changes = 5;
da1b891f 463 anti_spam_exit_message_time = 5 minutes;
212380e3
AC
464 ts_warn_delta = 30 seconds;
465 ts_max_delta = 5 minutes;
466 client_exit = yes;
467 collision_fnc = yes;
468 global_snotices = yes;
469 dline_with_reason = yes;
470 kline_delay = 0 seconds;
471 kline_with_reason = yes;
472 kline_reason = "K-Lined";
473 identify_service = "NickServ@services.int";
474 identify_command = "IDENTIFY";
475 non_redundant_klines = yes;
476 warn_no_nline = yes;
1702b694 477 use_propagated_bans = yes;
212380e3
AC
478 stats_e_disabled = no;
479 stats_c_oper_only=no;
480 stats_h_oper_only=no;
481 stats_y_oper_only=no;
482 stats_o_oper_only=yes;
483 stats_P_oper_only=no;
484 stats_i_oper_only=masked;
485 stats_k_oper_only=masked;
da1b891f 486 map_oper_only = no;
212380e3
AC
487 operspy_admin_only = no;
488 operspy_dont_care_user_info = no;
489 caller_id_wait = 1 minute;
490 pace_wait_simple = 1 second;
491 pace_wait = 10 seconds;
492 short_motd = no;
493 ping_cookie = no;
494 connect_timeout = 30 seconds;
944b0584 495 default_ident_timeout = 5;
212380e3
AC
496 disable_auth = no;
497 no_oper_flood = yes;
212380e3 498 max_targets = 4;
e6e54763 499 client_flood_max_lines = 20;
da1b891f 500 use_whois_actually = no;
212380e3
AC
501 oper_only_umodes = operwall, locops, servnotice;
502 oper_umodes = locops, servnotice, operwall, wallop;
503 oper_snomask = "+s";
da1b891f 504 burst_away = yes;
212380e3
AC
505 nick_delay = 0 seconds; # 15 minutes if you want to enable this
506 reject_ban_time = 1 minute;
507 reject_after_count = 3;
508 reject_duration = 5 minutes;
cc49daee
JT
509 throttle_duration = 60;
510 throttle_count = 4;
212380e3
AC
511};
512
513modules {
514 path = "modules";
515 path = "modules/autoload";
516};