]> jfr.im git - solanum.git/blame - doc/reference.conf
Update credits
[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 *
212380e3
AC
9 */
10
11/* IMPORTANT NOTES:
12 *
13 * class {} blocks MUST be specified before anything that uses them. That
14 * means they must be defined before auth {} and before connect {}.
15 *
16 * auth {} blocks MUST be specified in order of precedence. The first one
17 * that matches a user will be used. So place spoofs first, then specials,
18 * then general access, then restricted.
19 *
da77b103
JT
20 * privset {} blocks MUST be specified before anything that uses them. That
21 * means they must be defined before operator {}.
22 *
212380e3
AC
23 * Both shell style (#) and C style comments are supported.
24 *
25 * Files may be included by either:
26 * .include "filename"
27 * .include <filename>
28 *
29 * Times/durations are written as:
30 * 12 hours 30 minutes 1 second
5c0df0e7 31 *
212380e3
AC
32 * Valid units of time:
33 * month, week, day, hour, minute, second
34 *
35 * Valid units of size:
36 * megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
37 *
5c0df0e7
MU
38 * Sizes and times may be singular or plural.
39 */
212380e3
AC
40
41/* Extensions:
42 *
43 * Charybdis contains several extensions that are not enabled by default.
44 * To use them, uncomment the lines below.
45 *
9abdcf1c 46 * Channel mode +-A (admin only) -- chm_adminonly
cdc31cc5 47 * Channel mode +-T (blocks notices) -- chm_nonotice
9abdcf1c
EM
48 * Channel mode +-O (oper only) -- chm_operonly
49 * Channel mode +-S (ssl only) -- chm_sslonly
50 * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat
51 * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat
52 * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat
53 * Channel mode +-M (disallow KICK on IRC ops) -- chm_operpeace
54 * Restrict channel creation to logged in users -- createauthonly
55 * Account bans (+b $a[:mask]) -- extb_account
56 * Banned from another channel (+b $j:mask) -- extb_canjoin
57 * Other-channel bans (+b $c:mask) -- extb_channel
58 * Combination extbans -- extb_combi
59 * Extended ban (+b $x:mask) -- extb_extgecos
60 * Hostmask bans (for combination extbans) -- extb_hostmask
61 * Oper bans (+b $o) -- extb_oper
62 * Realname (gecos) bans (+b $r:mask) -- extb_realname
63 * Server bans (+b $s:mask) -- extb_server
64 * SSL bans (+b $z) -- extb_ssl
6c5fa2f6 65 * User mode bans (+b $u:modes) -- extb_usermode
9abdcf1c
EM
66 * Helpops system (umode +H) -- helpops
67 * HURT system -- hurt
68 * New host mangling (umode +x) -- ip_cloaking_4.0
69 * Old host mangling (umode +h) -- ip_cloaking
70 * Dynamically extend channel limits -- m_extendchans
71 * Find channel forwards -- m_findforwards
72 * /identify support -- m_identify
0ed0a9fe 73 * /locops support -- m_locops
9abdcf1c
EM
74 * Opers cannot be invisible (umode +i) -- no_oper_invis
75 * Far connection notices (snomask +F) -- sno_farconnect
76 * Remote k/d/x line active notices -- sno_globalkline
77 * Remote oper up notices -- sno_globaloper
78 * Global nick-change notices -- sno_globalnickchange
79 * /whois notifications (snomask +W) -- sno_whois
80 * Oper-override (modehacking only) -- override
81 * Stop services kills -- no_kill_services
212380e3 82 */
9abdcf1c 83#loadmodule "extensions/chm_adminonly";
cdc31cc5 84#loadmodule "extensions/chm_nonotice";
9abdcf1c
EM
85#loadmodule "extensions/chm_operonly";
86#loadmodule "extensions/chm_sslonly";
87#loadmodule "extensions/chm_operonly_compat";
88#loadmodule "extensions/chm_quietunreg_compat";
89#loadmodule "extensions/chm_sslonly_compat";
90#loadmodule "extensions/chm_operpeace";
91#loadmodule "extensions/createauthonly";
92#loadmodule "extensions/extb_account";
93#loadmodule "extensions/extb_canjoin";
94#loadmodule "extensions/extb_channel";
95#loadmodule "extensions/extb_combi";
96#loadmodule "extensions/extb_extgecos";
97#loadmodule "extensions/extb_hostmask";
98#loadmodule "extensions/extb_oper";
99#loadmodule "extensions/extb_realname";
100#loadmodule "extensions/extb_server";
101#loadmodule "extensions/extb_ssl";
ed2efe76 102#loadmodule "extensions/extb_usermode";
9abdcf1c
EM
103#loadmodule "extensions/helpops";
104#loadmodule "extensions/hurt";
105#loadmodule "extensions/ip_cloaking_4.0";
106#loadmodule "extensions/ip_cloaking";
107#loadmodule "extensions/m_extendchans";
108#loadmodule "extensions/m_findforwards";
109#loadmodule "extensions/m_identify";
0ed0a9fe 110#loadmodule "extensions/m_locops";
9abdcf1c
EM
111#loadmodule "extensions/no_oper_invis";
112#loadmodule "extensions/sno_farconnect";
113#loadmodule "extensions/sno_globalkline";
114#loadmodule "extensions/sno_globalnickchange";
115#loadmodule "extensions/sno_globaloper";
116#loadmodule "extensions/sno_whois";
117#loadmodule "extensions/override";
118#loadmodule "extensions/no_kill_services";
15d7a311 119
212380e3
AC
120/* serverinfo {}: Contains information about the server. (OLD M:) */
121serverinfo {
122 /* name: the name of our server */
123 name = "hades.arpa";
124
212380e3
AC
125 /* sid: the unique server id of our server. This must be three
126 * characters long. The first character must be a digit [0-9], the
127 * remaining two chars may be letters [A-Z] or digits [0-9].
128 *
cda8e9b8 129 * This parameter must be specified for the server to start.
212380e3
AC
130 */
131 sid = "42X";
132
133 /* description: the description of our server. '[' and ']' may not
134 * be used here for compatibility with older servers.
135 */
136 description = "charybdis test server";
137
138 /* network info: the name and description of the network this server
139 * is on. Shown in the 005 reply and used with serverhiding.
140 */
141 network_name = "MyNet";
212380e3 142
212380e3
AC
143 /* vhost: the IP to bind to when we connect outward to ipv4 servers.
144 * This should be an ipv4 IP only.
145 */
cba8bbc3 146 #vhost = "192.0.2.6";
212380e3
AC
147
148 /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
149 * This should be an ipv6 IP only.
150 */
a49b954f 151 #vhost6 = "2001:db8:2::6";
5c0df0e7 152
70a70462 153 /* ssl_cert: certificate (and optionally key) for our ssl server */
b3c4dfd7 154 ssl_cert = "etc/ssl.pem";
b8730cbf 155
70a70462
AJ
156 /* ssl_private_key: our ssl private key (if not contained in ssl_cert file) */
157 #ssl_private_key = "etc/ssl.key";
158
9d6b870d
AJ
159 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 2048 */
160 /* If you do not provide parameters, some TLS backends will fail on DHE- ciphers,
161 and some will succeed but use weak, common DH groups! */
b8730cbf
VY
162 ssl_dh_params = "etc/dh.pem";
163
c1725bda
AC
164 /* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
165 #ssl_cipher_list = "EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
166
fa1a7bef
JT
167 /* ssld_count: number of ssld processes you want to start, if you
168 * have a really busy server, using N-1 where N is the number of
169 * cpu/cpu cores you have might be useful. A number greater than one
170 * can also be useful in case of bugs in ssld and because ssld needs
171 * two file descriptors per SSL connection.
b8730cbf
VY
172 */
173 ssld_count = 1;
174
175 /* default max clients: the default maximum number of clients
176 * allowed to connect. This can be changed once ircd has started by
177 * issuing:
178 * /quote set maxclients <limit>
c2d96fcb 179 */
101db4c4 180 default_max_clients = 1024;
b583faf9 181
b225bf93
JT
182 /* nicklen: enforced nickname length (for this server only; must not
183 * be longer than the maximum length set while building).
184 */
b583faf9 185 nicklen = 30;
212380e3
AC
186};
187
188/* admin {}: contains admin information about the server. (OLD A:) */
189admin {
190 name = "Smurf target";
191 description = "Main Server Administrator";
192 email = "<syn@packets.r.us>";
193};
194
195/* log {}: contains information about logfiles. */
196log {
197 /* logfiles: the logfiles to use for specific activity. if these
198 * paths are defined, then ircd will log to them, otherwise it wont.
199 *
200 * The confs are, in order:
201 * - userlog: user exits
202 * - fuserlog: failed user connections
203 * - operlog: /oper usage
204 * - foperlog: failed /oper usage
205 * - serverlog: server connects/disconnects
212380e3
AC
206 * - klinelog: klines, etc
207 * - killlog: kills
208 * - operspylog: operspy usage
209 * - ioerrorlog: IO errors
210 */
211 fname_userlog = "logs/userlog";
212 #fname_fuserlog = "logs/fuserlog";
213 fname_operlog = "logs/operlog";
214 #fname_foperlog = "logs/foperlog";
215 fname_serverlog = "logs/serverlog";
212380e3
AC
216 #fname_klinelog = "logs/klinelog";
217 fname_killlog = "logs/killlog";
218 fname_operspylog = "logs/operspylog";
219 #fname_ioerrorlog = "logs/ioerror";
220};
221
222/* class {}: contain information about classes for users (OLD Y:) */
223class "users" {
224 /* class name must go above */
225
226 /* ping time: how often a client must reply to a PING from the
227 * server before they are dropped.
228 */
229 ping_time = 2 minutes;
230
da1b891f
KB
231 /* number per ident: the number of users per user@host networkwide
232 * allowed to connect. Unidented connections are classified as
233 * the same ident.
234 */
235 number_per_ident = 2;
212380e3
AC
236
237 /* number per ip: the number of local users per host allowed */
238 number_per_ip = 3;
239
da1b891f
KB
240 /* number per ip global: the number of network wide connections
241 * per host allowed for a user, including connections to the
242 * local server.
243 */
244 number_per_ip_global = 5;
212380e3 245
bc7c44dc
JT
246 /* cidr_ipv4_bitlen: Limits numbers of connections from a subnet size
247 */
248 cidr_ipv4_bitlen = 24;
249
250 /* cidr_ipv6_bitlen: Limits numbers of connections from a subnet size
212380e3
AC
251 * the following example makes the subnet /64 this is useful
252 * for IPv6 connections in particular
212380e3 253 */
bc7c44dc 254 cidr_ipv6_bitlen = 64;
212380e3 255
5c0df0e7 256 /* number_per_cidr: Number of connections to allow from a subnet of the
bc7c44dc
JT
257 * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
258 * 4 seems to be a good default to me.
212380e3
AC
259 */
260 number_per_cidr = 4;
261
262 /* max number: the maximum number of users allowed in this class */
263 max_number = 100;
264
265 /* sendq: the amount of data allowed in a clients queue before
266 * they are dropped.
267 */
268 sendq = 100 kbytes;
269};
270
271class "restricted" {
272 ping_time = 1 minute 30 seconds;
273 number_per_ip = 1;
274 max_number = 100;
275 sendq = 60kb;
276};
277
278class "opers" {
279 ping_time = 5 minutes;
280 number_per_ip = 10;
281 max_number = 100;
282 sendq = 100kbytes;
283};
284
285class "server" {
286 ping_time = 5 minutes;
287
288 /* connectfreq: only used in server classes. specifies the delay
289 * between autoconnecting to servers.
290 */
291 connectfreq = 5 minutes;
292
2b121c81
JT
293 /* max number: the amount of servers to autoconnect to. if the number
294 * of servers in the class is or exceeds this, no more servers in the
295 * class are autoconnected. oper initiated connects are unaffected.
296 * this should usually be set to either 0 or 1. (autoconnecting from
297 * hubs to leaves may cause leaves to function as hubs by having
298 * multiple servers connected to them.)
299 */
212380e3
AC
300 max_number = 1;
301
302 /* sendq: servers need a higher sendq as they are sent more data */
3bb3dcf7 303 sendq = 2 megabytes;
212380e3
AC
304};
305
306/* listen {}: contain information about the ports ircd listens on (OLD P:) */
307listen {
02270e96
AC
308 /* defer_accept: wait for clients to send IRC handshake data before
309 * accepting them. if you intend to use software which depends on the
310 * server replying first, such as BOPM, you should disable this feature.
311 * otherwise, you probably want to leave it on.
312 */
313 defer_accept = yes;
314
212380e3
AC
315 /* port: the specific port to listen on. if no host is specified
316 * before, it will listen on all available IPs.
317 *
5c0df0e7 318 * sslport: the specific port to listen ssl connections on. if no
b8730cbf
VY
319 * host is specified before, it will listen on all available IPs.
320 *
212380e3
AC
321 * ports are seperated via a comma, a range may be specified using ".."
322 */
5c0df0e7 323
212380e3
AC
324 /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
325 port = 5000, 6665 .. 6669;
5c0df0e7 326
be2447b8
AC
327 /* sslport: listen for ssl connections on all available IPs, port 6697 */
328 sslport = 6697;
212380e3 329
5c0df0e7 330 /* host: set a specific IP/host the ports after the line will listen
212380e3
AC
331 * on. This may be ipv4 or ipv6.
332 */
cba8bbc3 333 host = "192.0.2.6";
212380e3 334 port = 7000, 7001;
b8730cbf 335 sslport = 9000, 9001;
212380e3 336
cba8bbc3 337 host = "2001:db8:2::6";
da1b891f
KB
338 port = 7002;
339 sslport = 9002;
be2447b8
AC
340
341 /* wsock: listeners defined with this option enabled will be websocket listeners,
342 * and will not accept normal clients.
343 */
344 wsock = yes;
345 sslport = 9999;
212380e3
AC
346};
347
348/* auth {}: allow users to connect to the ircd (OLD I:) */
349auth {
b0dc8e03
JT
350 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
351 * lines are permitted per auth block. This is matched against the
352 * hostname and IP address (using :: shortening for IPv6 and
353 * prepending a 0 if it starts with a colon) and can also use CIDR
354 * masks.
212380e3 355 */
cba8bbc3
JT
356 user = "*@198.51.100.0/24";
357 user = "*test@2001:db8:1:*";
212380e3 358
f9bb3e0d
CM
359 /* auth_user: This allows specifying a username:password instead of
360 * just a password in PASS, so that a fixed user@host is not
361 * necessary for a specific auth{} block.
362 */
363 #auth_user = "SomeUser";
364
212380e3
AC
365 /* password: an optional password that is required to use this block.
366 * By default this is not encrypted, specify the flag "encrypted" in
367 * flags = ...; below if it is.
368 */
369 password = "letmein";
5c0df0e7 370
212380e3
AC
371 /* spoof: fake the users user@host to be be this. You may either
372 * specify a host or a user@host to spoof to. This is free-form,
373 * just do everyone a favour and dont abuse it. (OLD I: = flag)
374 */
da1b891f 375 spoof = "I.still.hate.packets";
212380e3
AC
376
377 /* Possible flags in auth:
5c0df0e7 378 *
212380e3
AC
379 * encrypted | password is encrypted with mkpasswd
380 * spoof_notice | give a notice when spoofing hosts
381 * exceed_limit (old > flag) | allow user to exceed class user limits
81a05933
EM
382 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines,
383 * | dnsbls, and proxies
212380e3 384 * dnsbl_exempt | exempt this user from dnsbls
81a05933 385 * proxy_exempt | exempt this user from proxies
212380e3
AC
386 * spambot_exempt | exempt this user from spambot checks
387 * shide_exempt | exempt this user from serverhiding
388 * jupe_exempt | exempt this user from generating
389 * warnings joining juped channels
390 * resv_exempt | exempt this user from resvs
da1b891f
KB
391 * flood_exempt | exempt this user from flood limits
392 * USE WITH CAUTION.
212380e3
AC
393 * no_tilde (old - flag) | don't prefix ~ to username if no ident
394 * need_ident (old + flag) | require ident for user in this class
b1594414 395 * need_ssl | require SSL/TLS for user in this class
212380e3 396 * need_sasl | require SASL id for user in this class
a4721f5e 397 * extend_chans | allow this user to join more channels than normal
57657a33
EK
398 * kline_spoof_ip | if this block has a spoof host, klines match only
399 * | the spoof and not the underlying IP
212380e3
AC
400 */
401 flags = kline_exempt, exceed_limit;
5c0df0e7 402
212380e3
AC
403 /* class: the class the user is placed in */
404 class = "opers";
405};
406
407auth {
408 /* redirect: the server and port to redirect a user to. A user does
409 * not have to obey the redirection, the ircd just suggests to them
410 * an alternative server.
411 */
cba8bbc3 412 redirserv = "irc.example.net";
212380e3 413 redirport = 6667;
5c0df0e7 414
cba8bbc3 415 user = "*.example.com";
212380e3
AC
416
417 /* class: a class is required even though it is not used */
418 class = "users";
419};
420
421auth {
422 user = "*@*";
423 class = "users";
212380e3
AC
424};
425
da77b103
JT
426/* privset{}: defines operator privilege sets. */
427privset "local_op" {
428 /* privs: controls the activities and commands an oper is
429 * allowed to do on the server
430 *
431 * Available options:
432 *
d4f7eb4c
EK
433 * oper:general: enable most general oper privileges that came
434 * with +o in older releases
2f68b6e2
EK
435 * auspex:oper: allows the oper to see through oper hiding
436 * auspex:umodes: allows viewing other users' modes
437 * auspex:cmodes: shows privileged cmodes
438 * auspex:hostname: shows hidden hostnames/ips
439 * oper:privs: allows /stats o/O and seeing privset in /whois
58a490f9 440 * oper:testline: allows /testline and /testgecos
da77b103
JT
441 * oper:local_kill: allows local users to be /KILL'd
442 * oper:global_kill: allows local and remote users to be /KILL'd
3eae266c 443 * oper:routing: allows remote SQUIT and CONNECT
da77b103
JT
444 * oper:kline: allows KLINE and DLINE
445 * oper:unkline: allows UNKLINE and UNDLINE
446 * snomask:nick_changes: allows oper to see nickchanges via snomask +n
447 * oper:rehash: allows oper to REHASH config
448 * oper:die: allows DIE and RESTART
449 * oper:admin: gives admin privileges. admins
450 * may (un)load modules and see various
451 * additional information.
452 * oper:hidden_admin: gives admin privileges except
2f68b6e2
EK
453 * will not have the admin lines in
454 * whois.
455 * oper:xline: allows use of /quote xline/unxline
456 * oper:resv: allows /quote resv/unresv
457 * oper:cmodes: allows cmode +LP
da77b103 458 * oper:operwall: allows the oper to send/receive operwalls
2f68b6e2
EK
459 * oper:spy: allows 'operspy' features to see through +s
460 * channels etc. see /quote help operspy
da77b103
JT
461 * oper:hidden: hides the oper from /stats p
462 * oper:remoteban: allows remote kline etc
463 * oper:mass_notice: allows sending wallops and mass notices
2f68b6e2 464 * oper:grant: allows using the GRANT command
734e7747 465 * usermode:servnotice: allows setting +s
e06b75d2
EK
466 *
467 * Privileges provided by extensions include:
468 *
469 * oper:dehelper: allows the DEHELPER command (from extensions/helpops)
470 * oper:override: enables oper override via umode +p (from extensions/override)
471 * oper:receive_immunity:
472 * confers the benefits of chmode +M (operpeace) (from extensions/chm_operpeace)
473 * usermode:helpops allows setting +H (from extensions/helpops)
da77b103 474 */
f590bc6c
EK
475 privs = oper:general, oper:privs, oper:testline, oper:local_kill, oper:operwall, usermode:servnotice,
476 auspex:oper, auspex:hostname, auspex:umodes, auspex:cmodes;
da77b103
JT
477};
478
479privset "server_bot" {
480 /* extends: a privset to inherit in this privset */
481 extends = "local_op";
d9e7ca49 482 privs = oper:kline, oper:remoteban, snomask:nick_changes;
da77b103
JT
483};
484
485privset "global_op" {
486 extends = "local_op";
487 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
80303ab7 488 oper:resv, oper:cmodes, oper:mass_notice, oper:remoteban;
da77b103
JT
489};
490
491privset "admin" {
492 extends = "global_op";
fe749d37 493 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant;
da77b103
JT
494};
495
496/* operator {}: defines ircd operators. (OLD O:) */
212380e3
AC
497operator "god" {
498 /* name: the name of the oper must go above */
499
500 /* user: the user@host required for this operator. CIDR *is*
501 * supported now. auth{} spoofs work here, other spoofs do not.
da1b891f 502 * multiple user="" lines are supported.
212380e3
AC
503 */
504 user = "*god@*";
505 user = "*@127.0.0.1";
506
507 /* password: the password required to oper. Unless ~encrypted is
5c0df0e7 508 * contained in flags = ...; this will need to be encrypted using
212380e3
AC
509 * mkpasswd, MD5 is supported
510 */
511 password = "etcnjl8juSU1E";
512
513 /* rsa key: the public key for this oper when using Challenge.
5c0df0e7 514 * A password should not be defined when this is used, see
212380e3
AC
515 * doc/challenge.txt for more information.
516 */
517 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
518
ff31db84
AC
519 /* fingerprint: if specified, the oper's client certificate
520 * fingerprint will be checked against the specified fingerprint
521 * below.
522 */
523 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
524
212380e3
AC
525 /* umodes: the specific umodes this oper gets when they oper.
526 * If this is specified an oper will not be given oper_umodes
527 * These are described above oper_only_umodes in general {};
528 */
529 #umodes = locops, servnotice, operwall, wallop;
530
531 /* snomask: specific server notice mask on oper up.
532 * If this is specified an oper will not be given oper_snomask.
533 */
534 snomask = "+Zbfkrsuy";
535
da77b103
JT
536 /* flags: misc options for the operator. You may prefix an option
537 * with ~ to disable it, e.g. ~encrypted.
212380e3 538 *
da77b103 539 * Default flags are encrypted.
212380e3
AC
540 *
541 * Available options:
542 *
543 * encrypted: the password above is encrypted [DEFAULT]
b1594414 544 * need_ssl: must be using SSL/TLS to oper up
da1b891f 545 */
da77b103
JT
546 flags = encrypted;
547
548 /* privset: privileges set to grant */
549 privset = "admin";
212380e3
AC
550};
551
552/* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
553connect "irc.uplink.com" {
554 /* the name must go above */
555
556 /* host: the host or IP to connect to. If a hostname is used it
557 * must match the reverse dns of the server.
558 */
cba8bbc3 559 host = "203.0.113.3";
212380e3
AC
560
561 /* vhost: the host or IP to bind to for this connection. If this
562 * is not specified, the default vhost (in serverinfo {}) is used.
563 */
cba8bbc3 564 #vhost = "192.0.2.131";
212380e3
AC
565
566 /* passwords: the passwords we send (OLD C:) and accept (OLD N:).
567 * The remote server will have these passwords reversed.
568 */
569 send_password = "password";
570 accept_password = "anotherpassword";
571
3cc262f0
AJ
572 /* fingerprint: if flags = ssl is specified, the server's
573 * certificate fingerprint will be checked against the fingerprint
574 * specified below. required if using flags = ssl.
ff0cc1e6
AC
575 */
576 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
577
212380e3
AC
578 /* port: the port to connect to this server on */
579 port = 6666;
580
581 /* hub mask: the mask of servers that this server may hub. Multiple
582 * entries are permitted
583 */
584 hub_mask = "*";
585
586 /* leaf mask: the mask of servers this server may not hub. Multiple
587 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
588 */
589 #leaf_mask = "*.uk";
590
591 /* class: the class this server is in */
592 class = "server";
593
594 /* flags: controls special options for this server
595 * encrypted - marks the accept_password as being crypt()'d
596 * autoconn - automatically connect to this server
597 * compressed - compress traffic via ziplinks
598 * topicburst - burst topics between servers
b8730cbf 599 * ssl - ssl/tls encrypted server connections
087555a0 600 * no-export - marks the link as a no-export link (not exported to other links)
212380e3
AC
601 */
602 flags = compressed, topicburst;
603};
604
0e1f3667 605connect "ipv6.lame.server" {
d4214e94 606 host = "192.0.2.1";
cba8bbc3 607 host = "2001:db8:3::8";
da1b891f
KB
608 send_password = "password";
609 accept_password = "password";
610 port = 6666;
212380e3 611
d4214e94
SA
612 /* aftype: controls whether the outgoing connection uses "ipv4" or "ipv6".
613 * Default is to try either at random.
212380e3
AC
614 */
615 aftype = ipv6;
da1b891f 616 class = "server";
212380e3
AC
617};
618
b8730cbf
VY
619connect "ssl.uplink.com" {
620 /* Example of ssl server-to-server connection, ssl flag doesn't need
621 * compressed flag, 'cause it uses own compression
622 */
cba8bbc3 623 host = "203.0.113.129";
b8730cbf
VY
624 send_password = "password";
625 accept_password = "anotherpassword";
626 port = 9999;
627 hub_mask = "*";
628 class = "server";
629 flags = ssl, topicburst;
630};
631
212380e3
AC
632/* cluster {}; servers that we propagate things to automatically.
633 * NOTE: This does NOT grant them privileges to apply anything locally,
634 * you must add a seperate shared block for that. Clustering will
635 * only be done for actions by LOCAL opers, that arent directed
636 * remotely.
637 */
638cluster {
639 /* name: the server to share with, this can be a wildcard and may be
640 * stacked.
641 */
642 /* flags: list of what to share, all the name lines above this (up
643 * until another flags entry) will receive these flags.
644 *
645 * kline - share perm klines
646 * tkline - share temp klines
647 * unkline - share unklines
648 * locops - share locops
649 * xline - share perm xlines
650 * txline - share temp xlines
651 * unxline - share unxlines
652 * resv - share perm resvs
653 * tresv - share temp resvs
654 * unresv - share unresvs
655 * all - share all of the above
656 */
657
0e1f3667
EM
658 /* share klines/unklines/xlines with *.lan */
659 name = "*.lan";
212380e3
AC
660 flags = kline, unkline, xline;
661
662 /* share locops with irc.ircd-ratbox.org and ircd.ircd-ratbox.org */
663 name = "irc.ircd-ratbox.org";
664 name = "ircd.ircd-ratbox.org";
665 flags = locops;
666};
667
668/* service{}: privileged servers (services). These servers have extra
669 * privileges such as setting login names on users and introducing clients
670 * with umode +S (unkickable, hide channels, etc). This does not allow them
671 * to set bans, you need a separate shared{} for that.
672 * Do not place normal servers here.
673 * There may be only one service{} block.
674 */
675service {
676 /* name: the server name. These may be stacked. */
677 name = "services.int";
678};
679
680/* shared {}: users that are allowed to place remote bans on our server.
681 * NOTE: These are ordered top down. The first one the user@host and server
682 * matches will be used. Their access will then be decided on that
683 * block and will not fall back to another block that matches.
684 */
685shared {
686 /* oper: the user@host and server the user must be on to set klines.
687 * The first field must be a user@host, the second field is an
688 * optional server. These may be stacked.
689 */
690 /* flags: list of what to allow them to place, all the oper lines
691 * above this (up until another flags entry) will receive these
692 * flags. This *must* be present.
693 *
694 * kline - allow setting perm/temp klines
695 * tkline - allow setting temp klines
696 * unkline - allow removing klines
697 * xline - allow setting perm/temp xlines
698 * txline - allow setting temp xlines
699 * unxline - allow removing xlines
700 * resv - allow setting perm/temp resvs
701 * tresv - allow setting temp resvs
702 * unresv - allow removing xlines
703 * all - allow oper/server to do all of above.
704 * locops - allow locops - only used for servers who cluster
da1b891f 705 * rehash - allow rehashing
d8d2cb0a
JT
706 * dline - allow setting perm/temp dlines
707 * tdline - allow setting temp dlines
708 * undline - allow removing dlines
fe749d37 709 * grant - allow granting operator status
cc7ae51c 710 * die - allow remote DIE/RESTART
15feac53 711 * module - allow remote module commands
212380e3
AC
712 * none - disallow everything
713 */
714
715 /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
716 * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
717 */
718 oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
719 oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
720 flags = kline;
721
722 /* you may forbid certain opers/servers from doing anything */
723 oper = "irc@vanity.oper", "*";
724 oper = "*@*", "irc.vanity.server";
725 oper = "irc@another.vanity.oper", "bigger.vanity.server";
726 flags = none;
727
728 /* or allow everyone to place temp klines */
729 oper = "*@*";
730 flags = tkline;
731};
732
b808adf9 733/* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
212380e3 734exempt {
cba8bbc3 735 ip = "192.0.2.0/24";
212380e3
AC
736
737 /* these may be stacked */
738 ip = "127.0.0.1";
212380e3
AC
739};
740
741/* The channel block contains options pertaining to channels */
742channel {
743 /* invex: Enable/disable channel mode +I, a n!u@h list of masks
744 * that can join a +i channel without an invite.
745 */
746 use_invex = yes;
747
748 /* except: Enable/disable channel mode +e, a n!u@h list of masks
749 * that can join a channel through a ban (+b).
750 */
751 use_except = yes;
752
2da6f6eb
JT
753 /* forward: Enable/disable channel mode +f, a channel to forward
754 * users to if they can't join because of +i etc. Also enables ban
755 * forwarding, <mask>$<channel>.
756 */
757 use_forward = yes;
758
212380e3
AC
759 /* knock: Allows users to request an invite to a channel that
760 * is locked somehow (+ikl). If the channel is +p or you are banned
761 * the knock will not be sent.
762 */
763 use_knock = yes;
764
212380e3
AC
765 /* knock delay: The amount of time a user must wait between issuing
766 * the knock command.
767 */
768 knock_delay = 5 minutes;
769
770 /* knock channel delay: How often a knock to any specific channel
771 * is permitted, regardless of the user sending the knock.
772 */
773 knock_delay_channel = 1 minute;
774
775 /* max chans: The maximum number of channels a user can join/be on. */
776 max_chans_per_user = 15;
777
a4721f5e
AC
778 /* max chans (large): The extended maximum number of channels a user can join. */
779 max_chans_per_user_large = 60;
780
da1b891f
KB
781 /* max bans: maximum number of +b/e/I/q modes in a channel */
782 max_bans = 100;
212380e3 783
da1b891f
KB
784 /* max bans: maximum number of +b/e/I/q modes in a +L channel */
785 max_bans_large = 500;
212380e3 786
da1b891f 787 /* splitcode: split users, split servers and either no join on split
212380e3
AC
788 * or no create on split must be enabled for split checking.
789 * splitmode will be entered on either split users or split servers
790 * dropping below the limit.
791 *
792 * you may force splitmode to be permanent by /quote set splitmode on
793 */
794
795 /* split users: when the usercount is lower than this level, consider
796 * ourselves split. this must be set for automatic splitmode
797 */
798 default_split_user_count = 0;
799
800 /* split servers: when the amount of servers that have acknowledged
5c0df0e7 801 * theyve finished bursting is lower than this, consider ourselves
212380e3
AC
802 * split. this must be set for automatic splitmode
803 */
804 default_split_server_count = 0;
805
806 /* split: no create: disallow users creating channels on split */
807 no_create_on_split = no;
808
809 /* split: no join: disallow users joining channels at all on a split */
810 no_join_on_split = no;
811
812 /* burst topicwho: when bursting topics, also burst the topic setter */
813 burst_topicwho = yes;
814
815 /* kick on split riding: kick users riding splits to join +i or +k
816 * channels. more precisely, if a bursting server sends an SJOIN
817 * for a channel with a lower TS with either a +i mode or a +k
818 * mode with a different key, kick all local users.
819 *
820 * note: this does not take +r, +b, +e and +I into account.
212380e3
AC
821 */
822 kick_on_split_riding = no;
6865c0b0
JT
823
824 /* only ascii channels: disable local users joining channels
825 * containing characters outside the range 33-126 (non-printable
826 * or non-ASCII).
827 */
828 only_ascii_channels = no;
da1b891f 829
c2c25552
JT
830 /* resv_forcepart: force any local users to part a channel
831 * when a RESV is issued.
832 */
833 resv_forcepart = yes;
717238d2
JT
834
835 /* channel target change: restrict how many channels users can
836 * message per unit of time. IRC operators, channel operators and
837 * voiced users are exempt.
838 */
839 channel_target_change = yes;
341f971e
SB
840
841 /* disable local channels: if yes, then local channels will not be
842 * supported.
843 */
844 disable_local_channels = no;
63eb8567
AC
845
846 /* autochanmodes: the channel modes that should be automatically set
847 * when a channel is created.
848 */
849 autochanmodes = "+nt";
d513218a
AC
850
851 /* displayed_usercount: the minimum amount of users on a channel before it
852 * is displayed in LIST. this parameter can be overridden using ELIST parameters,
853 * such as LIST >0.
854 */
855 displayed_usercount = 3;
14482679
AC
856
857 /* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */
858 strip_topic_colors = no;
04e5ed6c
JK
859
860 /* opmod_send_statusmsg: format messages sent to ops due to +z
861 * as PRIVMSG @#channel when sent to clients.
862 */
863 opmod_send_statusmsg = no;
212380e3
AC
864};
865
866
867/* The serverhide block contains the options regarding serverhiding */
868serverhide {
4acf2281
JT
869 /* flatten links: this option will hide various routing information
870 * and make all servers in /links appear that they are linked to
871 * this server.
212380e3
AC
872 */
873 flatten_links = no;
874
994544c2
JT
875 /* links delay: how long to wait before showing splits or new
876 * servers in a flattened /links output.
212380e3
AC
877 */
878 links_delay = 5 minutes;
879
4acf2281
JT
880 /* hidden: hide this server from a /links output on servers with
881 * flatten_links enabled. this allows hub servers to be hidden etc.
212380e3 882 */
da1b891f 883 hidden = no;
212380e3
AC
884
885 /* disable hidden: prevent servers hiding themselves from a
886 * /links ouput.
887 */
888 disable_hidden = no;
889};
890
891/* These are the blacklist settings.
892 * You can have multiple combinations of host and rejection reasons.
b2324470 893 * They are used in pairs of one host/rejection reason.
212380e3 894 *
f105844a 895 * These settings should be adequate for most networks.
212380e3
AC
896 *
897 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
898 * connections.
899 *
92fb5c31
AC
900 * As of charybdis 2.2, you can do some keyword substitution on the rejection
901 * reason. The available keyword substitutions are:
902 *
903 * ${ip} - the user's IP
904 * ${host} - the user's canonical hostname
905 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
906 * ${nick} - the user's nickname
907 * ${network-name} - the name of the network
908 *
0a1e77c2
EM
909 * As of charybdis 3.4, a type parameter is supported, which specifies the
910 * address families the blacklist supports. IPv4 and IPv6 are supported.
911 * IPv4 is currently the default as few blacklists support IPv6 operation
912 * as of this writing.
913 *
3c93d380
EM
914 * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
915 * is considered a match. If included, a comma-separated list of *quoted*
916 * strings is allowed to match queries. They may be of the format "0" to "255"
917 * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
918 * an A record. The blacklist is only applied if it matches anything in the
f0bce9d9 919 * list. You may freely mix full IP's and final octets.
5c0df0e7 920 *
f0bce9d9
EM
921 * Consult your blacklist provider for the meaning of these parameters; they
922 * are usually used to denote different ban types.
212380e3 923 */
57b8cb0f 924blacklist {
40e92fca 925 host = "rbl.efnetrbl.org";
0a1e77c2 926 type = ipv4;
40e92fca 927 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
57b8cb0f 928
3c93d380 929 /* Example of a blacklist that supports both IPv4 and IPv6 and using matches */
0a1e77c2 930# host = "foobl.blacklist.invalid";
3c93d380 931# matches = "4", "6", "127.0.0.10";
0a1e77c2
EM
932# type = ipv4, ipv6;
933# 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 934};
212380e3 935
8275e270
EM
936/* These are the OPM settings.
937 * This is similar to the functionality provided by BOPM. It will scan incoming
938 * connections for open proxies by connecting to clients and attempting several
939 * different open proxy handshakes. If they connect back to us (via a dedicated
940 * listening port), and send back the data we send them, they are considered
941 * an open proxy. For politeness reasons (users may be confused by the incoming
942 * connection attempts if they are logging incoming connections), the user is
943 * notified upon connect if they are being scanned.
944 *
945 * WARNING:
cfb92536
EM
946 * These settings are considered experimental. Only the most common proxy types
947 * are checked for (Charybdis is immune from POST and GET proxies). If you are
28f87746 948 * not comfortable with experimental code, do not use this feature.
8275e270 949 */
28f87746 950#opm {
8275e270
EM
951 /* IPv4 address to listen on. This must be a publicly facing IP address
952 * to be effective.
953 * If omitted, it defaults to serverinfo::vhost.
954 */
955 #listen_ipv4 = "127.0.0.1";
956
957 /* IPv4 port to listen on.
958 * This should not be the same as any existing listeners.
959 */
e2a06878 960 #port_v4 = 32000;
8275e270
EM
961
962 /* IPv6 address to listen on. This must be a publicly facing IP address
963 * to be effective.
964 * If omitted, it defaults to serverinfo::vhost6.
965 */
d4214e94 966 #listen_ipv6 = "::1";
8275e270
EM
967
968 /* IPv6 port to listen on.
969 * This should not be the same as any existing listeners.
970 */
e2a06878 971 #port_v6 = 32000;
8275e270 972
4dbed1ed
EM
973 /* You can also set the listen_port directive which will set both the
974 * IPv4 and IPv6 ports at once.
8275e270 975 */
28f87746 976 #listen_port = 32000;
51fa2ab8 977
9bba0f61
EM
978 /* This sets the timeout in seconds before ending open proxy scans.
979 * Values less than 1 or greater than 60 are ignored.
980 * It is advisable to keep it as short as feasible, so clients do not
981 * get held up by excessively long scan times.
982 */
28f87746 983 #timeout = 5;
9bba0f61 984
51fa2ab8
EM
985 /* These are the ports to scan for SOCKS4 proxies on. They may overlap
986 * with other scan types. Sensible defaults are given below.
987 */
28f87746 988 #socks4_ports = 80, 443, 1080, 8000, 8080, 10800;
51fa2ab8
EM
989
990 /* These are the ports to scan for SOCKS5 proxies on. They may overlap
991 * with other scan types. Sensible defaults are given below.
992 */
28f87746 993 #socks5_ports = 80, 443, 1080, 8000, 8080, 10800;
fabe8b94 994
eb0814b3 995 /* These are the ports to scan for HTTP CONNECT proxies on (plaintext).
fabe8b94
EM
996 * They may overlap with other scan types. Sensible defaults are given
997 * below.
998 */
28f87746 999 #httpconnect_ports = 80, 8080, 8000;
eb0814b3
EM
1000
1001 /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
1002 * They may overlap with other scan types. Sensible defaults are given
1003 * below.
1004 */
28f87746
AJ
1005 #httpsconnect_ports = 443, 4443;
1006#};
8275e270 1007
212380e3
AC
1008/*
1009 * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
1010 * They send PRIVMSG to the given target. A real command takes
1011 * precedence above an alias.
1012 */
1013alias "NickServ" {
1014 /* the name must go above */
1015
1016 /* target: the target nick (must be a network service) or
1017 * user@server (cannot be this server, only opers can use
1018 * user starting with "opers" reliably, interpreted on the target
1019 * server only so you may need to use nick@server instead)
1020 */
1021 target = "NickServ";
1022};
1023
1024alias "ChanServ" {
1025 target = "ChanServ";
1026};
1027
1028alias "OperServ" {
1029 target = "OperServ";
1030};
1031
1032alias "MemoServ" {
1033 target = "MemoServ";
1034};
1035
1036alias "NS" {
1037 target = "NickServ";
1038};
1039
1040alias "CS" {
1041 target = "ChanServ";
1042};
1043
1044alias "OS" {
1045 target = "OperServ";
1046};
1047
1048alias "MS" {
1049 target = "MemoServ";
1050};
1051
1052/* The general block contains many of the options that were once compiled
1053 * in options in config.h. The general block is read at start time.
1054 */
1055general {
1056 /* hide error messages: defines whether error messages from
922aa826
JT
1057 * servers that are not deemed fully safe are hidden or not.
1058 * These can sometimes contain IPs and can have an adverse
1059 * effect on server ip hiding. Set to:
212380e3
AC
1060 * yes: hide from opers and admin
1061 * opers: hide from opers only
1062 * no: do not hide error messages
922aa826 1063 * Admins on other servers count as opers.
212380e3
AC
1064 */
1065 hide_error_messages = opers;
1066
1067 /* hide spoof ips: hide the real ips of auth{} spoofed users
1068 * If disabled, local opers can see them.
1069 * Dynamic spoofs (e.g. set by services) are unaffected by this;
1070 * any oper (local and remote) can see the real ip.
212380e3
AC
1071 */
1072 hide_spoof_ips = yes;
1073
1074 /* default umodes: umodes to set upon connection
1075 * If you have enabled the ip_cloaking extension, and you wish for
a8560aff 1076 * incoming clients to be set +h or +x upon connection, add +h or +x to the umode
212380e3
AC
1077 * string below.
1078 */
1079 default_umodes = "+i";
1080
1081 /* default operstring: defines the default oper response
1082 * in /whois queries, eg "is an IRC Operator".
1083 * After startup use /quote set operstring to change.
1084 */
1085 default_operstring = "is an IRC Operator";
1086
1087 /* default adminstring: defines the default admin response
1088 * in /whois queries, eg "is a Server Administrator".
1089 * After startup use /quote set adminstring to change.
1090 */
1091 default_adminstring = "is a Server Administrator";
1092
1093 /* servicestring: defines the response for opered services (+S)
1094 * in /whois queries, eg "is a Network Service".
1095 * This is updated on rehash.
1096 */
1097 servicestring = "is a Network Service";
1098
7d33cce8
MT
1099 /*
1100 * Nick of the network's SASL agent. Used to check whether services are here,
1101 * SASL credentials are only sent to its server. Needs to be a service.
1102 *
1103 * Defaults to SaslServ if unspecified.
1104 */
1105 sasl_service = "SaslServ";
1106
212380e3
AC
1107 /* disable fake channels: disable local users joining fake versions
1108 * of channels, eg #foo^B^B. Disables bold, mirc colour, reverse,
1109 * underline and hard space. (ASCII 2, 3, 22, 31, 160 respectively).
1110 */
1111 disable_fake_channels = no;
1112
da1b891f
KB
1113 /* tkline_expire_notices: give a notice to opers when a tkline
1114 * expires
1115 */
1116 tkline_expire_notices = no;
212380e3
AC
1117
1118 /* floodcount: the default value of floodcount that is configurable
1119 * via /quote set floodcount. This is the amount of lines a user
1120 * may send to any other user/channel in one second.
1121 */
da1b891f 1122 default_floodcount = 10;
212380e3 1123
5c0df0e7 1124 /* failed oper notice: send a notice to all opers on the server when
212380e3
AC
1125 * someone tries to OPER and uses the wrong password, host or ident.
1126 */
1127 failed_oper_notice = yes;
1128
1129 /* dots in ident: the amount of '.' characters permitted in an ident
1130 * reply before the user is rejected.
1131 */
3bb3dcf7 1132 dots_in_ident = 2;
212380e3 1133
da1b891f 1134 /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
212380e3
AC
1135 * placed via the server. klines hand placed are exempt from limits.
1136 * wildcard chars: '.' '*' '?' '@'
1137 */
1138 min_nonwildcard = 4;
1139
1140 /* min nonwildcard simple: the minimum non wildcard characters in
1141 * xlines/resvs placed via the server.
1142 * wildcard chars: '*' '?'
1143 */
1144 min_nonwildcard_simple = 3;
1145
da1b891f
KB
1146 /* max accept: maximum allowed /accept's for +g usermode */
1147 max_accept = 20;
212380e3 1148
5f8fb56d
AW
1149 /* max monitor: the maximum amount of nicknames a client may have in
1150 * their monitor (server-side notify) list.
1151 */
1152 max_monitor = 100;
1153
212380e3
AC
1154 /* nick flood: enable the nickflood control code */
1155 anti_nick_flood = yes;
1156
1157 /* nick flood: the nick changes allowed in the specified period */
1158 max_nick_time = 20 seconds;
1159 max_nick_changes = 5;
1160
da1b891f 1161 /* anti spam time: the minimum time a user must be connected before
212380e3
AC
1162 * custom quit messages are allowed.
1163 */
da1b891f 1164 anti_spam_exit_message_time = 5 minutes;
212380e3
AC
1165
1166 /* ts delta: the time delta allowed between server clocks before
1167 * a warning is given, or before the link is dropped. all servers
1168 * should run ntpdate/rdate to keep clocks in sync
1169 */
1170 ts_warn_delta = 30 seconds;
1171 ts_max_delta = 5 minutes;
1172
f09c28e1 1173 /* client exit: prepend a user's quit message with "Quit: " */
212380e3
AC
1174 client_exit = yes;
1175
1176 /* collision fnc: change user's nick to their UID instead of
1177 * killing them, if possible. This setting only applies to nick
1178 * collisions detected on this server. Only enable this if
1179 * all servers on the network allow remote nicks to start with
1180 * a digit.
1181 */
1182 collision_fnc = yes;
1183
330692a1
KB
1184 /* resv fnc: change a user's nick to a nick they have recently used
1185 * (or their UID, if no such nick can be found) when a resv matching
1186 * them is set by services. Only enable this if all servers on the
1187 * network allow remote nicks to start with a digit.
1188 */
1189 resv_fnc = yes;
1190
212380e3
AC
1191 /* global snotices: send out certain snotices (most +b, +f, +y,
1192 * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
1193 * displayed unconditionally.
1194 */
1195 global_snotices = yes;
5c0df0e7
MU
1196
1197 /* dline reason: show the user the dline reason when they connect
212380e3
AC
1198 * and are dlined.
1199 */
1200 dline_with_reason = yes;
5c0df0e7 1201
5c0df0e7 1202 /* kline reason: show the user the reason why they are k/dlined
212380e3
AC
1203 * on exit. may give away who set k/dline when set via tcm.
1204 */
1205 kline_with_reason = yes;
1206
6292d72b
EK
1207 /* tkline duration: when showing users their k/dline reason (see
1208 * kline_with_reason), don't add "Temporary K-line 123 min."
1209 */
1210 hide_tkdline_duration = no;
1211
212380e3
AC
1212 /* kline reason: make the users quit message on channels this
1213 * reason instead of the oper's reason.
1214 */
1215 kline_reason = "Connection closed";
1216
1217 /* identify to services via server password
1218 * if auth{} block had no password but the user specified a
1219 * server password anyway, send a PRIVMSG to <identify_service>
1220 * with as text <identify_command> <password>.
1221 */
1222 identify_service = "NickServ@services.int";
1223 identify_command = "IDENTIFY";
1224
1225 /* non redundant klines: flag and ignore redundant klines */
1226 non_redundant_klines = yes;
1227
1228 /* warn no nline: warn opers about servers that try to connect but
5c0df0e7 1229 * we dont have a connect {} block for. Twits with misconfigured
212380e3
AC
1230 * servers can get really annoying with this enabled.
1231 */
1232 warn_no_nline = yes;
1233
dca9e552 1234 /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
3cbbfb25
JT
1235 * That means the bans are part of the netburst and restarted/split
1236 * servers will get them, but they will not apply to 3.2 and older
1237 * servers at all.
1702b694
JT
1238 */
1239 use_propagated_bans = yes;
1240
212380e3
AC
1241 /* stats e disabled: disable stats e. useful if server ips are
1242 * exempted and you dont want them listing on irc.
1243 */
1244 stats_e_disabled = no;
1245
1246 /* stats c oper only: make stats c (connect {}) oper only */
3bb3dcf7 1247 stats_c_oper_only = no;
212380e3
AC
1248
1249 /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
3bb3dcf7 1250 stats_h_oper_only = no;
212380e3
AC
1251
1252 /* stats y oper only: make stats y (class {}) oper only */
3bb3dcf7 1253 stats_y_oper_only = no;
212380e3
AC
1254
1255 /* stats o oper only: make stats o (opers) oper only */
3bb3dcf7 1256 stats_o_oper_only = yes;
212380e3
AC
1257
1258 /* stats P oper only: make stats P (ports) oper only
5c0df0e7 1259 * NOTE: users doing stats P will never be given the ips that the
212380e3
AC
1260 * server listens on, simply the ports.
1261 */
3bb3dcf7 1262 stats_P_oper_only = no;
212380e3
AC
1263
1264 /* stats i oper only: make stats i (auth {}) oper only. set to:
1265 * yes: show users no auth blocks, made oper only.
1266 * masked: show users first matching auth block
1267 * no: show users all auth blocks.
1268 */
3bb3dcf7 1269 stats_i_oper_only = masked;
212380e3
AC
1270
1271 /* stats k/K oper only: make stats k/K (klines) oper only. set to:
1272 * yes: show users no auth blocks, made oper only
1273 * masked: show users first matching auth block
1274 * no: show users all auth blocks.
1275 */
3bb3dcf7 1276 stats_k_oper_only = masked;
212380e3 1277
da1b891f
KB
1278 /* map oper only: make /map oper only */
1279 map_oper_only = no;
212380e3
AC
1280
1281 /* operspy admin only: make operspy notices to +Z admin only */
1282 operspy_admin_only = no;
1283
1284 /* operspy dont care user info: treat /who mask as if there was
1285 * an '!' always; do not log or server notice about operspy
1286 * /who mask, /masktrace and /scan. channel information is still
1287 * protected. */
1288 operspy_dont_care_user_info = no;
1289
1290 /* caller id wait: time between notifying a +g user that somebody
1291 * is messaging them.
1292 */
1293 caller_id_wait = 1 minute;
1294
1295 /* pace wait simple: time between use of less intensive commands
1296 * (HELP, remote WHOIS, WHOWAS)
1297 */
1298 pace_wait_simple = 1 second;
1299
1300 /* pace wait: time between more intensive commands
1301 * (ADMIN, INFO, LIST, LUSERS, MOTD, STATS, VERSION)
1302 */
1303 pace_wait = 10 seconds;
1304
1305 /* short motd: send clients a notice telling them to read the motd
1306 * instead of forcing a motd to clients who may simply ignore it.
1307 */
1308 short_motd = no;
1309
1310 /* ping cookies: require clients to respond exactly to a ping command,
1311 * can help block certain types of drones and FTP PASV mode spoofing.
1312 */
1313 ping_cookie = no;
1314
1315 /* connect timeout: sets how long we should wait for a connection
1316 * request to succeed
1317 */
1318 connect_timeout = 30 seconds;
1319
0ffb8106
JH
1320 /* ident timeout: Amount of time (in seconds) that the IRCd will
1321 * wait for a user to respond to an ident request.
1322 */
944b0584 1323 default_ident_timeout = 5;
0ffb8106 1324
212380e3
AC
1325 /* disable auth: disables identd checking */
1326 disable_auth = no;
1327
1328 /* no oper flood: increase flood limits for opers. */
1329 no_oper_flood = yes;
1330
212380e3
AC
1331 /* REMOVE ME. The following line checks you've been reading. */
1332 havent_read_conf = yes;
5c0df0e7
MU
1333
1334 /* max targets: the maximum amount of targets in a single
212380e3
AC
1335 * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
1336 */
1337 max_targets = 4;
1338
b3a00991
SB
1339 /* post-registration delay: wait this long before processing commands from a newly
1340 * registered user. Used to allow network utility bots to perform any actions
1341 * (such as host changes or proxy scanning) before the user can join channels.
1342 */
1343 post_registration_delay = 2 seconds;
1344
da1b891f
KB
1345 /* use_whois_actually: send clients requesting a whois a numeric
1346 * giving the real IP of non-spoofed clients to prevent DNS abuse.
1347 */
1348 use_whois_actually = yes;
212380e3
AC
1349
1350 /* usermodes configurable: a list of usermodes for the options below
1351 *
1352 * +g - callerid - Server Side Ignore
1353 * +D - deaf - Don't see channel messages
5c0df0e7 1354 * +i - invisible - Not shown in NAMES or WHO unless you share a
212380e3
AC
1355 * a channel
1356 * +l - locops - See LOCOPS messages
1357 * +Q - noforward - Unaffected by channel forwarding
1358 * +R - regonlymsg - No messages from unindentified
1359 * +s - servnotice - See server notices
1360 * +w - wallop - See oper and server generated WALLOPS
1361 * +z - operwall - See operwalls
1362 */
5c0df0e7 1363
212380e3
AC
1364 /* oper only umodes: usermodes only opers may set */
1365 oper_only_umodes = operwall, locops, servnotice;
1366
1367 /* oper umodes: default usermodes opers get when they /oper */
1368 oper_umodes = locops, servnotice, operwall, wallop;
1369
1370 /* oper snomask: default snomask opers get when they /oper,
1371 * provided they have umode +s set */
1372 oper_snomask = "+s";
1373
212380e3 1374 /* compression level: level of compression for compressed links between
5c0df0e7 1375 * servers.
212380e3
AC
1376 *
1377 * values are between: 1 (least compression, fastest)
1378 * and: 9 (most compression, slowest).
1379 */
1380 #compression_level = 6;
1381
da1b891f
KB
1382 /* burst_away: This enables bursting away messages to servers.
1383 * With this disabled, we will only propogate AWAY messages
1384 * as users send them, but never burst them. Be warned though
1385 * enabling this could increase the size of a burst significantly
1386 * for a large network, like EFnet.
1387 */
1388 burst_away = yes;
212380e3
AC
1389
1390 /* nick delay: This locks nicks of split clients for the given time
1391 * or until a remote client uses the nick. This significantly
1392 * reduces nick collisions on short splits but it can be annoying.
1393 * To make things as fair as possible, this should be the same on
1394 * all servers. If you enable this, the suggested value is 15 minutes.
1395 */
1396 nick_delay = 0 seconds;
1397
1398 /* reject time: the amount of rejections through klines/dlines etc
1399 * allowed in the given time before the rejection is cached and
1400 * a pseudo temp dline is placed
1401 */
1402 reject_ban_time = 1 minute;
1403 reject_after_count = 3;
1404
1405 /* reject duration: the amount of time to cache the rejection */
1406 reject_duration = 5 minutes;
54015b5f 1407
43946961
JT
1408 /* throttle_duration: Amount of time that throttling will be applied to an IP
1409 * address.
54015b5f 1410 */
43946961
JT
1411 throttle_duration = 60;
1412
1413 /* throttle_count: Number of connections within throttle_duration that it takes
1414 * for throttling to take effect */
1415 throttle_count = 4;
e6e54763 1416
da1b891f
KB
1417 /* client flood_max_lines: maximum number of lines in a clients queue before
1418 * they are dropped for flooding.
1419 */
1420 client_flood_max_lines = 20;
1421
1422 /* Flood control settings. DO NOT CHANGE THESE without extensive discussion
1423 * and testing by someone who knows exactly what they do.
1424 *
1425 * These settings replicate charybdis-3.3 behaviour.
1426 */
1427 client_flood_burst_rate = 40;
1428 client_flood_burst_max = 5;
1429 client_flood_message_time = 1;
1430 client_flood_message_num = 2;
e88a1f1b
KB
1431
1432 /* max_ratelimit_tokens: the maximum number of ratelimit tokens that one
1433 * user can accumulate. This attempts to limit the amount of outbound
1434 * bandwidth one user can consume. Do not change unless you know what
1435 * you're doing.
1436 */
1437 max_ratelimit_tokens = 30;
d42e6915
JT
1438
1439 /* away_interval: the minimum interval between AWAY commands. One
1440 * additional AWAY command is allowed, and only marking as away
1441 * counts.
1442 */
1443 away_interval = 30;
13d8f0ed
AC
1444
1445 /* certfp_method: the method that should be used for computing certificate fingerprints.
cf430c1a
SA
1446 * Acceptable options are sha1, sha256, spki_sha256, sha512 and spki_sha512. Networks
1447 * running versions of charybdis prior to charybdis 3.5 MUST use sha1 for certfp_method.
1448 *
1449 * The spki_* variants operate on the SubjectPublicKeyInfo of the certificate, which does
1450 * not change unless the private key is changed. This allows the fingerprint to stay
dc986b54 1451 * constant even if the certificate is reissued. These fingerprints will be prefixed with
66214724 1452 * "SPKI:SHA2-256:" or "SPKI:SHA2-512:" depending on the hash type. These fingerprints
4381284e 1453 * are not supported on servers running charybdis 3.5.3 or earlier.
66214724
AJ
1454 *
1455 * To generate a fingerprint from a certificate file, please use the mkfingerprint utility
1456 * program located in the bin/ subdirectory of your IRCd installation. Running it with no
1457 * arguments will give you a brief usage message; it takes method and filename arguments.
13d8f0ed 1458 */
7380ded5 1459 certfp_method = spki_sha256;
71c95533
AC
1460
1461 /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
1462 hide_opers_in_whois = no;
fff4f763
EK
1463
1464 /* tls_ciphers_oper_only: show the TLS cipher string in /WHOIS only to opers and self */
1465 tls_ciphers_oper_only = no;
212380e3
AC
1466};
1467
1468modules {
5c0df0e7 1469 /* module path: paths to search for modules specified below and
212380e3
AC
1470 * in /modload.
1471 */
1472 path = "/usr/local/ircd/modules";
1473 path = "/usr/local/ircd/modules/autoload";
1474
1475 /* module: the name of a module to load on startup/rehash */
9abdcf1c 1476 #module = "some_module";
212380e3 1477};