ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/branches/8.2.x/doc/reference.conf
Revision: 3883
Committed: Fri Jun 6 17:10:09 2014 UTC (11 years, 2 months ago) by michael
File size: 37926 byte(s)
Log Message:
- Update reference.conf

File Contents

# User Rev Content
1 michael 2962 /*
2     * This is an example configuration file for ircd-hybrid
3 db 897 *
4 michael 2962 * Copyright (c) 2000-2014 ircd-hybrid development team
5 db 897 *
6     * $Id$
7     */
8    
9 michael 1824 /*
10     * ########################################################################
11 michael 2322 * IMPORTANT NOTE:
12 db 897 *
13 michael 3883 * auth {} blocks MUST be specified in order of precedence. The first one
14     * that matches a user will be used. So place spoofs first, then specials,
15 db 897 * then general access.
16 michael 1824 * ########################################################################
17 db 897 *
18     * Shell style (#), C++ style (//) and C style comments are supported.
19     *
20     * Files may be included by either:
21     * .include "filename"
22     * .include <filename>
23     *
24     * Times/durations are written as:
25     * 12 hours 30 minutes 1 second
26 michael 2841 *
27 db 897 * Valid units of time:
28 michael 1783 * year, month, week, day, hour, minute, second
29 db 897 *
30     * Valid units of size:
31     * megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
32     *
33 michael 2305 * Sizes and times may be singular or plural.
34     */
35 db 897
36 michael 1824
37 db 897 /*
38 michael 1336 * serverinfo {}: contains information about the server
39 db 897 */
40     serverinfo {
41     /*
42 michael 2345 * name: the name of this server. This cannot be changed at runtime.
43 db 897 */
44     name = "hades.arpa";
45    
46     /*
47 michael 2345 * sid: a server's unique ID. This is three characters long and must
48     * be in the form [0-9][A-Z0-9][A-Z0-9]. The first character must be
49 db 897 * a digit, followed by 2 alpha-numerical letters.
50 michael 2345 *
51 michael 1863 * NOTE: The letters must be capitalized. This cannot be changed at runtime.
52 db 897 */
53 michael 1817 sid = "0HY";
54 db 897
55     /*
56 michael 1533 * description: the description of the server.
57 db 897 */
58 michael 1534 description = "ircd-hybrid test server";
59 db 897
60     /*
61     * network info: the name and description of the network this server
62 michael 1863 * is on. Shown in the 005 reply and used with serverhiding.
63 db 897 */
64     network_name = "MyNet";
65     network_desc = "This is My Network";
66    
67     /*
68     * hub: allow this server to act as a hub and have multiple servers
69     * connected to it.
70     */
71     hub = no;
72    
73     /*
74     * vhost: the IP to bind to when we connect outward to ipv4 servers.
75 michael 959 * This should be an ipv4 IP only, or "*" for INADDR_ANY.
76 db 897 */
77 michael 2171 # vhost = "192.169.0.1";
78 db 897
79     /*
80 michael 2322 * vhost6: the address to bind to when we make outgoing connections
81     * to IPv6 servers. This should be an IPv6 address, or "*" for INADDR_ANY.
82 db 897 */
83 michael 2171 # vhost6 = "3ffe:80e8:546::2";
84 db 897
85 michael 1863 /* max_clients: the maximum number of clients allowed to connect. */
86 db 897 max_clients = 512;
87    
88     /*
89 michael 1751 * max_nick_length: only applies to local clients. Must be in the
90     * range of 9 to 30. Default is 9 if nothing else is specified.
91     */
92     max_nick_length = 9;
93    
94     /*
95     * max_topic_length: only applies to topics set by local clients.
96     * Must be in the range of 80 to 300. Default is 80 if nothing
97     * else is specified.
98     */
99     max_topic_length = 160;
100    
101     /*
102 michael 2322 * rsa_private_key_file: the path to the file containing the
103 michael 2844 * RSA key.
104 db 897 *
105 michael 2468 * Example commands to store a 2048 bit RSA key in rsa.key:
106 michael 2308 *
107 michael 1229 * openssl genrsa -out rsa.key 2048
108 michael 2464 * chown <ircd-user>.<ircd.group> rsa.key
109 db 897 * chmod 0600 rsa.key
110     */
111 michael 2171 # rsa_private_key_file = "/usr/local/ircd/etc/rsa.key";
112 db 897
113     /*
114 michael 951 * ssl_certificate_file: the path to the file containing our
115 michael 2322 * SSL certificate for encrypted client connection.
116 db 897 *
117     * This assumes your private RSA key is stored in rsa.key. You
118 michael 1863 * MUST have an RSA key in order to generate the certificate.
119 db 897 *
120 michael 1863 * Example command:
121     *
122 db 897 * openssl req -new -days 365 -x509 -key rsa.key -out cert.pem
123     *
124     * See http://www.openssl.org/docs/HOWTO/certificates.txt
125     *
126     * Please use the following values when generating the cert
127     *
128     * Organization Name: Network Name
129     * Organization Unit Name: changme.someirc.net
130     * Common Name: irc.someirc.net
131     * E-mail: you@domain.com
132     */
133 michael 2171 # ssl_certificate_file = "/usr/local/ircd/etc/cert.pem";
134 michael 967
135 michael 1351 /*
136     * ssl_dh_param_file:
137     *
138     * Path to the PEM encoded Diffie-Hellman parameter file.
139 michael 2322 * DH parameters are required when using ciphers with EDH
140     * (ephemeral Diffie-Hellman) key exchange.
141 michael 1351 *
142     * A DH parameter file can be created by running:
143     *
144 michael 3013 * openssl dhparam -out dhparam.pem 2048
145 michael 1351 *
146 michael 1523 * Prime size must be at least 1024 bits. Further information
147     * regarding specific OpenSSL dhparam command-line options
148     * can be found in the OpenSSL manual.
149 michael 1351 */
150 michael 2171 # ssl_dh_param_file = "/usr/local/ircd/etc/dhparam.pem";
151 michael 1306
152 michael 967 /*
153 michael 1306 * ssl_cipher_list:
154     *
155 michael 2322 * List of ciphers to support on _this_ server. Can be used to
156 michael 1524 * enforce specific ciphers for incoming SSL/TLS connections.
157 michael 2322 * If a client (which also includes incoming server connections) is not
158     * capable of using any of the ciphers listed here, the connection will
159     * simply be rejected.
160 michael 1550 *
161 michael 2322 * A list of supported ciphers by OpenSSL can be obtained by running:
162 michael 1306 *
163     * openssl ciphers -ssl3 -tls1 -v
164     *
165 michael 1524 * Multiple ciphers are separated by colons. The order of preference is
166     * from left to right.
167 michael 1306 */
168 michael 3015 # ssl_cipher_list = "ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-SHA:AES256-SHA";
169 michael 1306
170     /*
171 michael 1351 * ssl_server_method:
172     * ssl_client_method:
173     *
174 michael 1412 * SSL/TLS methods we provide for incoming (server method) and
175     * outgoing (client method) SSL/TLS connections.
176 michael 967 * This can be either sslv3 for SSLv3, and/or tlsv1 for TLSv1.
177     */
178 michael 2171 # ssl_server_method = tlsv1, sslv3;
179     # ssl_client_method = tlsv1;
180 db 897 };
181    
182     /*
183 michael 1229 * admin {}: contains admin information about the server
184 db 897 */
185     admin {
186     name = "Smurf target";
187     description = "Main Server Administrator";
188     email = "<syn@packets.r.us>";
189     };
190    
191     /*
192 michael 1229 * class {}: contains information about classes for users
193 db 897 */
194     class {
195 michael 1863 /* name: the name of the class. */
196 db 897 name = "users";
197    
198     /*
199     * ping_time: how often a client must reply to a PING from the
200     * server before they are dropped.
201     */
202     ping_time = 90 seconds;
203    
204     /*
205     * number_per_ip: how many local users are allowed to connect
206 michael 2322 * from a single IP address (optional)
207 db 897 */
208     number_per_ip = 2;
209    
210     /*
211     * max_local: how many local users are allowed to connect
212 michael 2322 * from a single ident@host (optional)
213 db 897 */
214     max_local = 2;
215    
216     /*
217     * max_global: network-wide limit of users per ident@host (optional)
218     */
219     max_global = 10;
220    
221     /*
222     * max_number: the maximum number of users allowed in this class (optional)
223     */
224     max_number = 100;
225    
226     /*
227     * the following lines are optional and allow you to define
228 michael 1863 * how many users can connect from one /NN subnet.
229 db 897 */
230     cidr_bitlen_ipv4 = 24;
231     cidr_bitlen_ipv6 = 120;
232     number_per_cidr = 16;
233    
234     /*
235 michael 2322 * sendq: the amount of data allowed in a client's send queue before
236 db 897 * they are dropped.
237     */
238     sendq = 100 kbytes;
239 michael 1516
240     /*
241 michael 2322 * recvq: the amount of data allowed in a client's receive queue before
242 michael 1541 * they are dropped for flooding. Defaults to 2560 if the chosen
243 michael 1516 * value isn't within the range of 512 to 8000.
244     */
245     recvq = 2560 bytes;
246 db 897 };
247    
248     class {
249     name = "opers";
250     ping_time = 90 seconds;
251     number_per_ip = 10;
252     max_number = 100;
253 michael 1428 sendq = 100 kbytes;
254 michael 1783
255     /*
256 michael 1863 * min_idle: minimum idle time that is shown in /whois.
257 michael 1783 */
258     min_idle = 3 hours;
259    
260     /*
261 michael 1863 * max_idle: maximum idle time that is shown in /whois.
262 michael 1783 */
263     max_idle = 8 hours;
264    
265     /*
266     * flags:
267     *
268 michael 2322 * random_idle - a fake idle time is set randomly between
269     * min_idle and max_idle
270     * hide_idle_from_opers - the fake idle time will also be shown to operators
271 michael 1783 */
272     flags = random_idle, hide_idle_from_opers;
273 db 897 };
274    
275     class {
276     name = "server";
277     ping_time = 90 seconds;
278    
279     /*
280 michael 1863 * connectfreq: only used in server classes. Specifies the delay
281 db 897 * between autoconnecting to servers.
282     */
283     connectfreq = 5 minutes;
284    
285 michael 2322 /* max number: the number of servers to autoconnect to. */
286 db 897 max_number = 1;
287    
288 michael 1863 /* sendq: servers need a higher sendq as they send more data. */
289 db 897 sendq = 2 megabytes;
290     };
291    
292     /*
293 michael 2322 * motd {}: Allows the display of a different MOTD to a client
294 michael 2210 * depending on its origin. Applies to local users only.
295 michael 2150 */
296     motd {
297     /*
298     * mask: multiple mask entries are permitted. Mask can either be
299 michael 2993 * a class name or a hostname. CIDR is supported.
300 michael 2150 */
301     mask = "*.at";
302     mask = "*.de";
303     mask = "*.ch";
304    
305     /*
306 michael 2152 * file: path to the actual motd file.
307 michael 2150 */
308     file = "/usr/local/ircd/etc/german.motd";
309     };
310    
311     /*
312 michael 1229 * listen {}: contains information about the ports ircd listens on
313 db 897 */
314     listen {
315     /*
316 michael 3448 * port: the port to listen on. If no host is specified earlier
317     * in the listen {} block, it will listen on all available IPs.
318 db 897 *
319 michael 2328 * Ports are separated by commas; a range may be specified using ".."
320 db 897 */
321 michael 2345
322 michael 2322 /* port: listen on all available IP addresses, ports 6665 to 6669 */
323 db 897 port = 6665 .. 6669;
324    
325     /*
326 michael 2322 * Listen on 192.168.0.1/6697 with SSL enabled and hidden from STATS P
327 db 897 * unless you are an administrator.
328     *
329 michael 2322 * NOTE: The "flags" directive always has to come before "port".
330 michael 951 *
331     * Currently available flags are:
332     *
333 michael 1679 * ssl - Port may only accept TLS/SSL connections
334 michael 951 * server - Only server connections are permitted
335 michael 1229 * hidden - Port is hidden from /stats P, unless you're an admin
336 db 897 */
337     flags = hidden, ssl;
338     host = "192.168.0.1";
339     port = 6697;
340    
341     /*
342 michael 2322 * host: set a specific IP address/host to listen on using the
343     * subsequent port definitions. This may be IPv4 or IPv6.
344 db 897 */
345     host = "1.2.3.4";
346     port = 7000, 7001;
347    
348     host = "3ffe:1234:a:b:c::d";
349     port = 7002;
350     };
351    
352     /*
353 michael 1229 * auth {}: allow users to connect to the ircd
354 db 897 */
355     auth {
356     /*
357 michael 1541 * user: the user@host allowed to connect. Multiple user
358 michael 2322 * lines are permitted within each auth block.
359 db 897 */
360     user = "*@172.16.0.0/12";
361     user = "*test@123D:B567:*";
362    
363     /* password: an optional password that is required to use this block */
364     password = "letmein";
365    
366     /*
367     * encrypted: controls whether the auth password above has been
368     * encrypted.
369     */
370     encrypted = yes;
371    
372     /*
373 michael 2322 * spoof: fake the user's host to this. This is free-form, just do
374 michael 1863 * everyone a favor and don't abuse it. ('=' prefix on /stats I)
375 db 897 */
376     spoof = "I.still.hate.packets";
377    
378     /* class: the class the user is placed in */
379     class = "opers";
380    
381     /*
382 michael 1229 * need_password - don't allow users who haven't supplied the correct
383     * password to connect using another auth{} block
384     * ('&' prefix on /stats I if disabled)
385     * need_ident - require the user to have identd to connect ('+' prefix on /stats I)
386     * spoof_notice - enable spoofing notification to admins
387     * exceed_limit - allow a user to exceed class limits ('>' prefix on /stats I)
388     * kline_exempt - exempt this user from k/glines ('^' prefix on /stats I)
389     * gline_exempt - exempt this user from glines ('_' prefix on /stats I)
390     * resv_exempt - exempt this user from resvs ('$' prefix on /stats I)
391     * no_tilde - remove ~ from a user with no ident ('-' prefix on /stats I)
392     * can_flood - allow this user to exceed flood limits ('|' prefix on /stats I)
393 michael 1850 * webirc - enables WEBIRC authentication for web-based clients such as Mibbit
394 michael 1715 * ('<' prefix on /stats I)
395 db 897 */
396     flags = need_password, spoof_notice, exceed_limit, kline_exempt,
397 michael 1176 gline_exempt, resv_exempt, no_tilde, can_flood;
398 db 897 };
399    
400     auth {
401     /*
402 michael 1863 * redirect: the server and port to redirect a user to. A user does not
403 michael 2322 * have to obey the redirection; the ircd just suggests an alternative
404 db 897 * server for them.
405     */
406     redirserv = "this.is.not.a.real.server";
407     redirport = 6667;
408 michael 2345
409 db 897 user = "*.server";
410    
411     /* class: a class is required even though it is not used */
412     class = "users";
413     };
414    
415     auth {
416     user = "*@*";
417     class = "users";
418     flags = need_ident;
419     };
420    
421     /*
422 michael 1229 * operator {}: defines ircd operators
423 db 897 */
424     operator {
425     /* name: the name of the oper */
426 michael 1537 name = "sheep";
427 db 897
428     /*
429 michael 3448 * user: the user@host required for this operator. Multiple user
430 michael 3858 * lines are permitted within each operator block.
431 db 897 */
432 michael 1537 user = "*sheep@192.168.0.0/16";
433 michael 1285 user = "*@127.0.0.0/8";
434 db 897
435     /*
436 michael 1863 * password: the password required to oper. By default this will
437 michael 1070 * need to be encrypted by using the provided mkpasswd tool.
438     * Several password hash algorithms are available depending
439     * on your system's crypt() implementation. For example, a modern
440 michael 2322 * glibc already has support for the SHA-256/512 and MD5 encryption
441 michael 1070 * algorithms.
442 db 897 */
443 michael 1070 password = "$5$x5zof8qe.Yc7/bPp$5zIg1Le2Lsgd4CvOjaD20pr5PmcfD7ha/9b2.TaUyG4";
444 db 897
445     /*
446     * encrypted: controls whether the oper password above has been
447 michael 1070 * encrypted.
448 db 897 */
449     encrypted = yes;
450    
451     /*
452     * rsa_public_key_file: the public key for this oper when using Challenge.
453 michael 2841 * A password should not be defined when this is used; see
454 db 897 * doc/challenge.txt for more information.
455     */
456     # rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
457    
458 michael 2228 /*
459 michael 2244 * ssl_certificate_fingerprint: enhances security by additionally checking
460     * the oper's client certificate fingerprint against the specified
461     * fingerprint below.
462 michael 2236 *
463     * Hint: your users can use the following command to obtain a SHA-256 hash
464     * of their ssl certificate:
465     *
466     * openssl x509 -sha256 -noout -fingerprint -in cert.pem | sed -e 's/^.*=//;s/://g'
467 michael 2228 */
468 michael 2244 # ssl_certificate_fingerprint = "4C62287BA6776A89CD4F8FF10A62FFB35E79319F51AF6C62C674984974FCCB1D";
469 michael 2228
470 michael 2248 /*
471     * ssl_connection_required: client must be connected over SSL/TLS
472     * in order to be able to use this oper{} block.
473 michael 2279 * Default is 'no' if nothing else is specified.
474 michael 2248 */
475     ssl_connection_required = no;
476    
477 db 897 /* class: the class the oper joins when they successfully /oper */
478     class = "opers";
479    
480     /*
481 michael 2322 * umodes: the default usermodes opers get when they /oper. If defined,
482 db 897 * it will override oper_umodes settings in general {}.
483     * Available usermodes:
484     *
485     * +b - bots - See bot and drone flooding notices
486     * +c - cconn - Client connection/quit notices
487     * +D - deaf - Don't receive channel messages
488     * +d - debug - See debugging notices
489 michael 1818 * +e - external - See remote server connection and split notices
490 michael 1976 * +F - farconnect - Remote client connection/quit notices
491 michael 1426 * +f - full - See auth{} block full notices
492 db 897 * +G - softcallerid - Server Side Ignore for users not on your channels
493     * +g - callerid - Server Side Ignore (for privmsgs etc)
494 michael 1294 * +H - hidden - Hides operator status to other users
495 michael 2267 * +i - invisible - Not shown in NAMES or WHO unless you share a channel
496 michael 1290 * +j - rej - See rejected client notices
497 db 897 * +k - skill - See server generated KILL messages
498     * +l - locops - See LOCOPS messages
499     * +n - nchange - See client nick changes
500 michael 3515 * +p - hidechans - Hides channel list in WHOIS
501 michael 3507 * +q - hideidle - Hides idle and signon time in WHOIS
502 michael 1855 * +R - nononreg - Only receive private messages from registered clients
503 db 897 * +s - servnotice - See general server notices
504     * +u - unauth - See unauthorized client notices
505     * +w - wallop - See server generated WALLOPS
506     * +y - spy - See LINKS, STATS, TRACE notices etc.
507     */
508 michael 3867 umodes = locops, servnotice, wallop;
509 db 897
510     /*
511 michael 2305 * privileges: controls the activities and commands an oper is
512 michael 1228 * allowed to do on the server. All options default to no.
513 db 897 * Available options:
514     *
515 michael 2012 * module - allows MODULE
516 michael 2018 * connect - allows local CONNECT | ('P' flag)
517     * connect:remote - allows remote CONNECT | ('Q' flag)
518     * squit - allows local SQUIT | ('R' flag)
519     * squit:remote - allows remote SQUIT | ('S' flag)
520     * kill - allows to KILL local clients | ('N' flag)
521     * kill:remote - allows remote users to be /KILL'd | ('O' flag)
522     * remoteban - allows remote KLINE/UNKLINE | ('B' flag)
523     * dline - allows DLINE |
524     * undline - allows UNDLINE |
525     * kline - allows KLINE | ('K' flag)
526     * unkline - allows UNKLINE | ('U' flag)
527     * gline - allows GLINE | ('G' flag)
528     * xline - allows XLINE | ('X' flag)
529 michael 2852 * unxline - allows UNXLINE |
530 michael 2038 * locops - allows LOCOPS |
531 michael 2018 * globops - allows GLOBOPS |
532 michael 2038 * wallops - allows WALLOPS |
533 michael 2018 * rehash - allows oper to REHASH config | ('H' flag)
534     * die - allows DIE | ('D' flag)
535     * restart - allows RESTART |
536     * set - allows SET |
537     * admin - gives administrator privileges | ('A' flag)
538 db 897 */
539 michael 2012 flags = kill, kill:remote, connect, connect:remote, kline, unkline,
540 michael 3867 xline, globops, restart, die, rehash, admin, module;
541 db 897 };
542    
543 michael 1552 /*
544 michael 2322 * service {}: specifies a server which may act as a network service
545 michael 1552 *
546 michael 2322 * NOTE: it is very important that every server on the network
547 michael 1552 * has the same service{} block.
548     */
549 michael 1157 service {
550     name = "service.someserver";
551 michael 1302 name = "stats.someserver";
552 michael 1157 };
553    
554 db 897 /*
555 michael 2322 * connect {}: define a server to connect to
556 db 897 */
557     connect {
558     /* name: the name of the server */
559     name = "irc.uplink.com";
560    
561     /*
562 michael 2322 * host: the host or IP address to connect to. If a hostname is used it
563     * must match the reverse DNS of the server.
564 db 897 */
565     host = "192.168.0.1";
566    
567     /*
568 michael 2322 * vhost: the IP address to bind to when making outgoing connections to
569     * servers.
570 db 897 * serverinfo::vhost and serverinfo::vhost6 will be overridden
571     * by this directive.
572     */
573     vhost = "192.168.0.2";
574    
575     /*
576 michael 2322 * passwords: the passwords to send (OLD C:) and accept (OLD N:).
577     * The remote server will have these passwords swapped.
578 db 897 */
579     send_password = "password";
580     accept_password = "anotherpassword";
581    
582     /*
583     * encrypted: controls whether the accept_password above has been
584 michael 1070 * encrypted.
585 db 897 */
586     encrypted = no;
587    
588     /* port: the port to connect to this server on */
589     port = 6666;
590    
591     /*
592 michael 1863 * hub_mask: the mask of servers that this server may hub. Multiple
593     * entries are permitted.
594 db 897 */
595     hub_mask = "*";
596    
597     /*
598 michael 1863 * leaf_mask: the mask of servers this server may not hub. Multiple
599     * entries are permitted. Useful for forbidding EU -> US -> EU routes.
600 db 897 */
601     # leaf_mask = "*.uk";
602    
603     /* class: the class this server is in */
604     class = "server";
605    
606 michael 1524 /*
607     * ssl_cipher_list:
608     *
609     * List of ciphers that the server we are connecting to must support.
610 michael 2322 * If the server is not capable of using any of the ciphers listed below,
611     * the connection will simply be rejected.
612 michael 1524 * Can be used to enforce stronger ciphers, even though this option
613     * is not necessarily required to establish a SSL/TLS connection.
614     *
615     * Multiple ciphers are separated by colons. The order of preference
616     * is from left to right.
617     */
618 michael 3059 # ssl_cipher_list = "ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-SHA:AES256-SHA";
619 michael 1306
620 db 897 /*
621 michael 2244 * ssl_certificate_fingerprint: enhances security by additionally checking
622     * the server's client certificate fingerprint against the specified
623     * fingerprint below.
624 michael 2228 */
625 michael 2244 # ssl_certificate_fingerprint = "4C62287BA6776A89CD4F8FF10A62FFB35E79319F51AF6C62C674984974FCCB1D";
626 michael 2228
627     /*
628 michael 1229 * autoconn - controls whether we autoconnect to this server or not,
629     * dependent on class limits. By default, this is disabled.
630 michael 1303 * ssl - Initiates a TLS/SSL connection.
631 db 897 */
632 michael 1519 # flags = autoconn, ssl;
633 db 897 };
634    
635     connect {
636 michael 1285 name = "ipv6.some.server";
637 db 897 host = "3ffd:dead:beef::1";
638     send_password = "password";
639     accept_password = "password";
640     port = 6666;
641    
642     /*
643     * aftype: controls whether the connection uses "ipv4" or "ipv6".
644     * Default is ipv4.
645     */
646     aftype = ipv6;
647     class = "server";
648     };
649    
650     /*
651     * cluster {}: servers that share klines/unkline/xline/unxline/resv/unresv/locops
652 michael 1229 * automatically
653 db 897 */
654     cluster {
655     /*
656 michael 2322 * name: the server to share with; this can take wildcards
657 db 897 *
658 michael 2322 * NOTE: only local actions will be clustered, meaning that if
659 db 897 * the server receives a shared kline/unkline/etc, it
660     * will not be propagated to clustered servers.
661     *
662     * Remote servers are not necessarily required to accept
663     * clustered lines, they need a shared{} for *THIS* server
664     * in order to accept them.
665     */
666     name = "*.arpa";
667    
668     /*
669 michael 2322 * type: list of what to share; options are as follows:
670 michael 1301 * dline - share dlines
671     * undline - share undlines
672 michael 1336 * kline - share klines
673     * unkline - share unklines
674     * xline - share xlines
675     * unxline - share unxlines
676     * resv - share resvs
677     * unresv - share unresvs
678     * locops - share locops
679     * all - share all of the above (default)
680 db 897 */
681     type = kline, unkline, locops, xline, resv;
682     };
683    
684     /*
685 michael 1229 * shared {}: users that are allowed to remote kline
686 db 897 *
687 michael 2322 * NOTE: This can effectively be used for remote klines.
688 db 897 * Please note that there is no password authentication
689 michael 1863 * for users setting remote klines. You must also be
690 db 897 * /oper'd in order to issue a remote kline.
691     */
692     shared {
693     /*
694 michael 2322 * name: the server the user must be connected to in order to set klines.
695     * If this is not specified, the user will be allowed to kline from all
696     * servers.
697 db 897 */
698     name = "irc2.some.server";
699    
700     /*
701 michael 1863 * user: the user@host mask that is allowed to set klines. If this is
702 db 897 * not specified, all users on the server above will be allowed to set
703     * a remote kline.
704     */
705     user = "oper@my.host.is.spoofed";
706    
707     /*
708     * type: list of what to share, options are as follows:
709 michael 1301 * dline - allow oper/server to dline
710     * undline - allow oper/server to undline
711 michael 1336 * kline - allow oper/server to kline
712     * unkline - allow oper/server to unkline
713     * xline - allow oper/server to xline
714     * unxline - allow oper/server to unxline
715     * resv - allow oper/server to resv
716     * unresv - allow oper/server to unresv
717 db 897 * locops - allow oper/server to locops - only used for servers that cluster
718 michael 1336 * all - allow oper/server to do all of the above (default)
719 db 897 */
720     type = kline, unkline, resv;
721     };
722    
723     /*
724 michael 1229 * kill {}: users that are not allowed to connect
725 db 897 * Oper issued klines will be added to the specified kline config
726     */
727     kill {
728     user = "bad@*.hacked.edu";
729     reason = "Obviously hacked account";
730     };
731    
732     /*
733 michael 2322 * deny {}: IP addresses that are not allowed to connect
734     * (before DNS/ident lookup)
735 db 897 * Oper issued dlines will be added to the specified dline config
736     */
737     deny {
738     ip = "10.0.1.0/24";
739     reason = "Reconnecting vhosted bots";
740     };
741    
742     /*
743 michael 2322 * exempt {}: IP addresses that are exempt from deny {} and Dlines
744 db 897 */
745     exempt {
746     ip = "192.168.0.0/16";
747     };
748    
749     /*
750 michael 1229 * resv {}: nicks and channels users may not use/join
751 db 897 */
752 michael 1858 resv { mask = "clone*"; reason = "Clone bots"; };
753 michael 3658 resv { mask = "Global"; reason = "Reserved for services"; };
754 michael 1866 resv { mask = "ChanServ"; reason = "Reserved for services"; };
755 michael 1858 resv { mask = "NickServ"; reason = "Reserved for services"; };
756     resv { mask = "OperServ"; reason = "Reserved for services"; };
757     resv { mask = "MemoServ"; reason = "Reserved for services"; };
758     resv { mask = "BotServ"; reason = "Reserved for services"; };
759     resv { mask = "HelpServ"; reason = "Reserved for services"; };
760     resv { mask = "HostServ"; reason = "Reserved for services"; };
761     resv { mask = "StatServ"; reason = "Reserved for services"; };
762     resv { mask = "#*services*"; reason = "Reserved for services"; };
763 michael 1823
764 michael 1858 resv {
765     /*
766     * mask: masks starting with a '#' are automatically considered
767 michael 2322 * as channel name masks.
768 michael 1858 */
769     mask = "#helsinki";
770 michael 3551 reason = "Channel is reserved for Finnish inhabitants";
771 michael 1858
772     /*
773     * exempt: can be either a ISO 3166 alpha-2 two letter country
774     * code, or a nick!user@host mask. CIDR is supported. Exempt
775     * entries can be stacked.
776     */
777     exempt = "FI";
778     };
779    
780 db 897 /*
781 michael 1863 * gecos {}: Used for banning users based on their "realname".
782 db 897 */
783     gecos {
784     name = "*sex*";
785     reason = "Possible spambot";
786     };
787    
788     gecos {
789     name = "sub7server";
790     reason = "Trojan drone";
791     };
792    
793     /*
794     * channel {}: The channel block contains options pertaining to channels
795     */
796     channel {
797     /*
798     * disable_fake_channels: this option, if set to 'yes', will
799 michael 2322 * disallow clients from creating or joining channels that have one
800 db 897 * of the following ASCII characters in their name:
801     *
802     * 2 | bold
803     * 3 | mirc color
804 michael 951 * 15 | plain text
805 db 897 * 22 | reverse
806 michael 1424 * 29 | italic
807 db 897 * 31 | underline
808     * 160 | non-breaking space
809     */
810     disable_fake_channels = yes;
811    
812     /*
813 michael 3863 * invite_client_count, invite_client_time: how many INVITE commands
814     * are permitted per client per invite_client_time.
815 michael 3763 */
816 michael 3863 invite_client_count = 10;
817     invite_client_time = 5 minutes;
818 michael 3763
819     /*
820 michael 3863 * knock_client_count, knock_client_time: how many KNOCK commands
821     * are permitted per client per knock_client_time.
822 michael 3763 */
823 michael 3863 knock_client_count = 1;
824     knock_client_time = 5 minutes;
825 michael 3763
826     /*
827     * knock_delay_channel: How often a KNOCK to any specific channel
828     * is permitted, regardless of the user sending the KNOCK.
829 db 897 */
830     knock_delay_channel = 1 minute;
831    
832     /*
833     * max_chans_per_user: The maximum number of channels a user can
834     * join/be on.
835     */
836     max_chans_per_user = 25;
837    
838 michael 1432 /*
839     * max_chans_per_oper: The maximum number of channels an oper can
840     * join/be on.
841     */
842     max_chans_per_oper = 50;
843    
844 db 897 /* max_bans: maximum number of +b/e/I modes in a channel */
845 michael 1522 max_bans = 100;
846 db 897
847     /*
848 michael 2322 * how many joins in how many seconds constitute a flood. Use 0 to
849 db 897 * disable. +b opers will be notified (changeable via /set)
850     */
851     join_flood_count = 16;
852     join_flood_time = 8 seconds;
853    
854     /*
855 michael 2322 * The ircd will now check splitmode (whether a server is split from
856     * the network) every few seconds; this functionality is known as
857     * splitcode and is influenced by the options below.
858 db 897 *
859     * Either split users or split servers can activate splitmode, but
860     * both conditions must be met for the ircd to deactivate splitmode.
861 michael 2345 *
862 db 897 * You may force splitmode to be permanent by /quote set splitmode on
863     */
864    
865     /*
866     * default_split_user_count: when the usercount is lower than this level,
867 michael 1863 * consider ourselves split. This must be set for automatic splitmode.
868 db 897 */
869     default_split_user_count = 0;
870    
871     /*
872     * default_split_server_count: when the servercount is lower than this,
873 michael 1863 * consider ourselves split. This must be set for automatic splitmode.
874 db 897 */
875     default_split_server_count = 0;
876    
877 michael 2322 /* no_create_on_split: do not allow users to create channels on split. */
878 db 897 no_create_on_split = yes;
879    
880 michael 2322 /* no_join_on_split: do not allow users to join channels on a split. */
881 db 897 no_join_on_split = no;
882     };
883    
884     /*
885     * serverhide {}: The serverhide block contains the options regarding
886 michael 2322 * to server hiding
887 db 897 */
888     serverhide {
889     /*
890 michael 2322 * disable_remote_commands: disable users issuing commands
891 michael 2196 * on remote servers.
892     */
893     disable_remote_commands = no;
894    
895     /*
896 db 897 * flatten_links: this option will show all servers in /links appear
897 michael 2322 * as though they are linked to this current server.
898 db 897 */
899     flatten_links = no;
900    
901     /*
902     * links_delay: how often to update the links file when it is
903     * flattened.
904     */
905     links_delay = 5 minutes;
906    
907     /*
908     * hidden: hide this server from a /links output on servers that
909 michael 1863 * support it. This allows hub servers to be hidden etc.
910 db 897 */
911     hidden = no;
912    
913     /*
914     * hide_servers: hide remote servernames everywhere and instead use
915     * hidden_name and network_desc.
916     */
917     hide_servers = no;
918    
919     /*
920 michael 1851 * hide_services: define this if you want to hide the location of
921 michael 1852 * services servers that are specified in the service{} block.
922 michael 1851 */
923     hide_services = no;
924    
925     /*
926 db 897 * Use this as the servername users see if hide_servers = yes.
927     */
928     hidden_name = "*.hidden.com";
929    
930     /*
931 michael 951 * hide_server_ips: If this is disabled, opers will be unable to see
932 michael 2322 * servers' IP addresses and will be shown a masked IP address; admins
933     * will be shown the real IP address.
934 db 897 *
935 michael 2322 * If this is enabled, nobody can see a server's IP address.
936     * *This is a kludge*: it has the side effect of hiding the IP addresses
937     * everywhere, including logfiles.
938 db 897 *
939     * We recommend you leave this disabled, and just take care with who you
940 michael 1729 * give administrator privileges to.
941 db 897 */
942     hide_server_ips = no;
943     };
944    
945     /*
946     * general {}: The general block contains many of the options that were once
947 michael 1783 * compiled in options in config.h
948 db 897 */
949     general {
950 michael 2286 /*
951     * cycle_on_host_change: sends a fake QUIT/JOIN combination
952     * when services change the hostname of a specific client.
953     */
954     cycle_on_host_change = yes;
955    
956 michael 1157 /* services_name: servername of nick/channel services */
957     services_name = "service.someserver";
958    
959 michael 951 /* max_watch: maximum WATCH entries a client can have. */
960 michael 3883 max_watch = 30;
961 db 897
962 michael 3883 /* max_accept: maximum allowed /accept's for +g usermode. */
963     max_accept = 30;
964    
965 michael 2322 /* gline_enable: enable glines (network-wide temporary klines). */
966 michael 1459 gline_enable = yes;
967    
968 db 897 /*
969 michael 1459 * gline_duration: the amount of time a gline will remain on your
970 michael 1863 * server before expiring.
971 michael 1459 */
972     gline_duration = 1 day;
973    
974     /*
975 michael 1863 * gline_request_duration: how long a pending G-line can be around.
976     * 10 minutes should be plenty.
977 michael 1459 */
978     gline_request_duration = 10 minutes;
979    
980     /*
981 db 897 * gline_min_cidr: the minimum required length of a CIDR bitmask
982 michael 1863 * for IPv4 based glines.
983 db 897 */
984     gline_min_cidr = 16;
985    
986     /*
987     * gline_min_cidr6: the minimum required length of a CIDR bitmask
988 michael 1863 * for IPv6 based glines.
989 db 897 */
990     gline_min_cidr6 = 48;
991    
992     /*
993 michael 3446 * invisible_on_connect: whether to automatically set mode +i on
994     * connecting users.
995 db 897 */
996     invisible_on_connect = yes;
997    
998     /*
999 michael 2322 * kill_chase_time_limit: KILL chasing is a feature whereby a KILL
1000     * issued for a user who has recently changed nickname will be applied
1001     * automatically to the new nick. kill_chase_time_limit is the maximum
1002     * time following a nickname change that this chasing will apply.
1003 db 897 */
1004 michael 3341 kill_chase_time_limit = 30 seconds;
1005 db 897
1006     /*
1007 michael 1863 * hide_spoof_ips: if disabled, opers will be allowed to see the real
1008 michael 2322 * IP address of spoofed users in /trace etc. If this is defined they
1009     * will be shown a masked IP.
1010 db 897 */
1011     hide_spoof_ips = yes;
1012    
1013     /*
1014 michael 1863 * Ignore bogus timestamps from other servers. Yes, this will desync the
1015     * network, but it will allow chanops to resync with a valid non TS 0
1016 db 897 *
1017     * This should be enabled network wide, or not at all.
1018     */
1019     ignore_bogus_ts = no;
1020    
1021     /*
1022     * disable_auth: completely disable ident lookups; if you enable this,
1023     * be careful of what you set need_ident to in your auth {} blocks
1024     */
1025     disable_auth = no;
1026    
1027     /*
1028     * tkline_expire_notices: enables or disables temporary kline/xline
1029     * expire notices.
1030     */
1031     tkline_expire_notices = no;
1032    
1033     /*
1034     * default_floodcount: the default value of floodcount that is configurable
1035 michael 2322 * via /quote set floodcount. This is the number of lines a user
1036 db 897 * may send to any other user/channel in one second.
1037     */
1038     default_floodcount = 10;
1039    
1040     /*
1041 michael 2305 * failed_oper_notice: send a notice to all opers on the server when
1042 db 897 * someone tries to OPER and uses the wrong password, host or ident.
1043     */
1044     failed_oper_notice = yes;
1045    
1046     /*
1047 michael 2322 * dots_in_ident: the number of '.' characters permitted in an ident
1048 db 897 * reply before the user is rejected.
1049     */
1050     dots_in_ident = 2;
1051    
1052     /*
1053 michael 2322 * min_nonwildcard: the minimum number of non-wildcard characters in
1054     * k/d/g lines placed via the server. K-lines hand-placed are exempt from
1055     * this limit.
1056 michael 2026 * Wildcard chars: '.', ':', '*', '?', '@', '!'
1057 db 897 */
1058     min_nonwildcard = 4;
1059    
1060     /*
1061 michael 2322 * min_nonwildcard_simple: the minimum number of non-wildcard characters
1062     * in gecos bans. Wildcard chars: '*', '?'
1063 db 897 */
1064     min_nonwildcard_simple = 3;
1065    
1066 michael 1863 /* anti_nick_flood: enable the nickflood control code. */
1067 db 897 anti_nick_flood = yes;
1068    
1069 michael 2322 /* nick flood: the number of nick changes allowed in the specified period */
1070 db 897 max_nick_time = 20 seconds;
1071     max_nick_changes = 5;
1072    
1073     /*
1074     * anti_spam_exit_message_time: the minimum time a user must be connected
1075     * before custom quit messages are allowed.
1076     */
1077     anti_spam_exit_message_time = 5 minutes;
1078    
1079     /*
1080 michael 3883 * ts_warn_delta, ts_max_delta: the time delta allowed between server
1081     * clocks before a warning is given, or before the link is dropped.
1082     * All servers should run ntpdate/rdate to keep clocks in sync
1083 db 897 */
1084 michael 3341 ts_warn_delta = 10 seconds;
1085     ts_max_delta = 2 minutes;
1086 db 897
1087     /*
1088 michael 3474 * warn_no_connect_block: warn opers about servers that try to connect
1089     * but for which we don't have a connect {} block. Twits with
1090     * misconfigured servers can become really annoying with this enabled.
1091 db 897 */
1092 michael 3474 warn_no_connect_block = yes;
1093 db 897
1094     /*
1095     * stats_e_disabled: set this to 'yes' to disable "STATS e" for both
1096 michael 1863 * operators and administrators. Doing so is a good idea in case
1097 db 897 * there are any exempted (exempt{}) server IPs you don't want to
1098     * see leaked.
1099     */
1100     stats_e_disabled = no;
1101    
1102 michael 3883 /* stats_o_oper_only: make stats o (opers) oper only */
1103 db 897 stats_o_oper_only = yes;
1104    
1105     /* stats_P_oper_only: make stats P (ports) oper only */
1106     stats_P_oper_only = yes;
1107    
1108 michael 2269 /* stats_u_oper_only: make stats u (uptime) oper only */
1109     stats_u_oper_only = no;
1110    
1111 db 897 /*
1112 michael 3521 * stats_i_oper_only: make stats i (auth {}) oper only. Set to:
1113 michael 1863 * yes - show users no auth blocks, made oper only.
1114 michael 2322 * masked - show users the first matching auth block
1115 michael 1863 * no - show users all auth blocks.
1116 db 897 */
1117     stats_i_oper_only = yes;
1118    
1119     /*
1120 michael 1863 * stats_k_oper_only: make stats k/K (klines) oper only. Set to:
1121     * yes - show users no auth blocks, made oper only
1122 michael 2322 * masked - show users the first matching auth block
1123 michael 1863 * no - show users all auth blocks.
1124 db 897 */
1125     stats_k_oper_only = yes;
1126    
1127     /*
1128     * caller_id_wait: time between notifying a +g user that somebody
1129     * is messaging them.
1130     */
1131     caller_id_wait = 1 minute;
1132    
1133     /*
1134     * opers_bypass_callerid: allows operators to bypass +g and message
1135     * anyone who has it set (useful if you use services).
1136     */
1137     opers_bypass_callerid = no;
1138    
1139     /*
1140 michael 2322 * pace_wait_simple: minimum time required between use of less
1141     * intensive commands
1142 michael 3521 * (ADMIN, HELP, LUSERS, VERSION, remote WHOIS)
1143 db 897 */
1144     pace_wait_simple = 1 second;
1145    
1146     /*
1147 michael 2322 * pace_wait: minimum time required between use of more intensive commands
1148 michael 3531 * (AWAY, INFO, LINKS, MAP, MOTD, STATS, WHO, WHOWAS)
1149 db 897 */
1150     pace_wait = 10 seconds;
1151    
1152     /*
1153 michael 2322 * short_motd: send clients a notice telling them to read the MOTD
1154     * instead of forcing an MOTD to clients who may simply ignore it.
1155 db 897 */
1156     short_motd = no;
1157    
1158     /*
1159     * ping_cookie: require clients to respond exactly to a ping command,
1160     * can help block certain types of drones and FTP PASV mode spoofing.
1161     */
1162     ping_cookie = no;
1163    
1164     /* no_oper_flood: increase flood limits for opers. */
1165     no_oper_flood = yes;
1166    
1167     /*
1168     * true_no_oper_flood: completely eliminate flood limits for opers
1169 michael 1863 * and for clients with can_flood = yes in their auth {} blocks.
1170 db 897 */
1171     true_no_oper_flood = yes;
1172    
1173 michael 1863 /* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels. */
1174 db 897 oper_pass_resv = yes;
1175    
1176 michael 2345 /* REMOVE ME. The following line checks that you have been reading. */
1177 db 897 havent_read_conf = 1;
1178    
1179     /*
1180 michael 2322 * max_targets: the maximum number of targets in a single
1181 michael 1863 * PRIVMSG/NOTICE. Set to 999 NOT 0 for unlimited.
1182 db 897 */
1183     max_targets = 4;
1184    
1185     /*
1186     * usermodes configurable: a list of usermodes for the options below
1187     *
1188     * +b - bots - See bot and drone flooding notices
1189     * +c - cconn - Client connection/quit notices
1190     * +D - deaf - Don't receive channel messages
1191     * +d - debug - See debugging notices
1192 michael 1818 * +e - external - See remote server connection and split notices
1193 michael 1976 * +F - farconnect - Remote client connection/quit notices
1194 michael 1426 * +f - full - See auth{} block full notices
1195 db 897 * +G - softcallerid - Server Side Ignore for users not on your channels
1196     * +g - callerid - Server Side Ignore (for privmsgs etc)
1197 michael 1294 * +H - hidden - Hides operator status to other users
1198 michael 2345 * +i - invisible - Not shown in NAMES or WHO unless you share a channel
1199 michael 1290 * +j - rej - See rejected client notices
1200 db 897 * +k - skill - See server generated KILL messages
1201     * +l - locops - See LOCOPS messages
1202     * +n - nchange - See client nick changes
1203 michael 3515 * +p - hidechans - Hides channel list in WHOIS
1204 michael 3507 * +q - hideidle - Hides idle and signon time in WHOIS
1205 michael 1855 * +R - nononreg - Only receive private messages from registered clients
1206 db 897 * +s - servnotice - See general server notices
1207     * +u - unauth - See unauthorized client notices
1208     * +w - wallop - See server generated WALLOPS
1209     * +y - spy - See LINKS, STATS, TRACE notices etc.
1210     */
1211    
1212     /* oper_only_umodes: usermodes only opers may set */
1213 michael 2185 oper_only_umodes = bots, cconn, debug, full, hidden, skill,
1214 michael 3867 nchange, rej, spy, external,
1215 michael 2841 locops, unauth, farconnect;
1216 db 897
1217     /* oper_umodes: default usermodes opers get when they /oper */
1218 michael 3867 oper_umodes = bots, locops, servnotice, wallop;
1219 db 897
1220     /*
1221     * use_egd: if your system does not have *random devices yet you
1222 michael 1863 * want to use OpenSSL and encrypted links, enable this. Beware -
1223     * EGD is *very* CPU intensive when gathering data for its pool.
1224 db 897 */
1225     # use_egd = yes;
1226    
1227     /*
1228     * egdpool_path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1229     * which automatically finds the path.
1230     */
1231     # egdpool_path = "/var/run/egd-pool";
1232    
1233 michael 3876
1234 db 897 /*
1235 michael 3876 * throttle_count: the maximum number of connections from the same
1236     * IP address allowed in throttle_time duration.
1237     */
1238     throttle_count = 1;
1239    
1240     /*
1241 michael 2322 * throttle_time: the minimum amount of time required between
1242 michael 3876 * connections from the same IP address. exempt {} blocks are
1243     * excluded from this throttling.
1244 michael 1863 * Offers protection against flooders who reconnect quickly.
1245 db 897 * Set to 0 to disable.
1246     */
1247 michael 3876 throttle_time = 2 seconds;
1248 db 897 };
1249    
1250     modules {
1251     /*
1252 michael 951 * path: other paths to search for modules specified below
1253 michael 1441 * and in "/module load".
1254 db 897 */
1255 michael 1070 path = "/usr/local/ircd/lib/ircd-hybrid/modules";
1256     path = "/usr/local/ircd/lib/ircd-hybrid/modules/autoload";
1257 db 897
1258 michael 1863 /* module: the name of a module to load on startup/rehash. */
1259 michael 2171 # module = "some_module.la";
1260 db 897 };
1261 michael 1247
1262     /*
1263     * log {}: contains information about logfiles.
1264     */
1265     log {
1266     /* Do you want to enable logging to ircd.log? */
1267     use_logging = yes;
1268    
1269     file {
1270     type = oper;
1271 michael 2171 name = "/usr/local/ircd/var/log/oper.log";
1272 michael 1250 size = unlimited;
1273 michael 1247 };
1274    
1275     file {
1276     type = user;
1277 michael 2171 name = "/usr/local/ircd/var/log/user.log";
1278 michael 1247 size = 50 megabytes;
1279     };
1280    
1281     file {
1282     type = kill;
1283 michael 2171 name = "/usr/local/ircd/var/log/kill.log";
1284 michael 1247 size = 50 megabytes;
1285     };
1286    
1287     file {
1288     type = kline;
1289 michael 2171 name = "/usr/local/ircd/var/log/kline.log";
1290 michael 1247 size = 50 megabytes;
1291     };
1292    
1293     file {
1294     type = dline;
1295 michael 2171 name = "/usr/local/ircd/var/log/dline.log";
1296 michael 1247 size = 50 megabytes;
1297     };
1298    
1299     file {
1300     type = gline;
1301 michael 2171 name = "/usr/local/ircd/var/log/gline.log";
1302 michael 1247 size = 50 megabytes;
1303     };
1304    
1305     file {
1306 michael 2336 type = xline;
1307     name = "/usr/local/ircd/var/log/xline.log";
1308     size = 50 megabytes;
1309     };
1310    
1311     file {
1312     type = resv;
1313     name = "/usr/local/ircd/var/log/resv.log";
1314     size = 50 megabytes;
1315     };
1316    
1317     file {
1318 michael 1247 type = debug;
1319 michael 2171 name = "/usr/local/ircd/var/log/debug.log";
1320 michael 1247 size = 50 megabytes;
1321 michael 1824 };
1322 michael 1247 };

Properties

Name Value
svn:eol-style native
svn:keywords Id Revision