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