]> jfr.im git - solanum.git/blame - doc/reference.conf
Document need_ssl flags in example.conf.
[solanum.git] / doc / reference.conf
CommitLineData
212380e3
AC
1/* doc/reference.conf - charybdis 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 *
7 * Written by ejb, wcampbel, db, leeh and others
8 *
407b1826 9 * $Id: reference.conf 3582 2007-11-17 21:55:48Z jilles $
212380e3
AC
10 */
11
12/* IMPORTANT NOTES:
13 *
14 * class {} blocks MUST be specified before anything that uses them. That
15 * means they must be defined before auth {} and before connect {}.
16 *
17 * auth {} blocks MUST be specified in order of precedence. The first one
18 * that matches a user will be used. So place spoofs first, then specials,
19 * then general access, then restricted.
20 *
21 * Both shell style (#) and C style comments are supported.
22 *
23 * Files may be included by either:
24 * .include "filename"
25 * .include <filename>
26 *
27 * Times/durations are written as:
28 * 12 hours 30 minutes 1 second
29 *
30 * Valid units of time:
31 * month, week, day, hour, minute, second
32 *
33 * Valid units of size:
34 * megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
35 *
36 * Sizes and times may be singular or plural.
37 */
38
39/* Extensions:
40 *
41 * Charybdis contains several extensions that are not enabled by default.
42 * To use them, uncomment the lines below.
43 *
67e6f4df
VY
44 * Channel mode +-A (admin only) -- chm_adminonly.so
45 * Channel mode +-O (oper only) -- chm_operonly.so
46 * Channel mode +-S (ssl only) -- chm_sslonly.so
dbbe26fa
VY
47 * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat.so
48 * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat.so
49 * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat.so
50 * Restrict channel creation to logged in users -- createauthonly.so
51 * Account bans (+b $a[:mask]) -- extb_account.so
52 * Banned from another channel (+b $j:mask) -- extb_canjoin.so
53 * Other-channel bans (+b $c:mask) -- extb_channel.so
54 * Extended ban (+b $x:mask) -- extb_extgecos.so
55 * Oper bans (+b $o) -- extb_oper.so
56 * Realname (gecos) bans (+b $r:mask) -- extb_realname.so
57 * Server bans (+b $s:mask) -- extb_server.so
58 * SSL bans (+b $z) -- extb_ssl.so
59 * HURT system -- hurt.so
60 * Host mangling (umode +h) -- ip_cloaking.so
61 * Find channel forwards -- m_findforwards.so
62 * /identify support -- m_identify.so
63 * Opers cannot be invisible (umode +i) -- no_oper_invis.so
64 * Far connection notices (snomask +F) -- sno_farconnect.so
bf870ceb 65 * Remote k/d/x line active notices -- sno_globalkline.so
dbbe26fa
VY
66 * Remote oper up notices -- sno_globaloper.so
67 * /whois notifications (snomask +W) -- sno_whois.so
212380e3 68 */
67e6f4df
VY
69#loadmodule "extensions/chm_adminonly.so";
70#loadmodule "extensions/chm_operonly.so";
71#loadmodule "extensions/chm_sslonly.so";
dbbe26fa
VY
72#loadmodule "extensions/chm_operonly_compat.so";
73#loadmodule "extensions/chm_quietunreg_compat.so";
74#loadmodule "extensions/chm_sslonly_compat.so";
212380e3
AC
75#loadmodule "extensions/createauthonly.so";
76#loadmodule "extensions/extb_account.so";
77#loadmodule "extensions/extb_canjoin.so";
78#loadmodule "extensions/extb_channel.so";
79#loadmodule "extensions/extb_extgecos.so";
80#loadmodule "extensions/extb_oper.so";
81#loadmodule "extensions/extb_realname.so";
82#loadmodule "extensions/extb_server.so";
dbbe26fa 83#loadmodule "extensions/extb_ssl.so";
212380e3
AC
84#loadmodule "extensions/hurt.so";
85#loadmodule "extensions/ip_cloaking.so";
86#loadmodule "extensions/m_findforwards.so";
87#loadmodule "extensions/m_identify.so";
88#loadmodule "extensions/no_oper_invis.so";
89#loadmodule "extensions/sno_farconnect.so";
90#loadmodule "extensions/sno_globalkline.so";
91#loadmodule "extensions/sno_globaloper.so";
446d88dd 92#loadmodule "extensions/sno_whois.so";
212380e3
AC
93
94/* serverinfo {}: Contains information about the server. (OLD M:) */
95serverinfo {
96 /* name: the name of our server */
97 name = "hades.arpa";
98
212380e3
AC
99 /* sid: the unique server id of our server. This must be three
100 * characters long. The first character must be a digit [0-9], the
101 * remaining two chars may be letters [A-Z] or digits [0-9].
102 *
cda8e9b8 103 * This parameter must be specified for the server to start.
212380e3
AC
104 */
105 sid = "42X";
106
107 /* description: the description of our server. '[' and ']' may not
108 * be used here for compatibility with older servers.
109 */
110 description = "charybdis test server";
111
112 /* network info: the name and description of the network this server
113 * is on. Shown in the 005 reply and used with serverhiding.
114 */
115 network_name = "MyNet";
116 network_desc = "This is My Network";
117
118 /* hub: allow this server to act as a hub and have multiple servers
119 * connected to it.
120 */
121 hub = no;
122
123 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
124 * This should be an ipv4 IP only.
125 */
126 #vhost = "192.169.0.1";
127
128 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
129 * This should be an ipv6 IP only.
130 */
131 #vhost6 = "3ffe:80e8:546::2";
c6d72037 132
b8730cbf
VY
133 /* ssl_private_key: our ssl private key */
134 ssl_private_key = "etc/test.key";
135
136 /* ssl_cert: certificate for our ssl server */
137 ssl_cert = "etc/test.cert";
138
139 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
140 ssl_dh_params = "etc/dh.pem";
141
142 /* ssld_count: number of ssld processes you want to start, if you have a really busy
143 * server, using N-1 where N is the number of cpu/cpu cores you have might be useful
144 */
145 ssld_count = 1;
146
147 /* default max clients: the default maximum number of clients
148 * allowed to connect. This can be changed once ircd has started by
149 * issuing:
150 * /quote set maxclients <limit>
c2d96fcb 151 */
101db4c4 152 default_max_clients = 1024;
212380e3
AC
153};
154
155/* admin {}: contains admin information about the server. (OLD A:) */
156admin {
157 name = "Smurf target";
158 description = "Main Server Administrator";
159 email = "<syn@packets.r.us>";
160};
161
162/* log {}: contains information about logfiles. */
163log {
164 /* logfiles: the logfiles to use for specific activity. if these
165 * paths are defined, then ircd will log to them, otherwise it wont.
166 *
167 * The confs are, in order:
168 * - userlog: user exits
169 * - fuserlog: failed user connections
170 * - operlog: /oper usage
171 * - foperlog: failed /oper usage
172 * - serverlog: server connects/disconnects
212380e3
AC
173 * - klinelog: klines, etc
174 * - killlog: kills
175 * - operspylog: operspy usage
176 * - ioerrorlog: IO errors
177 */
178 fname_userlog = "logs/userlog";
179 #fname_fuserlog = "logs/fuserlog";
180 fname_operlog = "logs/operlog";
181 #fname_foperlog = "logs/foperlog";
182 fname_serverlog = "logs/serverlog";
212380e3
AC
183 #fname_klinelog = "logs/klinelog";
184 fname_killlog = "logs/killlog";
185 fname_operspylog = "logs/operspylog";
186 #fname_ioerrorlog = "logs/ioerror";
187};
188
189/* class {}: contain information about classes for users (OLD Y:) */
190class "users" {
191 /* class name must go above */
192
193 /* ping time: how often a client must reply to a PING from the
194 * server before they are dropped.
195 */
196 ping_time = 2 minutes;
197
198 /* number per ident: the number of users per user@host networkwide
199 * allowed to connect. Unidented connections are classified as
200 * the same ident.
201 */
202 number_per_ident = 2;
203
204 /* number per ip: the number of local users per host allowed */
205 number_per_ip = 3;
206
207 /* number per ip global: the number of network wide connections
208 * per host allowed for a user, including connections to the
209 * local server.
210 */
211 number_per_ip_global = 5;
212
213 /* cidr_bitlen: Limits numbers of connections from a subnet size
214 * the following example makes the subnet /64 this is useful
215 * for IPv6 connections in particular
216 * Also note that the way charybdis is written if you have
217 * compiled support for IPv6, IPv4 cidr bitlens need to be modified
218 * Basically to get the approriate length add 96 to the IPv4 length
219 * For example for a /24 do 96+24 = 120
220 *
221 */
222 cidr_bitlen = 64;
223
224 /* number_per_cidr: Number of connections to allow from a subnet of the
225 * size given in cidr_bitlen. 4 seems to be a good default to me.
226 */
227 number_per_cidr = 4;
228
229 /* max number: the maximum number of users allowed in this class */
230 max_number = 100;
231
232 /* sendq: the amount of data allowed in a clients queue before
233 * they are dropped.
234 */
235 sendq = 100 kbytes;
236};
237
238class "restricted" {
239 ping_time = 1 minute 30 seconds;
240 number_per_ip = 1;
241 max_number = 100;
242 sendq = 60kb;
243};
244
245class "opers" {
246 ping_time = 5 minutes;
247 number_per_ip = 10;
248 max_number = 100;
249 sendq = 100kbytes;
250};
251
252class "server" {
253 ping_time = 5 minutes;
254
255 /* connectfreq: only used in server classes. specifies the delay
256 * between autoconnecting to servers.
257 */
258 connectfreq = 5 minutes;
259
260 /* max number: the amount of servers to autoconnect to */
261 max_number = 1;
262
263 /* sendq: servers need a higher sendq as they are sent more data */
264 sendq=2 megabytes;
265};
266
267/* listen {}: contain information about the ports ircd listens on (OLD P:) */
268listen {
269 /* port: the specific port to listen on. if no host is specified
270 * before, it will listen on all available IPs.
271 *
b8730cbf
VY
272 * sslport: the specific port to listen ssl connections on. if no
273 * host is specified before, it will listen on all available IPs.
274 *
212380e3
AC
275 * ports are seperated via a comma, a range may be specified using ".."
276 */
277
278 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
279 port = 5000, 6665 .. 6669;
b8730cbf
VY
280
281 /* sslport: listen for ssl connections on all available IPs, port 9999 */
282 sslport = 9999;
212380e3
AC
283
284 /* host: set a specific IP/host the ports after the line will listen
285 * on. This may be ipv4 or ipv6.
286 */
287 host = "1.2.3.4";
288 port = 7000, 7001;
b8730cbf 289 sslport = 9000, 9001;
212380e3
AC
290
291 host = "3ffe:1234:a:b:c::d";
292 port = 7002;
b8730cbf 293 sslport = 9002;
212380e3
AC
294};
295
296/* auth {}: allow users to connect to the ircd (OLD I:) */
297auth {
b0dc8e03
JT
298 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
299 * lines are permitted per auth block. This is matched against the
300 * hostname and IP address (using :: shortening for IPv6 and
301 * prepending a 0 if it starts with a colon) and can also use CIDR
302 * masks.
212380e3
AC
303 */
304 user = "*@172.16.0.0/12";
305 user = "*test@123D:B567:*";
306
307 /* password: an optional password that is required to use this block.
308 * By default this is not encrypted, specify the flag "encrypted" in
309 * flags = ...; below if it is.
310 */
311 password = "letmein";
312
313 /* spoof: fake the users user@host to be be this. You may either
314 * specify a host or a user@host to spoof to. This is free-form,
315 * just do everyone a favour and dont abuse it. (OLD I: = flag)
316 */
317 spoof = "I.still.hate.packets";
318
319 /* Possible flags in auth:
320 *
321 * encrypted | password is encrypted with mkpasswd
322 * spoof_notice | give a notice when spoofing hosts
323 * exceed_limit (old > flag) | allow user to exceed class user limits
324 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
325 * dnsbl_exempt | exempt this user from dnsbls
212380e3
AC
326 * spambot_exempt | exempt this user from spambot checks
327 * shide_exempt | exempt this user from serverhiding
328 * jupe_exempt | exempt this user from generating
329 * warnings joining juped channels
330 * resv_exempt | exempt this user from resvs
331 * flood_exempt | exempt this user from flood limits
332 * USE WITH CAUTION.
333 * no_tilde (old - flag) | don't prefix ~ to username if no ident
334 * need_ident (old + flag) | require ident for user in this class
b1594414 335 * need_ssl | require SSL/TLS for user in this class
212380e3
AC
336 * need_sasl | require SASL id for user in this class
337 */
338 flags = kline_exempt, exceed_limit;
339
340 /* class: the class the user is placed in */
341 class = "opers";
342};
343
344auth {
345 /* redirect: the server and port to redirect a user to. A user does
346 * not have to obey the redirection, the ircd just suggests to them
347 * an alternative server.
348 */
349 redirserv = "irc.some.domain";
350 redirport = 6667;
351
352 user = "*.some.domain";
353
354 /* class: a class is required even though it is not used */
355 class = "users";
356};
357
358auth {
359 user = "*@*";
360 class = "users";
361
362 flags = need_ident;
363};
364
365/* operator {}: defines ircd operators. (OLD O:)
366 * charybdis no longer supports local operators, privileges are
367 * controlled via flags.
368 */
369operator "god" {
370 /* name: the name of the oper must go above */
371
372 /* user: the user@host required for this operator. CIDR *is*
373 * supported now. auth{} spoofs work here, other spoofs do not.
374 * multiple user="" lines are supported.
375 */
376 user = "*god@*";
377 user = "*@127.0.0.1";
378
379 /* password: the password required to oper. Unless ~encrypted is
380 * contained in flags = ...; this will need to be encrypted using
381 * mkpasswd, MD5 is supported
382 */
383 password = "etcnjl8juSU1E";
384
385 /* rsa key: the public key for this oper when using Challenge.
386 * A password should not be defined when this is used, see
387 * doc/challenge.txt for more information.
388 */
389 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
390
391 /* umodes: the specific umodes this oper gets when they oper.
392 * If this is specified an oper will not be given oper_umodes
393 * These are described above oper_only_umodes in general {};
394 */
395 #umodes = locops, servnotice, operwall, wallop;
396
397 /* snomask: specific server notice mask on oper up.
398 * If this is specified an oper will not be given oper_snomask.
399 */
400 snomask = "+Zbfkrsuy";
401
402 /* privileges: controls the activities and commands an oper is
403 * allowed to do on the server. You may prefix an option with ~ to
404 * disable it, ie ~operwall
405 *
406 * Default flags are operwall, remoteban and encrypted.
407 *
408 * Available options:
409 *
410 * encrypted: the password above is encrypted [DEFAULT]
b1594414 411 * need_ssl: must be using SSL/TLS to oper up
212380e3
AC
412 * local_kill: allows local users to be /KILL'd
413 * global_kill: allows local and remote users to be
414 * /KILL'd (OLD 'O' flag)
415 * remote: allows remote SQUIT and CONNECT (OLD 'R' flag)
407b1826 416 * kline: allows KLINE and DLINE (OLD 'K' flag)
212380e3 417 * unkline: allows UNKLINE and UNDLINE (OLD 'U' flag)
212380e3 418 * nick_changes: allows oper to see nickchanges (OLD 'N' flag)
407b1826 419 * via snomask +n
212380e3
AC
420 * rehash: allows oper to REHASH config (OLD 'H' flag)
421 * die: allows DIE and RESTART (OLD 'D' flag)
422 * admin: gives admin privileges. admins
423 * may (un)load modules and see the
424 * real IPs of servers.
425 * hidden_admin: gives admin privileges except
426 * will not have the admin lines in
427 * stats p and whois.
428 * xline: allows use of /quote xline/unxline
1ef5b430 429 * resv: allows /quote resv/unresv and cmode +LP [DEFAULT]
407b1826 430 * operwall: allows the oper to send/receive operwalls [DEFAULT]
212380e3
AC
431 * oper_spy: allows 'operspy' features to see through +s
432 * channels etc. see /quote help operspy
433 * hidden_oper: hides the oper from /stats p (OLD UMODE +p)
434 * remoteban: allows remote kline etc [DEFAULT]
a6f4368b 435 * mass_notice: allows sending wallops and mass notices [DEFAULT]
212380e3 436 */
170703fe 437 flags = global_kill, remote, kline, unkline,
212380e3
AC
438 die, rehash, admin, xline, operwall;
439};
440
441/* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
442connect "irc.uplink.com" {
443 /* the name must go above */
444
445 /* host: the host or IP to connect to. If a hostname is used it
446 * must match the reverse dns of the server.
447 */
448 host = "192.168.0.1";
449
450 /* vhost: the host or IP to bind to for this connection. If this
451 * is not specified, the default vhost (in serverinfo {}) is used.
452 */
453 #vhost = "192.168.0.50";
454
455 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
456 * The remote server will have these passwords reversed.
457 */
458 send_password = "password";
459 accept_password = "anotherpassword";
460
461 /* port: the port to connect to this server on */
462 port = 6666;
463
464 /* hub mask: the mask of servers that this server may hub. Multiple
465 * entries are permitted
466 */
467 hub_mask = "*";
468
469 /* leaf mask: the mask of servers this server may not hub. Multiple
470 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
471 */
472 #leaf_mask = "*.uk";
473
474 /* class: the class this server is in */
475 class = "server";
476
477 /* flags: controls special options for this server
478 * encrypted - marks the accept_password as being crypt()'d
479 * autoconn - automatically connect to this server
480 * compressed - compress traffic via ziplinks
481 * topicburst - burst topics between servers
b8730cbf 482 * ssl - ssl/tls encrypted server connections
212380e3
AC
483 */
484 flags = compressed, topicburst;
485};
486
487connect "ipv6.some.server" {
b0dc8e03
JT
488 /* Hosts that are IPv6 addresses must be in :: shortened form
489 * if applicable. Addresses starting with a colon get an extra
490 * zero prepended, for example: 0::1
491 */
212380e3
AC
492 host = "3ffd:dead:beef::1";
493 send_password = "password";
494 accept_password = "password";
495 port = 6666;
496
497 /* aftype: controls whether the connection uses "ipv4" or "ipv6".
498 * Default is ipv4.
499 */
500 aftype = ipv6;
501 class = "server";
502};
503
b8730cbf
VY
504connect "ssl.uplink.com" {
505 /* Example of ssl server-to-server connection, ssl flag doesn't need
506 * compressed flag, 'cause it uses own compression
507 */
508 host = "192.168.0.1";
509 send_password = "password";
510 accept_password = "anotherpassword";
511 port = 9999;
512 hub_mask = "*";
513 class = "server";
514 flags = ssl, topicburst;
515};
516
212380e3
AC
517/* cluster {}; servers that we propagate things to automatically.
518 * NOTE: This does NOT grant them privileges to apply anything locally,
519 * you must add a seperate shared block for that. Clustering will
520 * only be done for actions by LOCAL opers, that arent directed
521 * remotely.
522 */
523cluster {
524 /* name: the server to share with, this can be a wildcard and may be
525 * stacked.
526 */
527 /* flags: list of what to share, all the name lines above this (up
528 * until another flags entry) will receive these flags.
529 *
530 * kline - share perm klines
531 * tkline - share temp klines
532 * unkline - share unklines
533 * locops - share locops
534 * xline - share perm xlines
535 * txline - share temp xlines
536 * unxline - share unxlines
537 * resv - share perm resvs
538 * tresv - share temp resvs
539 * unresv - share unresvs
540 * all - share all of the above
541 */
542
543 /* share klines/unklines/xlines with *.lan */
544 name = "*.lan";
545 flags = kline, unkline, xline;
546
547 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
548 name = "irc.ircd-ratbox.org";
549 name = "ircd.ircd-ratbox.org";
550 flags = locops;
551};
552
553/* service{}: privileged servers (services). These servers have extra
554 * privileges such as setting login names on users and introducing clients
555 * with umode +S (unkickable, hide channels, etc). This does not allow them
556 * to set bans, you need a separate shared{} for that.
557 * Do not place normal servers here.
558 * There may be only one service{} block.
559 */
560service {
561 /* name: the server name. These may be stacked. */
562 name = "services.int";
563};
564
565/* shared {}: users that are allowed to place remote bans on our server.
566 * NOTE: These are ordered top down. The first one the user@host and server
567 * matches will be used. Their access will then be decided on that
568 * block and will not fall back to another block that matches.
569 */
570shared {
571 /* oper: the user@host and server the user must be on to set klines.
572 * The first field must be a user@host, the second field is an
573 * optional server. These may be stacked.
574 */
575 /* flags: list of what to allow them to place, all the oper lines
576 * above this (up until another flags entry) will receive these
577 * flags. This *must* be present.
578 *
579 * kline - allow setting perm/temp klines
580 * tkline - allow setting temp klines
581 * unkline - allow removing klines
582 * xline - allow setting perm/temp xlines
583 * txline - allow setting temp xlines
584 * unxline - allow removing xlines
585 * resv - allow setting perm/temp resvs
586 * tresv - allow setting temp resvs
587 * unresv - allow removing xlines
588 * all - allow oper/server to do all of above.
589 * locops - allow locops - only used for servers who cluster
590 * rehash - allow rehashing
d8d2cb0a
JT
591 * dline - allow setting perm/temp dlines
592 * tdline - allow setting temp dlines
593 * undline - allow removing dlines
212380e3
AC
594 * none - disallow everything
595 */
596
597 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
598 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
599 */
600 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
601 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
602 flags = kline;
603
604 /* you may forbid certain opers/servers from doing anything */
605 oper = "irc@vanity.oper", "*";
606 oper = "*@*", "irc.vanity.server";
607 oper = "irc@another.vanity.oper", "bigger.vanity.server";
608 flags = none;
609
610 /* or allow everyone to place temp klines */
611 oper = "*@*";
612 flags = tkline;
613};
614
b808adf9 615/* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
212380e3
AC
616exempt {
617 ip = "192.168.0.0/16";
618
619 /* these may be stacked */
620 ip = "127.0.0.1";
621 ip = "10.0.0.0/8";
622};
623
624/* The channel block contains options pertaining to channels */
625channel {
626 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
627 * that can join a +i channel without an invite.
628 */
629 use_invex = yes;
630
631 /* except: Enable/disable channel mode +e, a n!u@h list of masks
632 * that can join a channel through a ban (+b).
633 */
634 use_except = yes;
635
636 /* forward: Enable/disable channel mode +f, a channel to forward
637 * users to if they can't join because of +i etc.
638 */
639 use_forward = yes;
640
641 /* knock: Allows users to request an invite to a channel that
642 * is locked somehow (+ikl). If the channel is +p or you are banned
643 * the knock will not be sent.
644 */
645 use_knock = yes;
646
212380e3
AC
647 /* knock delay: The amount of time a user must wait between issuing
648 * the knock command.
649 */
650 knock_delay = 5 minutes;
651
652 /* knock channel delay: How often a knock to any specific channel
653 * is permitted, regardless of the user sending the knock.
654 */
655 knock_delay_channel = 1 minute;
656
657 /* max chans: The maximum number of channels a user can join/be on. */
658 max_chans_per_user = 15;
659
660 /* max bans: maximum number of +b/e/I/q modes in a channel */
661 max_bans = 25;
662
663 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
664 max_bans_large = 500;
665
666 /* splitcode: split users, split servers and either no join on split
667 * or no create on split must be enabled for split checking.
668 * splitmode will be entered on either split users or split servers
669 * dropping below the limit.
670 *
671 * you may force splitmode to be permanent by /quote set splitmode on
672 */
673
674 /* split users: when the usercount is lower than this level, consider
675 * ourselves split. this must be set for automatic splitmode
676 */
677 default_split_user_count = 0;
678
679 /* split servers: when the amount of servers that have acknowledged
680 * theyve finished bursting is lower than this, consider ourselves
681 * split. this must be set for automatic splitmode
682 */
683 default_split_server_count = 0;
684
685 /* split: no create: disallow users creating channels on split */
686 no_create_on_split = no;
687
688 /* split: no join: disallow users joining channels at all on a split */
689 no_join_on_split = no;
690
691 /* burst topicwho: when bursting topics, also burst the topic setter */
692 burst_topicwho = yes;
693
694 /* kick on split riding: kick users riding splits to join +i or +k
695 * channels. more precisely, if a bursting server sends an SJOIN
696 * for a channel with a lower TS with either a +i mode or a +k
697 * mode with a different key, kick all local users.
698 *
699 * note: this does not take +r, +b, +e and +I into account.
700 *
701 * warning: if there are any TS5 servers on the network, this
702 * will cause ban desyncs if they send such an SJOIN and the
703 * splitriders added any bans (our side will lose them, the TS5
704 * side will accept them). we will send a notice to the channel
705 * if this happens. most services do not send such SJOINs but
706 * ratbox-services does.
707 */
708 kick_on_split_riding = no;
709};
710
711
712/* The serverhide block contains the options regarding serverhiding */
713serverhide {
4acf2281
JT
714 /* flatten links: this option will hide various routing information
715 * and make all servers in /links appear that they are linked to
716 * this server.
212380e3
AC
717 */
718 flatten_links = no;
719
994544c2
JT
720 /* links delay: how long to wait before showing splits or new
721 * servers in a flattened /links output.
212380e3
AC
722 */
723 links_delay = 5 minutes;
724
4acf2281
JT
725 /* hidden: hide this server from a /links output on servers with
726 * flatten_links enabled. this allows hub servers to be hidden etc.
212380e3
AC
727 */
728 hidden = no;
729
730 /* disable hidden: prevent servers hiding themselves from a
731 * /links ouput.
732 */
733 disable_hidden = no;
734};
735
736/* These are the blacklist settings.
737 * You can have multiple combinations of host and rejection reasons.
92fb5c31 738 * They are used in pairs of one host/rejection reason, or multiple hosts/rejection reason.
212380e3
AC
739 *
740 * These settings should be adequate for most networks, and are (presently)
741 * required for use on AthemeNet.
742 *
743 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
744 * connections.
745 *
92fb5c31
AC
746 * As of charybdis 2.2, you can do some keyword substitution on the rejection
747 * reason. The available keyword substitutions are:
748 *
749 * ${ip} - the user's IP
750 * ${host} - the user's canonical hostname
751 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
752 * ${nick} - the user's nickname
753 * ${network-name} - the name of the network
754 *
57b8cb0f 755 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
212380e3
AC
756 * contacted, via email, at admins@2mbit.com before using these BLs.
757 * See <http://www.ahbl.org/services.php> for more information.
758 */
57b8cb0f
AC
759blacklist {
760 host = "dnsbl.dronebl.org";
761 reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
762
212380e3 763# host = "ircbl.ahbl.org";
92fb5c31 764# 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
765#
766# host = "tor.ahbl.org";
92fb5c31 767# 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.";
57b8cb0f 768};
212380e3
AC
769
770/*
771 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
772 * They send PRIVMSG to the given target. A real command takes
773 * precedence above an alias.
774 */
775alias "NickServ" {
776 /* the name must go above */
777
778 /* target: the target nick (must be a network service) or
779 * user@server (cannot be this server, only opers can use
780 * user starting with "opers" reliably, interpreted on the target
781 * server only so you may need to use nick@server instead)
782 */
783 target = "NickServ";
784};
785
786alias "ChanServ" {
787 target = "ChanServ";
788};
789
790alias "OperServ" {
791 target = "OperServ";
792};
793
794alias "MemoServ" {
795 target = "MemoServ";
796};
797
798alias "NS" {
799 target = "NickServ";
800};
801
802alias "CS" {
803 target = "ChanServ";
804};
805
806alias "OS" {
807 target = "OperServ";
808};
809
810alias "MS" {
811 target = "MemoServ";
812};
813
814/* The general block contains many of the options that were once compiled
815 * in options in config.h. The general block is read at start time.
816 */
817general {
818 /* hide error messages: defines whether error messages from
922aa826
JT
819 * servers that are not deemed fully safe are hidden or not.
820 * These can sometimes contain IPs and can have an adverse
821 * effect on server ip hiding. Set to:
212380e3
AC
822 * yes: hide from opers and admin
823 * opers: hide from opers only
824 * no: do not hide error messages
922aa826 825 * Admins on other servers count as opers.
212380e3
AC
826 */
827 hide_error_messages = opers;
828
829 /* hide spoof ips: hide the real ips of auth{} spoofed users
830 * If disabled, local opers can see them.
831 * Dynamic spoofs (e.g. set by services) are unaffected by this;
832 * any oper (local and remote) can see the real ip.
833 * Warning: for whowas, this is checked when the client exits,
834 * not when the IP is shown.
835 */
836 hide_spoof_ips = yes;
837
838 /* default umodes: umodes to set upon connection
839 * If you have enabled the ip_cloaking extension, and you wish for
840 * incoming clients to be set +h upon connection, add +h to the umode
841 * string below.
842 */
843 default_umodes = "+i";
844
845 /* default operstring: defines the default oper response
846 * in /whois queries, eg "is an IRC Operator".
847 * After startup use /quote set operstring to change.
848 */
849 default_operstring = "is an IRC Operator";
850
851 /* default adminstring: defines the default admin response
852 * in /whois queries, eg "is a Server Administrator".
853 * After startup use /quote set adminstring to change.
854 */
855 default_adminstring = "is a Server Administrator";
856
857 /* servicestring: defines the response for opered services (+S)
858 * in /whois queries, eg "is a Network Service".
859 * This is updated on rehash.
860 */
861 servicestring = "is a Network Service";
862
863 /* disable fake channels: disable local users joining fake versions
864 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
865 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
866 */
867 disable_fake_channels = no;
868
869 /* tkline_expire_notices: give a notice to opers when a tkline
870 * expires
871 */
872 tkline_expire_notices = no;
873
874 /* floodcount: the default value of floodcount that is configurable
875 * via /quote set floodcount. This is the amount of lines a user
876 * may send to any other user/channel in one second.
877 */
878 default_floodcount = 10;
879
880 /* failed oper notice: send a notice to all opers on the server when
881 * someone tries to OPER and uses the wrong password, host or ident.
882 */
883 failed_oper_notice = yes;
884
885 /* dots in ident: the amount of '.' characters permitted in an ident
886 * reply before the user is rejected.
887 */
888 dots_in_ident=2;
889
212380e3
AC
890 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
891 * placed via the server. klines hand placed are exempt from limits.
892 * wildcard chars: '.' '*' '?' '@'
893 */
894 min_nonwildcard = 4;
895
896 /* min nonwildcard simple: the minimum non wildcard characters in
897 * xlines/resvs placed via the server.
898 * wildcard chars: '*' '?'
899 */
900 min_nonwildcard_simple = 3;
901
902 /* max accept: maximum allowed /accept's for +g usermode */
903 max_accept = 20;
904
905 /* max monitor: the maximum amount of nicknames a client may have in
906 * their monitor (server-side notify) list.
907 */
908 max_monitor = 100;
909
910 /* nick flood: enable the nickflood control code */
911 anti_nick_flood = yes;
912
913 /* nick flood: the nick changes allowed in the specified period */
914 max_nick_time = 20 seconds;
915 max_nick_changes = 5;
916
917 /* anti spam time: the minimum time a user must be connected before
918 * custom quit messages are allowed.
919 */
920 anti_spam_exit_message_time = 5 minutes;
921
922 /* ts delta: the time delta allowed between server clocks before
923 * a warning is given, or before the link is dropped. all servers
924 * should run ntpdate/rdate to keep clocks in sync
925 */
926 ts_warn_delta = 30 seconds;
927 ts_max_delta = 5 minutes;
928
929 /* client exit: prepend a users quit message with "Client exit: " */
930 client_exit = yes;
931
932 /* collision fnc: change user's nick to their UID instead of
933 * killing them, if possible. This setting only applies to nick
934 * collisions detected on this server. Only enable this if
935 * all servers on the network allow remote nicks to start with
936 * a digit.
937 */
938 collision_fnc = yes;
939
940 /* global snotices: send out certain snotices (most +b, +f, +y,
941 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
942 * displayed unconditionally.
943 */
944 global_snotices = yes;
945
946 /* dline reason: show the user the dline reason when they connect
947 * and are dlined.
948 */
949 dline_with_reason = yes;
950
951 /* kline delay: delay the checking of klines until a specified time.
952 * Useful if large kline lists are applied often to prevent the
953 * server eating CPU.
954 */
955 kline_delay = 0 seconds;
956
170703fe 957 /* kline reason: show the user the reason why they are k/dlined
212380e3
AC
958 * on exit. may give away who set k/dline when set via tcm.
959 */
960 kline_with_reason = yes;
961
962 /* kline reason: make the users quit message on channels this
963 * reason instead of the oper's reason.
964 */
965 kline_reason = "Connection closed";
966
967 /* identify to services via server password
968 * if auth{} block had no password but the user specified a
969 * server password anyway, send a PRIVMSG to <identify_service>
970 * with as text <identify_command> <password>.
971 */
972 identify_service = "NickServ@services.int";
973 identify_command = "IDENTIFY";
974
975 /* non redundant klines: flag and ignore redundant klines */
976 non_redundant_klines = yes;
977
978 /* warn no nline: warn opers about servers that try to connect but
979 * we dont have a connect {} block for. Twits with misconfigured
980 * servers can get really annoying with this enabled.
981 */
982 warn_no_nline = yes;
983
984 /* stats e disabled: disable stats e. useful if server ips are
985 * exempted and you dont want them listing on irc.
986 */
987 stats_e_disabled = no;
988
989 /* stats c oper only: make stats c (connect {}) oper only */
990 stats_c_oper_only=no;
991
992 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
993 stats_h_oper_only=no;
994
995 /* stats y oper only: make stats y (class {}) oper only */
996 stats_y_oper_only=no;
997
998 /* stats o oper only: make stats o (opers) oper only */
999 stats_o_oper_only=yes;
1000
1001 /* stats P oper only: make stats P (ports) oper only
1002 * NOTE: users doing stats P will never be given the ips that the
1003 * server listens on, simply the ports.
1004 */
1005 stats_P_oper_only=no;
1006
1007 /* stats i oper only: make stats i (auth {}) oper only. set to:
1008 * yes: show users no auth blocks, made oper only.
1009 * masked: show users first matching auth block
1010 * no: show users all auth blocks.
1011 */
1012 stats_i_oper_only=masked;
1013
1014 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1015 * yes: show users no auth blocks, made oper only
1016 * masked: show users first matching auth block
1017 * no: show users all auth blocks.
1018 */
1019 stats_k_oper_only=masked;
1020
1021 /* map oper only: make /map oper only */
1022 map_oper_only = no;
1023
1024 /* operspy admin only: make operspy notices to +Z admin only */
1025 operspy_admin_only = no;
1026
1027 /* operspy dont care user info: treat /who mask as if there was
1028 * an '!' always; do not log or server notice about operspy
1029 * /who mask, /masktrace and /scan. channel information is still
1030 * protected. */
1031 operspy_dont_care_user_info = no;
1032
1033 /* caller id wait: time between notifying a +g user that somebody
1034 * is messaging them.
1035 */
1036 caller_id_wait = 1 minute;
1037
1038 /* pace wait simple: time between use of less intensive commands
1039 * (HELP, remote WHOIS, WHOWAS)
1040 */
1041 pace_wait_simple = 1 second;
1042
1043 /* pace wait: time between more intensive commands
1044 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1045 */
1046 pace_wait = 10 seconds;
1047
1048 /* short motd: send clients a notice telling them to read the motd
1049 * instead of forcing a motd to clients who may simply ignore it.
1050 */
1051 short_motd = no;
1052
1053 /* ping cookies: require clients to respond exactly to a ping command,
1054 * can help block certain types of drones and FTP PASV mode spoofing.
1055 */
1056 ping_cookie = no;
1057
1058 /* connect timeout: sets how long we should wait for a connection
1059 * request to succeed
1060 */
1061 connect_timeout = 30 seconds;
1062
1063 /* disable auth: disables identd checking */
1064 disable_auth = no;
1065
1066 /* no oper flood: increase flood limits for opers. */
1067 no_oper_flood = yes;
1068
212380e3
AC
1069 /* REMOVE ME. The following line checks you've been reading. */
1070 havent_read_conf = yes;
1071
1072 /* max targets: the maximum amount of targets in a single
1073 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1074 */
1075 max_targets = 4;
1076
1077 /* client flood: maximum number of lines in a clients queue before
1078 * they are dropped for flooding.
1079 */
1080 client_flood = 20;
1081
1082 /* use_whois_actually: send clients requesting a whois a numeric
1083 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1084 */
1085 use_whois_actually = yes;
1086
1087 /* usermodes configurable: a list of usermodes for the options below
1088 *
1089 * +g - callerid - Server Side Ignore
1090 * +D - deaf - Don't see channel messages
1091 * +i - invisible - Not shown in NAMES or WHO unless you share a
1092 * a channel
1093 * +l - locops - See LOCOPS messages
1094 * +Q - noforward - Unaffected by channel forwarding
1095 * +R - regonlymsg - No messages from unindentified
1096 * +s - servnotice - See server notices
1097 * +w - wallop - See oper and server generated WALLOPS
1098 * +z - operwall - See operwalls
1099 */
1100
1101 /* oper only umodes: usermodes only opers may set */
1102 oper_only_umodes = operwall, locops, servnotice;
1103
1104 /* oper umodes: default usermodes opers get when they /oper */
1105 oper_umodes = locops, servnotice, operwall, wallop;
1106
1107 /* oper snomask: default snomask opers get when they /oper,
1108 * provided they have umode +s set */
1109 oper_snomask = "+s";
1110
212380e3
AC
1111 /* use egd: if your system does not have *random devices yet you
1112 * want to use OpenSSL and encrypted links, enable this. Beware -
1113 * EGD is *very* CPU intensive when gathering data for its pool
1114 */
1115 #use_egd = yes;
1116
1117 /* egdpool path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1118 * which automatically finds the path.
1119 */
1120 #egdpool_path = "/var/run/egd-pool";
1121
1122
1123 /* compression level: level of compression for compressed links between
1124 * servers.
1125 *
1126 * values are between: 1 (least compression, fastest)
1127 * and: 9 (most compression, slowest).
1128 */
1129 #compression_level = 6;
1130
1131 /* burst_away: This enables bursting away messages to servers.
1132 * With this disabled, we will only propogate AWAY messages
1133 * as users send them, but never burst them. Be warned though
1134 * enabling this could increase the size of a burst significantly
1135 * for a large network, like EFnet.
1136 */
1137 burst_away = yes;
1138
1139 /* nick delay: This locks nicks of split clients for the given time
1140 * or until a remote client uses the nick. This significantly
1141 * reduces nick collisions on short splits but it can be annoying.
1142 * To make things as fair as possible, this should be the same on
1143 * all servers. If you enable this, the suggested value is 15 minutes.
1144 */
1145 nick_delay = 0 seconds;
1146
1147 /* reject time: the amount of rejections through klines/dlines etc
1148 * allowed in the given time before the rejection is cached and
1149 * a pseudo temp dline is placed
1150 */
1151 reject_ban_time = 1 minute;
1152 reject_after_count = 3;
1153
1154 /* reject duration: the amount of time to cache the rejection */
1155 reject_duration = 5 minutes;
54015b5f 1156
43946961
JT
1157 /* throttle_duration: Amount of time that throttling will be applied to an IP
1158 * address.
54015b5f 1159 */
43946961
JT
1160 throttle_duration = 60;
1161
1162 /* throttle_count: Number of connections within throttle_duration that it takes
1163 * for throttling to take effect */
1164 throttle_count = 4;
212380e3
AC
1165};
1166
1167modules {
1168 /* module path: paths to search for modules specified below and
1169 * in /modload.
1170 */
1171 path = "/usr/local/ircd/modules";
1172 path = "/usr/local/ircd/modules/autoload";
1173
1174 /* module: the name of a module to load on startup/rehash */
1175 #module = "some_module.so";
1176};