ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/branches/8.2.x/doc/reference.conf
Revision: 2234
Committed: Fri Jun 14 18:40:21 2013 UTC (13 years, 1 month ago) by michael
Original Path: ircd-hybrid/trunk/doc/reference.conf
File size: 35880 byte(s)
Log Message:
- Update doc/reference.conf

File Contents

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

Properties

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