]> jfr.im git - solanum.git/blob - doc/example.conf
yes, ssl s2s, ssl c2s works good, maxconnections stuff cleared, so notice that in...
[solanum.git] / doc / example.conf
1 /* doc/example.conf - brief example configuration file
2 *
3 * Copyright (C) 2000-2002 Hybrid Development Team
4 * Copyright (C) 2002-2005 ircd-ratbox development team
5 * Copyright (C) 2005-2006 charybdis development team
6 *
7 * $Id: example.conf 3582 2007-11-17 21:55:48Z jilles $
8 *
9 * See reference.conf for more information.
10 */
11
12 /* Extensions */
13 #loadmodule "extensions/createauthonly.so";
14 #loadmodule "extensions/extb_account.so";
15 #loadmodule "extensions/extb_canjoin.so";
16 #loadmodule "extensions/extb_channel.so";
17 #loadmodule "extensions/extb_extgecos.so";
18 #loadmodule "extensions/extb_oper.so";
19 #loadmodule "extensions/extb_realname.so";
20 #loadmodule "extensions/extb_server.so";
21 #loadmodule "extensions/hurt.so";
22 #loadmodule "extensions/ip_cloaking.so";
23 #loadmodule "extensions/m_findforwards.so";
24 #loadmodule "extensions/m_identify.so";
25 #loadmodule "extensions/no_oper_invis.so";
26 #loadmodule "extensions/sno_farconnect.so";
27 #loadmodule "extensions/sno_globalkline.so";
28 #loadmodule "extensions/sno_globaloper.so";
29 #loadmodule "extensions/sno_whois.so";
30
31 serverinfo {
32 name = "hades.arpa";
33 sid = "42X";
34 description = "charybdis test server";
35 network_name = "AthemeNET";
36 network_desc = "Your IRC network.";
37 hub = yes;
38
39 /* On multi-homed hosts you may need the following. These define
40 * the addresses we connect from to other servers. */
41 /* for IPv4 */
42 #vhost = "192.169.0.1";
43 /* for IPv6 */
44 #vhost6 = "3ffe:80e8:546::2";
45
46 /* ssl_private_key: our ssl private key */
47 ssl_private_key = "etc/test.key";
48
49 /* ssl_cert: certificate for our ssl server */
50 ssl_cert = "etc/test.cert";
51
52 /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
53 ssl_dh_params = "etc/dh.pem";
54
55 /* default max clients: the default maximum number of clients
56 * allowed to connect. This can be changed once ircd has started by
57 * issuing:
58 * /quote set maxclients <limit>
59 */
60 default_max_clients = 1024;
61 };
62
63 admin {
64 name = "Lazy admin (lazya)";
65 description = "AthemeNET client server";
66 email = "nobody@127.0.0.1";
67 };
68
69 log {
70 fname_userlog = "logs/userlog";
71 #fname_fuserlog = "logs/fuserlog";
72 fname_operlog = "logs/operlog";
73 #fname_foperlog = "logs/foperlog";
74 fname_serverlog = "logs/serverlog";
75 fname_glinelog = "logs/glinelog";
76 #fname_klinelog = "logs/klinelog";
77 fname_killlog = "logs/killlog";
78 fname_operspylog = "logs/operspylog";
79 #fname_ioerrorlog = "logs/ioerror";
80 };
81
82 /* class {} blocks MUST be specified before anything that uses them. That
83 * means they must be defined before auth {} and before connect {}.
84 */
85 class "users" {
86 ping_time = 2 minutes;
87 number_per_ident = 10;
88 number_per_ip = 10;
89 number_per_ip_global = 50;
90 cidr_bitlen = 64;
91 number_per_cidr = 8;
92 max_number = 3000;
93 sendq = 400 kbytes;
94 };
95
96 class "opers" {
97 ping_time = 5 minutes;
98 number_per_ip = 10;
99 max_number = 1000;
100 sendq = 1 megabyte;
101 };
102
103 class "server" {
104 ping_time = 5 minutes;
105 connectfreq = 5 minutes;
106 max_number = 1;
107 sendq = 4 megabytes;
108 };
109
110 listen {
111 /* If you want to listen on a specific IP only, specify host.
112 * host definitions apply only to the following port line.
113 */
114 #host = "192.169.0.1";
115 port = 5000, 6665 .. 6669;
116
117 /* Listen on IPv6 (if you used host= above). */
118 #host = "3ffe:1234:a:b:c::d";
119 #port = 5000, 6665 .. 6669;
120 };
121
122 /* auth {}: allow users to connect to the ircd (OLD I:)
123 * auth {} blocks MUST be specified in order of precedence. The first one
124 * that matches a user will be used. So place spoofs first, then specials,
125 * then general access, then restricted.
126 */
127 auth {
128 /* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
129 * lines are permitted per auth block. This is matched against the
130 * hostname and IP address (using :: shortening for IPv6 and
131 * prepending a 0 if it starts with a colon) and can also use CIDR
132 * masks.
133 */
134 user = "*@172.16.0.0/12";
135 user = "*test@123D:B567:*";
136
137 /* password: an optional password that is required to use this block.
138 * By default this is not encrypted, specify the flag "encrypted" in
139 * flags = ...; below if it is.
140 */
141 password = "letmein";
142
143 /* spoof: fake the users user@host to be be this. You may either
144 * specify a host or a user@host to spoof to. This is free-form,
145 * just do everyone a favour and dont abuse it. (OLD I: = flag)
146 */
147 spoof = "I.still.hate.packets";
148
149 /* Possible flags in auth:
150 *
151 * encrypted | password is encrypted with mkpasswd
152 * spoof_notice | give a notice when spoofing hosts
153 * exceed_limit (old > flag) | allow user to exceed class user limits
154 * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls
155 * dnsbl_exempt | exempt this user from dnsbls
156 * gline_exempt (old _ flag) | exempt this user from glines
157 * spambot_exempt | exempt this user from spambot checks
158 * shide_exempt | exempt this user from serverhiding
159 * jupe_exempt | exempt this user from generating
160 * warnings joining juped channels
161 * resv_exempt | exempt this user from resvs
162 * flood_exempt | exempt this user from flood limits
163 * USE WITH CAUTION.
164 * no_tilde (old - flag) | don't prefix ~ to username if no ident
165 * need_ident (old + flag) | require ident for user in this class
166 * need_sasl | require SASL id for user in this class
167 */
168 flags = kline_exempt, exceed_limit;
169
170 /* class: the class the user is placed in */
171 class = "opers";
172 };
173
174 auth {
175 user = "*@*";
176 class = "users";
177 };
178
179 operator "god" {
180 /* name: the name of the oper must go above */
181
182 /* user: the user@host required for this operator. CIDR *is*
183 * supported now. auth{} spoofs work here, other spoofs do not.
184 * multiple user="" lines are supported.
185 */
186 user = "*god@127.0.0.1";
187
188 /* password: the password required to oper. Unless ~encrypted is
189 * contained in flags = ...; this will need to be encrypted using
190 * mkpasswd, MD5 is supported
191 */
192 password = "etcnjl8juSU1E";
193
194 /* rsa key: the public key for this oper when using Challenge.
195 * A password should not be defined when this is used, see
196 * doc/challenge.txt for more information.
197 */
198 #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
199
200 /* umodes: the specific umodes this oper gets when they oper.
201 * If this is specified an oper will not be given oper_umodes
202 * These are described above oper_only_umodes in general {};
203 */
204 #umodes = locops, servnotice, operwall, wallop;
205
206 /* snomask: specific server notice mask on oper up.
207 * If this is specified an oper will not be given oper_snomask.
208 */
209 snomask = "+Zbfkrsuy";
210
211 /* privileges: controls the activities and commands an oper is
212 * allowed to do on the server. You may prefix an option with ~ to
213 * disable it, ie ~operwall
214 *
215 * Default flags are operwall, remoteban and encrypted.
216 *
217 * Available options:
218 *
219 * encrypted: the password above is encrypted [DEFAULT]
220 * local_kill: allows local users to be /KILL'd
221 * global_kill: allows local and remote users to be
222 * /KILL'd (OLD 'O' flag)
223 * remote: allows remote SQUIT and CONNECT (OLD 'R' flag)
224 * kline: allows KLINE and DLINE (OLD 'K' flag)
225 * unkline: allows UNKLINE and UNDLINE (OLD 'U' flag)
226 * gline: allows GLINE (OLD 'G' flag)
227 * nick_changes: allows oper to see nickchanges (OLD 'N' flag)
228 * via snomask +n
229 * rehash: allows oper to REHASH config (OLD 'H' flag)
230 * die: allows DIE and RESTART (OLD 'D' flag)
231 * admin: gives admin privileges. admins
232 * may (un)load modules and see the
233 * real IPs of servers.
234 * hidden_admin: gives admin privileges except
235 * will not have the admin lines in
236 * stats p and whois.
237 * xline: allows use of /quote xline/unxline
238 * resv: allows /quote resv/unresv and cmode +LP [DEFAULT]
239 * operwall: allows the oper to send/receive operwalls [DEFAULT]
240 * oper_spy: allows 'operspy' features to see through +s
241 * channels etc. see /quote help operspy
242 * hidden_oper: hides the oper from /stats p (OLD UMODE +p)
243 * remoteban: allows remote kline etc [DEFAULT]
244 * mass_notice: allows sending wallops and mass notices [DEFAULT]
245 */
246 flags = global_kill, remote, kline, unkline, gline,
247 die, rehash, admin, xline, operwall;
248 };
249
250 connect "irc.uplink.com" {
251 host = "192.168.0.1";
252 send_password = "password";
253 accept_password = "anotherpassword";
254 port = 6666;
255 hub_mask = "*";
256 class = "server";
257 flags = compressed, topicburst;
258
259 /* If the connection is IPv6, uncomment below.
260 * Use 0::1, not ::1, for IPv6 localhost. */
261 #aftype = ipv6;
262 };
263
264 service {
265 name = "services.int";
266 };
267
268 cluster {
269 name = "*";
270 flags = kline, tkline, unkline, xline, txline, unxline, resv, tresv, unresv;
271 };
272
273 shared {
274 oper = "*@*", "*";
275 flags = all, rehash;
276 };
277
278 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
279 exempt {
280 ip = "127.0.0.1";
281 };
282
283 channel {
284 use_invex = yes;
285 use_except = yes;
286 use_knock = yes;
287 use_forward = yes;
288 knock_delay = 5 minutes;
289 knock_delay_channel = 1 minute;
290 max_chans_per_user = 15;
291 max_bans = 100;
292 max_bans_large = 500;
293 default_split_user_count = 0;
294 default_split_server_count = 0;
295 no_create_on_split = no;
296 no_join_on_split = no;
297 burst_topicwho = yes;
298 kick_on_split_riding = no;
299 };
300
301 serverhide {
302 flatten_links = yes;
303 links_delay = 5 minutes;
304 hidden = no;
305 disable_hidden = no;
306 };
307
308 /* These are the blacklist settings.
309 * You can have multiple combinations of host and rejection reasons.
310 * They are used in pairs of one host/rejection reason, or multiple hosts/rejection reason.
311 *
312 * These settings should be adequate for most networks, and are (presently)
313 * required for use on AthemeNet.
314 *
315 * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
316 * connections.
317 *
318 * As of charybdis 2.1.3, you can do some keyword substitution on the rejection
319 * reason. The available keyword substitutions are:
320 *
321 * ${ip} - the user's IP
322 * ${host} - the user's canonical hostname
323 * ${dnsbl-host} - the dnsbl hostname the lookup was done against
324 * ${nick} - the user's nickname
325 * ${network-name} - the name of the network
326 *
327 * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
328 * contacted, via email, at admins@2mbit.com before using these BLs.
329 * See <http://www.ahbl.org/services.php> for more information.
330 */
331 blacklist {
332 host = "dnsbl.dronebl.org";
333 reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
334
335 # host = "ircbl.ahbl.org";
336 # 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.";
337 #
338 # host = "tor.ahbl.org";
339 # 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.";
340 };
341
342 alias "NickServ" {
343 target = "NickServ";
344 };
345
346 alias "ChanServ" {
347 target = "ChanServ";
348 };
349
350 alias "OperServ" {
351 target = "OperServ";
352 };
353
354 alias "MemoServ" {
355 target = "MemoServ";
356 };
357
358 alias "NS" {
359 target = "NickServ";
360 };
361
362 alias "CS" {
363 target = "ChanServ";
364 };
365
366 alias "OS" {
367 target = "OperServ";
368 };
369
370 alias "MS" {
371 target = "MemoServ";
372 };
373
374 general {
375 hide_error_messages = opers;
376 hide_spoof_ips = yes;
377
378 /*
379 * default_umodes: umodes to enable on connect.
380 * If you have enabled the ip_cloaking module, and you want
381 * to make use of it, add +h to this option, i.e.:
382 * default_umodes = "+ih";
383 */
384 default_umodes = "+i";
385
386 default_operstring = "is an IRC Operator";
387 default_adminstring = "is a Server Administrator";
388 servicestring = "is a Network Service";
389 disable_fake_channels = no;
390 tkline_expire_notices = no;
391 default_floodcount = 10;
392 failed_oper_notice = yes;
393 dots_in_ident=2;
394 min_nonwildcard = 4;
395 min_nonwildcard_simple = 3;
396 max_accept = 100;
397 max_monitor = 100;
398 anti_nick_flood = yes;
399 max_nick_time = 20 seconds;
400 max_nick_changes = 5;
401 anti_spam_exit_message_time = 5 minutes;
402 ts_warn_delta = 30 seconds;
403 ts_max_delta = 5 minutes;
404 client_exit = yes;
405 collision_fnc = yes;
406 global_snotices = yes;
407 dline_with_reason = yes;
408 kline_delay = 0 seconds;
409 kline_with_reason = yes;
410 kline_reason = "K-Lined";
411 identify_service = "NickServ@services.int";
412 identify_command = "IDENTIFY";
413 non_redundant_klines = yes;
414 warn_no_nline = yes;
415 stats_e_disabled = no;
416 stats_c_oper_only=no;
417 stats_h_oper_only=no;
418 stats_y_oper_only=no;
419 stats_o_oper_only=yes;
420 stats_P_oper_only=no;
421 stats_i_oper_only=masked;
422 stats_k_oper_only=masked;
423 map_oper_only = no;
424 operspy_admin_only = no;
425 operspy_dont_care_user_info = no;
426 caller_id_wait = 1 minute;
427 pace_wait_simple = 1 second;
428 pace_wait = 10 seconds;
429 short_motd = no;
430 ping_cookie = no;
431 connect_timeout = 30 seconds;
432 disable_auth = no;
433 no_oper_flood = yes;
434 glines = no;
435 gline_time = 1 day;
436 gline_min_cidr = 16;
437 max_targets = 4;
438 client_flood = 20;
439 use_whois_actually = no;
440 oper_only_umodes = operwall, locops, servnotice;
441 oper_umodes = locops, servnotice, operwall, wallop;
442 oper_snomask = "+s";
443 burst_away = yes;
444 nick_delay = 0 seconds; # 15 minutes if you want to enable this
445 reject_ban_time = 1 minute;
446 reject_after_count = 3;
447 reject_duration = 5 minutes;
448 max_unknown_ip = 2;
449 };
450
451 modules {
452 path = "modules";
453 path = "modules/autoload";
454 };