1 /* doc/example.conf - brief example configuration file
3 * Copyright (C) 2000-2002 Hybrid Development Team
4 * Copyright (C) 2002-2005 ircd-ratbox development team
5 * Copyright (C) 2005-2006 charybdis development team
7 * $Id: example.conf 3582 2007-11-17 21:55:48Z jilles $
9 * See reference.conf for more information.
13 #loadmodule "extensions/chm_adminonly.so";
14 loadmodule "extensions/chm_operonly.so";
15 #loadmodule "extensions/chm_sslonly.so";
16 #loadmodule "extensions/chm_operonly_compat.so";
17 #loadmodule "extensions/chm_quietunreg_compat.so";
18 #loadmodule "extensions/chm_sslonly_compat.so";
19 #loadmodule "extensions/createauthonly.so";
20 loadmodule "extensions/extb_account.so";
21 loadmodule "extensions/extb_canjoin.so";
22 loadmodule "extensions/extb_channel.so";
23 loadmodule "extensions/extb_extgecos.so";
24 loadmodule "extensions/extb_oper.so";
25 loadmodule "extensions/extb_realname.so";
26 #loadmodule "extensions/extb_server.so";
27 #loadmodule "extensions/extb_ssl.so";
28 #loadmodule "extensions/hurt.so";
29 loadmodule "extensions/ip_cloaking.so";
30 #loadmodule "extensions/m_findforwards.so";
31 loadmodule "extensions/m_identify.so";
32 loadmodule "extensions/m_mkpasswd.so";
33 loadmodule "extensions/m_webirc.so";
34 #loadmodule "extensions/m_cycle.so";
35 #loadmodule "extensions/m_oaccept.so";
36 #loadmodule "extensions/m_opme.so";
37 #loadmodule "extensions/m_ojoin.so";
38 #loadmodule "extensions/m_omode.so";
39 #loadmodule "extensions/m_olist.so";
40 #loadmodule "extensions/m_okick.so";
41 #loadmodule "extensions/m_force.so";
42 #loadmodule "extensions/no_oper_invis.so";
43 loadmodule "extensions/sno_farconnect.so";
44 loadmodule "extensions/sno_globalkline.so";
45 loadmodule "extensions/sno_globaloper.so";
46 #loadmodule "extensions/sno_whois.so";
51 description = "shadowircd test server";
52 network_name = "AthemeNET";
53 network_desc = "Your IRC network.";
55 helpurl = "http://www.mynet.net/help";
58 /* On multi-homed hosts you may need the following. These define
59 * the addresses we connect from to other servers. */
61 #vhost = "192.169.0.1";
63 #vhost6 = "3ffe:80e8:546::2";
65 /* ssl_private_key: our ssl private key */
66 ssl_private_key = "etc/test.key";
68 /* ssl_cert: certificate for our ssl server */
69 ssl_cert = "etc/test.cert";
71 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
72 ssl_dh_params = "etc/dh.pem";
74 /* ssld_count: number of ssld processes you want to start, if you
75 * have a really busy server, using N-1 where N is the number of
76 * cpu/cpu cores you have might be useful. A number greater than one
77 * can also be useful in case of bugs in ssld and because ssld needs
78 * two file descriptors per SSL connection.
82 /* default max clients: the default maximum number of clients
83 * allowed to connect. This can be changed once ircd has started by
85 * /quote set maxclients <limit>
87 default_max_clients = 1024;
91 name = "Lazy admin (lazya)";
92 description = "AthemeNET client server";
93 email = "nobody@127.0.0.1";
97 fname_userlog = "logs/userlog";
98 #fname_fuserlog = "logs/fuserlog";
99 fname_operlog = "logs/operlog";
100 #fname_foperlog = "logs/foperlog";
101 fname_serverlog = "logs/serverlog";
102 #fname_klinelog = "logs/klinelog";
103 fname_killlog = "logs/killlog";
104 fname_operspylog = "logs/operspylog";
105 #fname_ioerrorlog = "logs/ioerror";
108 /* class {} blocks MUST be specified before anything that uses them. That
109 * means they must be defined before auth {} and before connect {}.
112 ping_time = 2 minutes;
113 number_per_ident = 10;
115 number_per_ip_global = 50;
116 cidr_ipv4_bitlen = 24;
117 cidr_ipv6_bitlen = 64;
118 number_per_cidr = 200;
124 ping_time = 5 minutes;
131 ping_time = 5 minutes;
132 connectfreq = 5 minutes;
138 /* If you want to listen on a specific IP only, specify host.
139 * host definitions apply only to the following port line.
141 #host = "192.169.0.1";
142 port = 5000, 6665 .. 6669;
145 /* Listen on IPv6 (if you used host= above). */
146 #host = "3ffe:1234:a:b:c::d";
147 #port = 5000, 6665 .. 6669;
151 /* auth {}: allow users to connect to the ircd (OLD I:)
152 * auth {} blocks MUST be specified in order of precedence. The first one
153 * that matches a user will be used. So place spoofs first, then specials,
154 * then general access, then restricted.
157 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
158 * lines are permitted per auth block. This is matched against the
159 * hostname and IP address (using :: shortening for IPv6 and
160 * prepending a 0 if it starts with a colon) and can also use CIDR
163 user = "*@172.16.0.0/12";
164 user = "*test@123D:B567:*";
166 /* password: an optional password that is required to use this block.
167 * By default this is not encrypted, specify the flag "encrypted" in
168 * flags = ...; below if it is.
170 password = "letmein";
172 /* spoof: fake the users user@host to be be this. You may either
173 * specify a host or a user@host to spoof to. This is free-form,
174 * just do everyone a favour and dont abuse it. (OLD I: = flag)
176 spoof = "I.still.hate.packets";
178 /* autojoin: Channel (or channels, comma-seperated) to join users
179 * in this auth block to on connect. Note that this won't join
180 * the user through any bans or otherwise restrictive chmodes.
182 autojoin = "#shadowircd,#test";
184 /* autojoin_opers : Channel (or channels, comma-seperated) to join
185 * opers to on oper-up.
187 autojoin_opers = "#opers,#help";
189 /* Possible flags in auth:
191 * encrypted | password is encrypted with mkpasswd
192 * spoof_notice | give a notice when spoofing hosts
193 * exceed_limit (old > flag) | allow user to exceed class user limits
194 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
195 * dnsbl_exempt | exempt this user from dnsbls
196 * spambot_exempt | exempt this user from spambot checks
197 * shide_exempt | exempt this user from serverhiding
198 * jupe_exempt | exempt this user from generating
199 * warnings joining juped channels
200 * resv_exempt | exempt this user from resvs
201 * flood_exempt | exempt this user from flood limits
203 * no_tilde (old - flag) | don't prefix ~ to username if no ident
204 * need_ident (old + flag) | require ident for user in this class
205 * need_ssl | require SSL/TLS for user in this class
206 * need_sasl | require SASL id for user in this class
208 flags = kline_exempt, exceed_limit;
210 /* class: the class the user is placed in */
214 /* Example WEBIRC authblock */
216 /* user: webirc@IP.OF.YOUR.WEBIRC . the webirc@ part is required */
217 user = "webirc@192.168.1.1";
219 /* password: password the webirc client sends in the WEBIRC command.
220 * You can use a encrypted password here (see above auth block).
222 password = "<password>";
224 /* spoof: This is required to keep it what it is currently if you
225 * want the webirc client to show the users' real host as their
237 /* privset {} blocks MUST be specified before anything that uses them. That
238 * means they must be defined before operator {}.
241 privs = oper:local_kill, oper:operwall;
244 privset "server_bot" {
245 extends = "local_op";
246 privs = oper:kline, oper:remoteban, snomask:nick_changes;
249 privset "global_op" {
250 extends = "local_op";
251 privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
252 oper:resv, oper:mass_notice, oper:remoteban;
256 extends = "global_op";
257 privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:override;
261 /* name: the name of the oper must go above */
263 /* user: the user@host required for this operator. CIDR *is*
264 * supported now. auth{} spoofs work here, other spoofs do not.
265 * multiple user="" lines are supported.
267 user = "*god@127.0.0.1";
269 /* password: the password required to oper. Unless ~encrypted is
270 * contained in flags = ...; this will need to be encrypted using
271 * mkpasswd, MD5 is supported
273 password = "etcnjl8juSU1E";
275 /* rsa key: the public key for this oper when using Challenge.
276 * A password should not be defined when this is used, see
277 * doc/challenge.txt for more information.
279 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
281 /* umodes: the specific umodes this oper gets when they oper.
282 * If this is specified an oper will not be given oper_umodes
283 * These are described above oper_only_umodes in general {};
285 #umodes = locops, servnotice, operwall, wallop;
287 /* fingerprint: if specified, the oper's client certificate
288 * fingerprint will be checked against the specified fingerprint
291 #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
293 /* snomask: specific server notice mask on oper up.
294 * If this is specified an oper will not be given oper_snomask.
296 snomask = "+Zbfkrsuy";
298 /* vhost: defines the vhost that this oper will get on oper up.
299 * this must be a valid hostmask. If this is specified the oper
300 * will not be given default_operhost.
302 vhost = "is.an.oper";
304 /* swhois: defines an additional line that will be displayed
305 * whenever someone does /whois on the oper in question.
307 swhois = "is wearing pants.";
309 /* operstring: defines a custom operstring for this oper,
310 * which will be shown in whois instead of default_operstring
311 * or default_adminstring.
313 operstring = "is a lazy IRC Operator";
315 /* flags: misc options for the operator. You may prefix an option
316 * with ~ to disable it, e.g. ~encrypted.
318 * Default flags are encrypted.
322 * encrypted: the password above is encrypted [DEFAULT]
323 * need_ssl: must be using SSL/TLS to oper up
327 /* privset: privileges set to grant */
331 connect "irc.uplink.com" {
332 host = "192.168.0.1";
333 send_password = "password";
334 accept_password = "anotherpassword";
338 flags = compressed, topicburst;
340 /* If the connection is IPv6, uncomment below.
341 * Use 0::1, not ::1, for IPv6 localhost. */
345 connect "ssl.uplink.com" {
346 host = "192.168.0.1";
347 send_password = "password";
348 accept_password = "anotherpassword";
352 flags = ssl, topicburst;
356 name = "services.int";
361 flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
369 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
375 autochanmodes = "nt";
376 admin_on_channel_create = no;
377 exemptchanops = "NT";
384 use_local_channels = yes;
385 knock_delay = 5 minutes;
386 knock_delay_channel = 1 minute;
387 max_chans_per_user = 15;
389 max_bans_large = 500;
390 default_split_user_count = 0;
391 default_split_server_count = 0;
392 no_create_on_split = no;
393 no_join_on_split = no;
394 burst_topicwho = yes;
395 kick_on_split_riding = no;
396 only_ascii_channels = no;
397 cycle_host_change = yes;
399 resv_forcepart = yes;
400 channel_target_change = yes;
405 links_delay = 5 minutes;
410 /* These are the blacklist settings.
411 * You can have multiple combinations of host and rejection reasons.
412 * They are used in pairs of one host/rejection reason.
414 * These settings should be adequate for most networks, and are (presently)
415 * required for use on AthemeNet.
417 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
420 * As of charybdis 2.1.3, you can do some keyword substitution on the rejection
421 * reason. The available keyword substitutions are:
423 * ${ip} - the user's IP
424 * ${host} - the user's canonical hostname
425 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
426 * ${nick} - the user's nickname
427 * ${network-name} - the name of the network
429 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
430 * contacted, via email, at admins@2mbit.com before using these BLs.
431 * See <http://www.ahbl.org/services.php> for more information.
434 host = "rbl.efnetrbl.org";
435 reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
437 host = "dnsbl.dronebl.org";
438 reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
440 # host = "ircbl.ahbl.org";
441 # reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for having an open proxy. In order to protect ${network-name} from abuse, we are not allowing connections with open proxies to connect.";
443 # host = "tor.ahbl.org";
444 # reject_reason = "${nick}, your IP (${ip}) is listed as a TOR exit node. In order to protect ${network-name} from tor-based abuse, we are not allowing TOR exit nodes to connect to our network.";
476 target = "GroupServ";
508 target = "GroupServ";
512 hide_error_messages = opers;
513 hide_spoof_ips = yes;
516 * default umodes: umodes to set upon connection
517 * If you have enabled the ip_cloaking extension, and you wish for
518 * incoming clients to be cloaked upon connection, +x must be in
519 * the umode string below.
521 default_umodes = "+ix";
523 default_operstring = "is an IRC Operator";
524 default_adminstring = "is a Server Administrator";
525 default_operhost = "staff.testnet.net";
526 #static_quit = "I like turtles!";
527 servicestring = "is a Network Service";
528 disable_fake_channels = no;
529 hide_channel_below_users = 3;
530 tkline_expire_notices = no;
531 default_floodcount = 10;
532 failed_oper_notice = yes;
535 min_nonwildcard_simple = 3;
538 anti_nick_flood = yes;
539 max_nick_time = 20 seconds;
540 max_nick_changes = 5;
541 anti_spam_exit_message_time = 5 minutes;
542 use_part_messages = yes;
543 ts_warn_delta = 30 seconds;
544 ts_max_delta = 5 minutes;
547 global_snotices = yes;
548 dline_with_reason = yes;
549 kline_delay = 0 seconds;
550 kline_with_reason = yes;
551 kline_reason = "K-Lined";
552 identify_service = "NickServ@services.int";
553 identify_command = "IDENTIFY";
554 non_redundant_klines = yes;
556 use_propagated_bans = yes;
557 stats_e_disabled = no;
558 stats_c_oper_only=no;
559 stats_h_oper_only=no;
560 stats_y_oper_only=no;
561 stats_o_oper_only=yes;
562 stats_P_oper_only=no;
563 stats_i_oper_only=masked;
564 stats_k_oper_only=masked;
566 operspy_admin_only = no;
567 operspy_dont_care_user_info = no;
568 secret_channels_in_whois = no;
569 caller_id_wait = 1 minute;
570 pace_wait_simple = 1 second;
571 pace_wait = 10 seconds;
574 connect_timeout = 30 seconds;
575 default_ident_timeout = 5;
578 true_no_oper_flood = no;
581 use_whois_actually = no;
582 oper_only_umodes = operwall, locops, servnotice;
583 oper_umodes = locops, servnotice, operwall, wallop;
586 nick_delay = 0 seconds; # 15 minutes if you want to enable this
587 reject_ban_time = 1 minute;
588 reject_after_count = 3;
589 reject_duration = 5 minutes;
590 throttle_duration = 60;
592 expire_override_time = 5 minutes;
597 path = "modules/autoload";