ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/doc/reference.conf
Revision: 2328
Committed: Sun Jun 23 12:47:41 2013 UTC (10 years, 9 months ago) by michael
File size: 37247 byte(s)
Log Message:
- reference.conf: fixed typo

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 michael 2322 * IMPORTANT NOTE:
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 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 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 michael 2322 * vhost6: the address to bind to when we make outgoing connections
80     * to IPv6 servers. This should be an IPv6 address, 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 2322 * rsa_private_key_file: the path to the file containing the
102     * RSA key for cryptlink.
103 db 897 *
104 michael 2322 * Example commands to store a 2048 bit RSA keypair in
105 db 897 * rsa.key, and the public key in rsa.pub:
106 michael 2308 *
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 2322 * 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 michael 2322 * DH parameters are required when using ciphers with EDH
142     * (ephemeral Diffie-Hellman) key exchange.
143 michael 1351 *
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 2322 * List of ciphers to support on _this_ server. Can be used to
158 michael 1524 * enforce specific ciphers for incoming SSL/TLS connections.
159 michael 2322 * If a client (which also includes incoming server connections) is not
160     * capable of using any of the ciphers listed here, the connection will
161     * simply be rejected.
162 michael 1550 *
163 michael 2322 * A list of supported ciphers by OpenSSL can be obtained by running:
164 michael 1306 *
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 michael 2322 * from a single IP address (optional)
209 db 897 */
210     number_per_ip = 2;
211    
212     /*
213     * max_local: how many local users are allowed to connect
214 michael 2322 * from a single ident@host (optional)
215 db 897 */
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 2322 * sendq: the amount of data allowed in a client's send queue before
238 db 897 * they are dropped.
239     */
240     sendq = 100 kbytes;
241 michael 1516
242     /*
243 michael 2322 * recvq: the amount of data allowed in a client's receive queue before
244 michael 1541 * 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 michael 2322 * random_idle - a fake idle time is set randomly between
271     * min_idle and max_idle
272     * hide_idle_from_opers - the fake idle time will also be shown to operators
273 michael 1783 */
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 2322 /* max number: the number 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 2322 * motd {}: Allows the display of a different MOTD to a client
296 michael 2210 * 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 2322 * port: the port to listen on. If no host is specified
319     * earlier in the listen {} block, it will listen on all available IPs.
320 db 897 *
321 michael 2328 * Ports are separated by commas; a range may be specified using ".."
322 db 897 */
323    
324 michael 2322 /* port: listen on all available IP addresses, ports 6665 to 6669 */
325 db 897 port = 6665 .. 6669;
326    
327     /*
328 michael 2322 * Listen on 192.168.0.1/6697 with SSL enabled and hidden from STATS P
329 db 897 * unless you are an administrator.
330     *
331 michael 2322 * NOTE: The "flags" directive always has to come before "port".
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 michael 2322 * host: set a specific IP address/host to listen on using the
345     * subsequent port definitions. 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 michael 2322 * lines are permitted within each auth block.
361 db 897 */
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 2322 * spoof: fake the user's host to this. This is free-form, just do
376 michael 1863 * 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 michael 2322 * 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 michael 2322 * glibc already has support for the SHA-256/512 and MD5 encryption
443 michael 1070 * 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 michael 2322 * A password should not be defined when this is used; see
456 db 897 * doc/challenge.txt for more information.
457     */
458     # rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
459    
460 michael 2228 /*
461 michael 2244 * ssl_certificate_fingerprint: enhances security by additionally checking
462     * the oper's client certificate fingerprint against the specified
463     * fingerprint below.
464 michael 2236 *
465     * Hint: your users can use the following command to obtain a SHA-256 hash
466     * of their ssl certificate:
467     *
468     * openssl x509 -sha256 -noout -fingerprint -in cert.pem | sed -e 's/^.*=//;s/://g'
469 michael 2228 */
470 michael 2244 # ssl_certificate_fingerprint = "4C62287BA6776A89CD4F8FF10A62FFB35E79319F51AF6C62C674984974FCCB1D";
471 michael 2228
472 michael 2248 /*
473     * ssl_connection_required: client must be connected over SSL/TLS
474     * in order to be able to use this oper{} block.
475 michael 2279 * Default is 'no' if nothing else is specified.
476 michael 2248 */
477     ssl_connection_required = no;
478    
479 db 897 /* class: the class the oper joins when they successfully /oper */
480     class = "opers";
481    
482     /*
483 michael 2322 * umodes: the default usermodes opers get when they /oper. If defined,
484 db 897 * it will override oper_umodes settings in general {}.
485     * Available usermodes:
486     *
487     * +b - bots - See bot and drone flooding notices
488     * +c - cconn - Client connection/quit notices
489     * +D - deaf - Don't receive channel messages
490     * +d - debug - See debugging notices
491 michael 1818 * +e - external - See remote server connection and split notices
492 michael 1976 * +F - farconnect - Remote client connection/quit notices
493 michael 1426 * +f - full - See auth{} block full notices
494 db 897 * +G - softcallerid - Server Side Ignore for users not on your channels
495     * +g - callerid - Server Side Ignore (for privmsgs etc)
496 michael 1294 * +H - hidden - Hides operator status to other users
497 michael 2267 * +i - invisible - Not shown in NAMES or WHO unless you share a channel
498 michael 1290 * +j - rej - See rejected client notices
499 db 897 * +k - skill - See server generated KILL messages
500     * +l - locops - See LOCOPS messages
501     * +n - nchange - See client nick changes
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     * +z - operwall - See oper generated WALLOPS
508     */
509 michael 2171 umodes = locops, servnotice, operwall, wallop;
510 db 897
511     /*
512 michael 2305 * privileges: controls the activities and commands an oper is
513 michael 1228 * allowed to do on the server. All options default to no.
514 db 897 * Available options:
515     *
516 michael 2012 * module - allows MODULE
517 michael 2018 * connect - allows local CONNECT | ('P' flag)
518     * connect:remote - allows remote CONNECT | ('Q' flag)
519     * squit - allows local SQUIT | ('R' flag)
520     * squit:remote - allows remote SQUIT | ('S' flag)
521     * kill - allows to KILL local clients | ('N' flag)
522     * kill:remote - allows remote users to be /KILL'd | ('O' flag)
523     * remoteban - allows remote KLINE/UNKLINE | ('B' flag)
524     * dline - allows DLINE |
525     * undline - allows UNDLINE |
526     * kline - allows KLINE | ('K' flag)
527     * unkline - allows UNKLINE | ('U' flag)
528     * gline - allows GLINE | ('G' flag)
529     * xline - allows XLINE | ('X' flag)
530 michael 2038 * locops - allows LOCOPS |
531 michael 2018 * globops - allows GLOBOPS |
532 michael 2038 * wallops - allows WALLOPS |
533 michael 2018 * operwall - allows OPERWALL | ('L' flag)
534     * rehash - allows oper to REHASH config | ('H' flag)
535     * die - allows DIE | ('D' flag)
536     * restart - allows RESTART |
537     * set - allows SET |
538     * admin - gives administrator privileges | ('A' flag)
539 db 897 */
540 michael 2012 flags = kill, kill:remote, connect, connect:remote, kline, unkline,
541     xline, globops, restart, die, rehash, admin, operwall, module;
542 db 897 };
543    
544 michael 1552 /*
545 michael 2322 * service {}: specifies a server which may act as a network service
546 michael 1552 *
547 michael 2322 * NOTE: it is very important that every server on the network
548 michael 1552 * has the same service{} block.
549     */
550 michael 1157 service {
551     name = "service.someserver";
552 michael 1302 name = "stats.someserver";
553 michael 1157 };
554    
555 db 897 /*
556 michael 2322 * connect {}: define a server to connect to
557 db 897 */
558     connect {
559     /* name: the name of the server */
560     name = "irc.uplink.com";
561    
562     /*
563 michael 2322 * host: the host or IP address to connect to. If a hostname is used it
564     * must match the reverse DNS of the server.
565 db 897 */
566     host = "192.168.0.1";
567    
568     /*
569 michael 2322 * vhost: the IP address to bind to when making outgoing connections to
570     * servers.
571 db 897 * serverinfo::vhost and serverinfo::vhost6 will be overridden
572     * by this directive.
573     */
574     vhost = "192.168.0.2";
575    
576     /*
577 michael 2322 * passwords: the passwords to send (OLD C:) and accept (OLD N:).
578     * The remote server will have these passwords swapped.
579 db 897 */
580     send_password = "password";
581     accept_password = "anotherpassword";
582    
583     /*
584     * encrypted: controls whether the accept_password above has been
585 michael 1070 * encrypted.
586 db 897 */
587     encrypted = no;
588    
589     /* port: the port to connect to this server on */
590     port = 6666;
591    
592     /*
593 michael 1863 * hub_mask: the mask of servers that this server may hub. Multiple
594     * entries are permitted.
595 db 897 */
596     hub_mask = "*";
597    
598     /*
599 michael 1863 * leaf_mask: the mask of servers this server may not hub. Multiple
600     * entries are permitted. Useful for forbidding EU -> US -> EU routes.
601 db 897 */
602     # leaf_mask = "*.uk";
603    
604     /* class: the class this server is in */
605     class = "server";
606    
607 michael 1524 /*
608     * ssl_cipher_list:
609     *
610     * List of ciphers that the server we are connecting to must support.
611 michael 2322 * If the server is not capable of using any of the ciphers listed below,
612     * the connection will simply be rejected.
613 michael 1524 * Can be used to enforce stronger ciphers, even though this option
614     * is not necessarily required to establish a SSL/TLS connection.
615     *
616     * Multiple ciphers are separated by colons. The order of preference
617     * is from left to right.
618     */
619 michael 2171 # ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
620 michael 1306
621 db 897 /*
622 michael 2244 * ssl_certificate_fingerprint: enhances security by additionally checking
623     * the server's client certificate fingerprint against the specified
624     * fingerprint below.
625 michael 2228 */
626 michael 2244 # ssl_certificate_fingerprint = "4C62287BA6776A89CD4F8FF10A62FFB35E79319F51AF6C62C674984974FCCB1D";
627 michael 2228
628     /*
629 michael 1229 * autoconn - controls whether we autoconnect to this server or not,
630     * dependent on class limits. By default, this is disabled.
631 michael 1303 * ssl - Initiates a TLS/SSL connection.
632 db 897 */
633 michael 1519 # flags = autoconn, ssl;
634 db 897 };
635    
636     connect {
637 michael 1285 name = "ipv6.some.server";
638 db 897 host = "3ffd:dead:beef::1";
639     send_password = "password";
640     accept_password = "password";
641     port = 6666;
642    
643     /*
644     * aftype: controls whether the connection uses "ipv4" or "ipv6".
645     * Default is ipv4.
646     */
647     aftype = ipv6;
648     class = "server";
649     };
650    
651     /*
652     * cluster {}: servers that share klines/unkline/xline/unxline/resv/unresv/locops
653 michael 1229 * automatically
654 db 897 */
655     cluster {
656     /*
657 michael 2322 * name: the server to share with; this can take wildcards
658 db 897 *
659 michael 2322 * NOTE: only local actions will be clustered, meaning that if
660 db 897 * the server receives a shared kline/unkline/etc, it
661     * will not be propagated to clustered servers.
662     *
663     * Remote servers are not necessarily required to accept
664     * clustered lines, they need a shared{} for *THIS* server
665     * in order to accept them.
666     */
667     name = "*.arpa";
668    
669     /*
670 michael 2322 * type: list of what to share; options are as follows:
671 michael 1301 * dline - share dlines
672     * undline - share undlines
673 michael 1336 * kline - share klines
674     * unkline - share unklines
675     * xline - share xlines
676     * unxline - share unxlines
677     * resv - share resvs
678     * unresv - share unresvs
679     * locops - share locops
680     * all - share all of the above (default)
681 db 897 */
682     type = kline, unkline, locops, xline, resv;
683     };
684    
685     /*
686 michael 1229 * shared {}: users that are allowed to remote kline
687 db 897 *
688 michael 2322 * NOTE: This can effectively be used for remote klines.
689 db 897 * Please note that there is no password authentication
690 michael 1863 * for users setting remote klines. You must also be
691 db 897 * /oper'd in order to issue a remote kline.
692     */
693     shared {
694     /*
695 michael 2322 * name: the server the user must be connected to in order to set klines.
696     * If this is not specified, the user will be allowed to kline from all
697     * servers.
698 db 897 */
699     name = "irc2.some.server";
700    
701     /*
702 michael 1863 * user: the user@host mask that is allowed to set klines. If this is
703 db 897 * not specified, all users on the server above will be allowed to set
704     * a remote kline.
705     */
706     user = "oper@my.host.is.spoofed";
707    
708     /*
709     * type: list of what to share, options are as follows:
710 michael 1301 * dline - allow oper/server to dline
711     * undline - allow oper/server to undline
712 michael 1336 * kline - allow oper/server to kline
713     * unkline - allow oper/server to unkline
714     * xline - allow oper/server to xline
715     * unxline - allow oper/server to unxline
716     * resv - allow oper/server to resv
717     * unresv - allow oper/server to unresv
718 db 897 * locops - allow oper/server to locops - only used for servers that cluster
719 michael 1336 * all - allow oper/server to do all of the above (default)
720 db 897 */
721     type = kline, unkline, resv;
722     };
723    
724     /*
725 michael 1229 * kill {}: users that are not allowed to connect
726 db 897 * Oper issued klines will be added to the specified kline config
727     */
728     kill {
729     user = "bad@*.hacked.edu";
730     reason = "Obviously hacked account";
731     };
732    
733     /*
734 michael 2322 * deny {}: IP addresses that are not allowed to connect
735     * (before DNS/ident lookup)
736 db 897 * Oper issued dlines will be added to the specified dline config
737     */
738     deny {
739     ip = "10.0.1.0/24";
740     reason = "Reconnecting vhosted bots";
741     };
742    
743     /*
744 michael 2322 * exempt {}: IP addresses that are exempt from deny {} and Dlines
745 db 897 */
746     exempt {
747     ip = "192.168.0.0/16";
748     };
749    
750     /*
751 michael 1229 * resv {}: nicks and channels users may not use/join
752 db 897 */
753 michael 1858 resv { mask = "clone*"; reason = "Clone bots"; };
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     reason = "Channel is reserved for finnish inhabitants";
771    
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     * knock_delay: The amount of time a user must wait between issuing
814     * the knock command.
815     */
816 michael 951 knock_delay = 5 minutes;
817 db 897
818     /*
819     * knock_delay_channel: How often a knock to any specific channel
820     * is permitted, regardless of the user sending the knock.
821     */
822     knock_delay_channel = 1 minute;
823    
824     /*
825     * max_chans_per_user: The maximum number of channels a user can
826     * join/be on.
827     */
828     max_chans_per_user = 25;
829    
830 michael 1432 /*
831     * max_chans_per_oper: The maximum number of channels an oper can
832     * join/be on.
833     */
834     max_chans_per_oper = 50;
835    
836 db 897 /* max_bans: maximum number of +b/e/I modes in a channel */
837 michael 1522 max_bans = 100;
838 db 897
839     /*
840 michael 2322 * how many joins in how many seconds constitute a flood. Use 0 to
841 db 897 * disable. +b opers will be notified (changeable via /set)
842     */
843     join_flood_count = 16;
844     join_flood_time = 8 seconds;
845    
846     /*
847 michael 2322 * The ircd will now check splitmode (whether a server is split from
848     * the network) every few seconds; this functionality is known as
849     * splitcode and is influenced by the options below.
850 db 897 *
851     * Either split users or split servers can activate splitmode, but
852     * both conditions must be met for the ircd to deactivate splitmode.
853     *
854     * You may force splitmode to be permanent by /quote set splitmode on
855     */
856    
857     /*
858     * default_split_user_count: when the usercount is lower than this level,
859 michael 1863 * consider ourselves split. This must be set for automatic splitmode.
860 db 897 */
861     default_split_user_count = 0;
862    
863     /*
864     * default_split_server_count: when the servercount is lower than this,
865 michael 1863 * consider ourselves split. This must be set for automatic splitmode.
866 db 897 */
867     default_split_server_count = 0;
868    
869 michael 2322 /* no_create_on_split: do not allow users to create channels on split. */
870 db 897 no_create_on_split = yes;
871    
872 michael 2322 /* no_join_on_split: do not allow users to join channels on a split. */
873 db 897 no_join_on_split = no;
874     };
875    
876     /*
877     * serverhide {}: The serverhide block contains the options regarding
878 michael 2322 * to server hiding
879 db 897 */
880     serverhide {
881     /*
882 michael 2322 * disable_remote_commands: disable users issuing commands
883 michael 2196 * on remote servers.
884     */
885     disable_remote_commands = no;
886    
887     /*
888 db 897 * flatten_links: this option will show all servers in /links appear
889 michael 2322 * as though they are linked to this current server.
890 db 897 */
891     flatten_links = no;
892    
893     /*
894     * links_delay: how often to update the links file when it is
895     * flattened.
896     */
897     links_delay = 5 minutes;
898    
899     /*
900     * hidden: hide this server from a /links output on servers that
901 michael 1863 * support it. This allows hub servers to be hidden etc.
902 db 897 */
903     hidden = no;
904    
905     /*
906     * hide_servers: hide remote servernames everywhere and instead use
907     * hidden_name and network_desc.
908     */
909     hide_servers = no;
910    
911     /*
912 michael 1851 * hide_services: define this if you want to hide the location of
913 michael 1852 * services servers that are specified in the service{} block.
914 michael 1851 */
915     hide_services = no;
916    
917     /*
918 db 897 * Use this as the servername users see if hide_servers = yes.
919     */
920     hidden_name = "*.hidden.com";
921    
922     /*
923 michael 951 * hide_server_ips: If this is disabled, opers will be unable to see
924 michael 2322 * servers' IP addresses and will be shown a masked IP address; admins
925     * will be shown the real IP address.
926 db 897 *
927 michael 2322 * If this is enabled, nobody can see a server's IP address.
928     * *This is a kludge*: it has the side effect of hiding the IP addresses
929     * everywhere, including logfiles.
930 db 897 *
931     * We recommend you leave this disabled, and just take care with who you
932 michael 1729 * give administrator privileges to.
933 db 897 */
934     hide_server_ips = no;
935     };
936    
937     /*
938     * general {}: The general block contains many of the options that were once
939 michael 1783 * compiled in options in config.h
940 db 897 */
941     general {
942 michael 2286 /*
943     * cycle_on_host_change: sends a fake QUIT/JOIN combination
944     * when services change the hostname of a specific client.
945     */
946     cycle_on_host_change = yes;
947    
948 michael 1157 /* services_name: servername of nick/channel services */
949     services_name = "service.someserver";
950    
951 michael 951 /* max_watch: maximum WATCH entries a client can have. */
952 michael 1070 max_watch = 60;
953 db 897
954 michael 2322 /* gline_enable: enable glines (network-wide temporary klines). */
955 michael 1459 gline_enable = yes;
956    
957 db 897 /*
958 michael 1459 * gline_duration: the amount of time a gline will remain on your
959 michael 1863 * server before expiring.
960 michael 1459 */
961     gline_duration = 1 day;
962    
963     /*
964 michael 1863 * gline_request_duration: how long a pending G-line can be around.
965     * 10 minutes should be plenty.
966 michael 1459 */
967     gline_request_duration = 10 minutes;
968    
969     /*
970 db 897 * gline_min_cidr: the minimum required length of a CIDR bitmask
971 michael 1863 * for IPv4 based glines.
972 db 897 */
973     gline_min_cidr = 16;
974    
975     /*
976     * gline_min_cidr6: the minimum required length of a CIDR bitmask
977 michael 1863 * for IPv6 based glines.
978 db 897 */
979     gline_min_cidr6 = 48;
980    
981     /*
982     * Whether to automatically set mode +i on connecting users.
983     */
984     invisible_on_connect = yes;
985    
986     /*
987 michael 2322 * kill_chase_time_limit: KILL chasing is a feature whereby a KILL
988     * issued for a user who has recently changed nickname will be applied
989     * automatically to the new nick. kill_chase_time_limit is the maximum
990     * time following a nickname change that this chasing will apply.
991 db 897 */
992 michael 1074 kill_chase_time_limit = 90 seconds;
993 db 897
994     /*
995 michael 1863 * hide_spoof_ips: if disabled, opers will be allowed to see the real
996 michael 2322 * IP address of spoofed users in /trace etc. If this is defined they
997     * will be shown a masked IP.
998 db 897 */
999     hide_spoof_ips = yes;
1000    
1001     /*
1002 michael 1863 * Ignore bogus timestamps from other servers. Yes, this will desync the
1003     * network, but it will allow chanops to resync with a valid non TS 0
1004 db 897 *
1005     * This should be enabled network wide, or not at all.
1006     */
1007     ignore_bogus_ts = no;
1008    
1009     /*
1010     * disable_auth: completely disable ident lookups; if you enable this,
1011     * be careful of what you set need_ident to in your auth {} blocks
1012     */
1013     disable_auth = no;
1014    
1015     /*
1016     * tkline_expire_notices: enables or disables temporary kline/xline
1017     * expire notices.
1018     */
1019     tkline_expire_notices = no;
1020    
1021     /*
1022     * default_floodcount: the default value of floodcount that is configurable
1023 michael 2322 * via /quote set floodcount. This is the number of lines a user
1024 db 897 * may send to any other user/channel in one second.
1025     */
1026     default_floodcount = 10;
1027    
1028     /*
1029 michael 2305 * failed_oper_notice: send a notice to all opers on the server when
1030 db 897 * someone tries to OPER and uses the wrong password, host or ident.
1031     */
1032     failed_oper_notice = yes;
1033    
1034     /*
1035 michael 2322 * dots_in_ident: the number of '.' characters permitted in an ident
1036 db 897 * reply before the user is rejected.
1037     */
1038     dots_in_ident = 2;
1039    
1040     /*
1041 michael 2322 * min_nonwildcard: the minimum number of non-wildcard characters in
1042     * k/d/g lines placed via the server. K-lines hand-placed are exempt from
1043     * this limit.
1044 michael 2026 * Wildcard chars: '.', ':', '*', '?', '@', '!'
1045 db 897 */
1046     min_nonwildcard = 4;
1047    
1048     /*
1049 michael 2322 * min_nonwildcard_simple: the minimum number of non-wildcard characters
1050     * in gecos bans. Wildcard chars: '*', '?'
1051 db 897 */
1052     min_nonwildcard_simple = 3;
1053    
1054 michael 1863 /* max_accept: maximum allowed /accept's for +g usermode. */
1055 db 897 max_accept = 20;
1056    
1057 michael 1863 /* anti_nick_flood: enable the nickflood control code. */
1058 db 897 anti_nick_flood = yes;
1059    
1060 michael 2322 /* nick flood: the number of nick changes allowed in the specified period */
1061 db 897 max_nick_time = 20 seconds;
1062     max_nick_changes = 5;
1063    
1064     /*
1065     * anti_spam_exit_message_time: the minimum time a user must be connected
1066     * before custom quit messages are allowed.
1067     */
1068     anti_spam_exit_message_time = 5 minutes;
1069    
1070     /*
1071     * ts delta: the time delta allowed between server clocks before
1072 michael 1863 * a warning is given, or before the link is dropped. All servers
1073 db 897 * should run ntpdate/rdate to keep clocks in sync
1074     */
1075     ts_warn_delta = 30 seconds;
1076     ts_max_delta = 5 minutes;
1077    
1078     /*
1079     * warn_no_nline: warn opers about servers that try to connect but
1080 michael 2322 * for which we don't have a connect {} block. Twits with misconfigured
1081     * servers can become really annoying with this enabled.
1082 db 897 */
1083     warn_no_nline = yes;
1084    
1085     /*
1086     * stats_e_disabled: set this to 'yes' to disable "STATS e" for both
1087 michael 1863 * operators and administrators. Doing so is a good idea in case
1088 db 897 * there are any exempted (exempt{}) server IPs you don't want to
1089     * see leaked.
1090     */
1091     stats_e_disabled = no;
1092    
1093     /* stats_o_oper only: make stats o (opers) oper only */
1094     stats_o_oper_only = yes;
1095    
1096     /* stats_P_oper_only: make stats P (ports) oper only */
1097     stats_P_oper_only = yes;
1098    
1099 michael 2269 /* stats_u_oper_only: make stats u (uptime) oper only */
1100     stats_u_oper_only = no;
1101    
1102 db 897 /*
1103 michael 1863 * stats i oper only: make stats i (auth {}) oper only. Set to:
1104     * yes - show users no auth blocks, made oper only.
1105 michael 2322 * masked - show users the first matching auth block
1106 michael 1863 * no - show users all auth blocks.
1107 db 897 */
1108     stats_i_oper_only = yes;
1109    
1110     /*
1111 michael 1863 * stats_k_oper_only: make stats k/K (klines) oper only. Set to:
1112     * yes - show users no auth blocks, made oper only
1113 michael 2322 * masked - show users the first matching auth block
1114 michael 1863 * no - show users all auth blocks.
1115 db 897 */
1116     stats_k_oper_only = yes;
1117    
1118     /*
1119     * caller_id_wait: time between notifying a +g user that somebody
1120     * is messaging them.
1121     */
1122     caller_id_wait = 1 minute;
1123    
1124     /*
1125     * opers_bypass_callerid: allows operators to bypass +g and message
1126     * anyone who has it set (useful if you use services).
1127     */
1128     opers_bypass_callerid = no;
1129    
1130     /*
1131 michael 2322 * pace_wait_simple: minimum time required between use of less
1132     * intensive commands
1133 db 897 * (ADMIN, HELP, (L)USERS, VERSION, remote WHOIS)
1134     */
1135     pace_wait_simple = 1 second;
1136    
1137     /*
1138 michael 2322 * pace_wait: minimum time required between use of more intensive commands
1139 michael 1488 * (AWAY, INFO, LINKS, MAP, MOTD, STATS, WHO, wildcard WHOIS, WHOWAS)
1140 db 897 */
1141     pace_wait = 10 seconds;
1142    
1143     /*
1144 michael 2322 * short_motd: send clients a notice telling them to read the MOTD
1145     * instead of forcing an MOTD to clients who may simply ignore it.
1146 db 897 */
1147     short_motd = no;
1148    
1149     /*
1150     * ping_cookie: require clients to respond exactly to a ping command,
1151     * can help block certain types of drones and FTP PASV mode spoofing.
1152     */
1153     ping_cookie = no;
1154    
1155     /* no_oper_flood: increase flood limits for opers. */
1156     no_oper_flood = yes;
1157    
1158     /*
1159     * true_no_oper_flood: completely eliminate flood limits for opers
1160 michael 1863 * and for clients with can_flood = yes in their auth {} blocks.
1161 db 897 */
1162     true_no_oper_flood = yes;
1163    
1164 michael 1863 /* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels. */
1165 db 897 oper_pass_resv = yes;
1166    
1167 michael 2322 /* REMOVE ME. The following line checks that you have been reading. */
1168 db 897 havent_read_conf = 1;
1169    
1170     /*
1171 michael 2322 * max_targets: the maximum number of targets in a single
1172 michael 1863 * PRIVMSG/NOTICE. Set to 999 NOT 0 for unlimited.
1173 db 897 */
1174     max_targets = 4;
1175    
1176     /*
1177     * usermodes configurable: a list of usermodes for the options below
1178     *
1179     * +b - bots - See bot and drone flooding notices
1180     * +c - cconn - Client connection/quit notices
1181     * +D - deaf - Don't receive channel messages
1182     * +d - debug - See debugging notices
1183 michael 1818 * +e - external - See remote server connection and split notices
1184 michael 1976 * +F - farconnect - Remote client connection/quit notices
1185 michael 1426 * +f - full - See auth{} block full notices
1186 db 897 * +G - softcallerid - Server Side Ignore for users not on your channels
1187     * +g - callerid - Server Side Ignore (for privmsgs etc)
1188 michael 1294 * +H - hidden - Hides operator status to other users
1189 db 897 * +i - invisible - Not shown in NAMES or WHO unless you share a
1190     * a channel
1191 michael 1290 * +j - rej - See rejected client notices
1192 db 897 * +k - skill - See server generated KILL messages
1193     * +l - locops - See LOCOPS messages
1194     * +n - nchange - See client nick changes
1195 michael 1855 * +R - nononreg - Only receive private messages from registered clients
1196 db 897 * +s - servnotice - See general server notices
1197     * +u - unauth - See unauthorized client notices
1198     * +w - wallop - See server generated WALLOPS
1199     * +y - spy - See LINKS, STATS, TRACE notices etc.
1200     * +z - operwall - See oper generated WALLOPS
1201     */
1202    
1203     /* oper_only_umodes: usermodes only opers may set */
1204 michael 2185 oper_only_umodes = bots, cconn, debug, full, hidden, skill,
1205 db 897 nchange, rej, spy, external, operwall,
1206 michael 1976 locops, unauth, farconnect;
1207 db 897
1208     /* oper_umodes: default usermodes opers get when they /oper */
1209     oper_umodes = bots, locops, servnotice, operwall, wallop;
1210    
1211     /*
1212     * use_egd: if your system does not have *random devices yet you
1213 michael 1863 * want to use OpenSSL and encrypted links, enable this. Beware -
1214     * EGD is *very* CPU intensive when gathering data for its pool.
1215 db 897 */
1216     # use_egd = yes;
1217    
1218     /*
1219     * egdpool_path: path to EGD pool. Not necessary for OpenSSL >= 0.9.7
1220     * which automatically finds the path.
1221     */
1222     # egdpool_path = "/var/run/egd-pool";
1223    
1224     /*
1225 michael 2322 * throttle_time: the minimum amount of time required between
1226     * connections from the same IP address. exempt {} blocks are excluded
1227     * from this throttling.
1228 michael 1863 * Offers protection against flooders who reconnect quickly.
1229 db 897 * Set to 0 to disable.
1230     */
1231     throttle_time = 10;
1232     };
1233    
1234     modules {
1235     /*
1236 michael 951 * path: other paths to search for modules specified below
1237 michael 1441 * and in "/module load".
1238 db 897 */
1239 michael 1070 path = "/usr/local/ircd/lib/ircd-hybrid/modules";
1240     path = "/usr/local/ircd/lib/ircd-hybrid/modules/autoload";
1241 db 897
1242 michael 1863 /* module: the name of a module to load on startup/rehash. */
1243 michael 2171 # module = "some_module.la";
1244 db 897 };
1245 michael 1247
1246     /*
1247     * log {}: contains information about logfiles.
1248     */
1249     log {
1250     /* Do you want to enable logging to ircd.log? */
1251     use_logging = yes;
1252    
1253     file {
1254     type = oper;
1255 michael 2171 name = "/usr/local/ircd/var/log/oper.log";
1256 michael 1250 size = unlimited;
1257 michael 1247 };
1258    
1259     file {
1260     type = user;
1261 michael 2171 name = "/usr/local/ircd/var/log/user.log";
1262 michael 1247 size = 50 megabytes;
1263     };
1264    
1265     file {
1266     type = kill;
1267 michael 2171 name = "/usr/local/ircd/var/log/kill.log";
1268 michael 1247 size = 50 megabytes;
1269     };
1270    
1271     file {
1272     type = kline;
1273 michael 2171 name = "/usr/local/ircd/var/log/kline.log";
1274 michael 1247 size = 50 megabytes;
1275     };
1276    
1277     file {
1278     type = dline;
1279 michael 2171 name = "/usr/local/ircd/var/log/dline.log";
1280 michael 1247 size = 50 megabytes;
1281     };
1282    
1283     file {
1284     type = gline;
1285 michael 2171 name = "/usr/local/ircd/var/log/gline.log";
1286 michael 1247 size = 50 megabytes;
1287     };
1288    
1289     file {
1290     type = debug;
1291 michael 2171 name = "/usr/local/ircd/var/log/debug.log";
1292 michael 1247 size = 50 megabytes;
1293 michael 1824 };
1294 michael 1247 };

Properties

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