]> jfr.im git - irc/rqf/shadowircd.git/blame - doc/sgml/oper-guide/config.sgml
sgml docs: kline_exempt does not exempt from D:lines in any way
[irc/rqf/shadowircd.git] / doc / sgml / oper-guide / config.sgml
CommitLineData
212380e3 1 <chapter id="config">
2 <title>Server config file format</title>
3 <sect1>
4 <title>General format</title>
5 <para>
6 The config file consists of a series of BIND-style blocks. Each block consists of a series
7 of values inside it which pertain to configuration settings that apply to the given block.
8 </para>
9 <para>
10 Several values take lists of values and have defaults preset inside
11 them. Prefix a keyword with a tilde (~) to override the default and
12 disable it.
13 </para>
14 <para>
15 A line may also be a .include directive, which is of the form <synopsis>.include "<replaceable>file</replaceable>"</synopsis>
16 and causes <replaceable>file</replaceable> to be read in at that point, before the rest of the current file is
17 processed.
18 Relative paths are first tried relative to PREFIX and then relative
19 to ETCPATH (normally PREFIX/etc).
20 </para>
21 <para>
22 Anything from a # to the end of a line is a comment. Blank lines are ignored. C-style comments are also supported.
23 </para>
24 </sect1>
25 <sect1 id="configlines">
26 <title>Specific blocks and directives</title>
27 <para>
28 Not all configuration blocks and directives are listed here, only the most common ones. More blocks and directives will
29 be documented in later revisions of this manual.
30 </para>
31 <sect2>
32 <title>loadmodule directive</title>
33 <synopsis>
34loadmodule "<replaceable>text</replaceable>";</synopsis>
35 <para>
36 Loads a module into the IRCd. In charybdis 1.1, most modules are automatically loaded in. In future versions, it is
37 intended to remove this behaviour as to allow for easy customization of the IRCd's featureset.
38 </para>
39 </sect2>
40 <sect2>
41 <title>serverinfo {} block</title>
42 <synopsis>
43serverinfo {
44 name = "<replaceable>text</replaceable>";
212380e3 45 sid = "<replaceable>text</replaceable>";
46 description = "<replaceable>text</replaceable>";
47 network_name = "<replaceable>text</replaceable>";
48 network_desc = "<replaceable>text</replaceable>";
49 hub = <replaceable>boolean</replaceable>;
50 vhost = "<replaceable>text</replaceable>";
51 vhost6 = "<replaceable>text</replaceable>";
52};</synopsis>
53 <para>
54 The serverinfo {} block defines the core operational parameters of the IRC server.
55 </para>
56 <variablelist>
57 <title>serverinfo {} variables</title>
58 <varlistentry>
59 <term>name</term>
60 <listitem>
61 <para>
62 The name of the IRC server that you are configuring. This
63 must contain at least one dot. It is not necessarily equal
64 to any DNS name. This must be unique on the IRC network.
65 </para>
66 </listitem>
67 </varlistentry>
212380e3 68 <varlistentry>
69 <term>sid</term>
70 <listitem>
71 <para>
d64fec57 72 A unique ID which describes the server.
212380e3 73 This consists of one digit and two characters which can be
74 digits or letters.
75 </para>
76 </listitem>
77 </varlistentry>
78 <varlistentry>
79 <term>description</term>
80 <listitem>
81 <para>
82 A user-defined field of text which describes the IRC server. This information is used in
83 /links and /whois requests. Geographical location information could be a useful use of
84 this field, but most administrators put a witty saying inside it instead.
85 </para>
86 </listitem>
87 </varlistentry>
88 <varlistentry>
89 <term>network_name</term>
90 <listitem>
91 <para>
92 The name of the IRC network that this server will be a member of.
93 This is used in the welcome message and NETWORK= in 005.
94 </para>
95 </listitem>
96 </varlistentry>
97 <varlistentry>
98 <term>network_desc</term>
99 <listitem>
100 <para>
101 A description of the IRC network that this server will be a member of.
102 This is currently unused.
103 </para>
104 </listitem>
105 </varlistentry>
106 <varlistentry>
107 <term>hub</term>
108 <listitem>
109 <para>
110 A boolean which defines whether or not this IRC server will be serving as a hub, i.e. have multiple servers connected to it.
111 </para>
112 </listitem>
113 </varlistentry>
114 <varlistentry>
115 <term>vhost</term>
116 <listitem>
117 <para>
118 An optional text field which defines an IP from which to connect outward to other IRC servers.
119 </para>
120 </listitem>
121 </varlistentry>
122 <varlistentry>
123 <term>vhost6</term>
124 <listitem>
125 <para>
126 An optional text field which defines an IPv6 IP from which to connect outward to other IRC servers.
127 </para>
128 </listitem>
129 </varlistentry>
130 </variablelist>
131 </sect2>
132 <sect2>
133 <title>admin {} block</title>
134 <synopsis>
135admin {
136 name = "<replaceable>text</replaceable>";
137 description = "<replaceable>text</replaceable>";
138 email = "<replaceable>text</replaceable>";
139};</synopsis>
140 <para>
141 This block provides the information which is returned by the ADMIN command.
142 </para>
143 <variablelist>
144 <title>admin {} variables</title>
145 <varlistentry>
146 <term>name</term>
147 <listitem>
148 <para>The name of the administrator running this service.</para>
149 </listitem>
150 </varlistentry>
151 <varlistentry>
152 <term>description</term>
153 <listitem>
154 <para>The description of the administrator's position in the network.</para>
155 </listitem>
156 </varlistentry>
157 <varlistentry>
158 <term>email</term>
159 <listitem>
160 <para>A point of contact for the administrator, usually an e-mail address.</para>
161 </listitem>
162 </varlistentry>
163 </variablelist>
164 </sect2>
165 <sect2>
166 <title>class {} block</title>
167 <synopsis>
168class "<replaceable>name</replaceable>" {
169 ping_time = <replaceable>duration</replaceable>;
170 number_per_ident = <replaceable>number</replaceable>;
171 number_per_ip = <replaceable>number</replaceable>;
172 number_per_ip_global = <replaceable>number</replaceable>;
173 cidr_bitlen = <replaceable>number</replaceable>;
174 number_per_cidr = <replaceable>number</replaceable>;
175 max_number = <replaceable>number</replaceable>;
176 sendq = <replaceable>size</replaceable>;
177};</synopsis>
178 <synopsis>
179class "<replaceable>name</replaceable>" {
180 ping_time = <replaceable>duration</replaceable>;
181 connectfreq = <replaceable>duration</replaceable>;
182 max_number = <replaceable>number</replaceable>;
183 sendq = <replaceable>size</replaceable>;
184};</synopsis>
185 <para>
186 Class blocks define classes of connections for later use.
187 The class name is used to connect them to
188 other blocks in the config file (auth{} and connect{}).
189 They must be defined before they are used.
190 </para>
191 <para>
192 Classes are used both for client and server connections,
193 but most variables are different.
194 </para>
195 <variablelist>
196 <title>class {} variables: client classes</title>
197 <varlistentry>
198 <term>ping_time</term>
199 <listitem>
200 <para>The amount of time between checking pings for clients, e.g.: 2 minutes</para>
201 </listitem>
202 </varlistentry>
203 <varlistentry>
204 <term>number_per_ident</term>
205 <listitem>
206 <para>The amount of clients which may be connected from a single identd username on a per-IP basis, globally. Unidented clients all count as the same username.</para>
207 </listitem>
208 </varlistentry>
209 <varlistentry>
210 <term>number_per_ip</term>
211 <listitem>
212 <para>The amount of clients which may be connected from a single IP address.</para>
213 </listitem>
214 </varlistentry>
215 <varlistentry>
216 <term>number_per_ip_global</term>
217 <listitem>
218 <para>The amount of clients which may be connected globally from a single IP address.</para>
219 </listitem>
220 </varlistentry>
221 <varlistentry>
222 <term>cidr_bitlen</term>
223 <listitem>
224 <para>The netblock length to use with CIDR-based client limiting for this class.</para>
225 </listitem>
226 </varlistentry>
227 <varlistentry>
228 <term>number_per_cidr</term>
229 <listitem>
230 <para>The amount of clients which may be connected from a single netblock.</para>
231 </listitem>
232 </varlistentry>
233 <varlistentry>
234 <term>max_number</term>
235 <listitem>
236 <para>The maximum amount of clients which may use this class at any given time.</para>
237 </listitem>
238 </varlistentry>
239 <varlistentry>
240 <term>sendq</term>
241 <listitem>
242 <para>The maximum size of the queue of data to be sent to a client before it is dropped.</para>
243 </listitem>
244 </varlistentry>
245 </variablelist>
246 <variablelist>
247 <title>class {} variables: server classes</title>
248 <varlistentry>
249 <term>ping_time</term>
250 <listitem>
251 <para>The amount of time between checking pings for servers, e.g.: 2 minutes</para>
252 </listitem>
253 </varlistentry>
254 <varlistentry>
255 <term>connectfreq</term>
256 <listitem>
257 <para>The amount of time between autoconnects. This must at least be one minute, as autoconnects are evaluated with that granularity.</para>
258 </listitem>
259 </varlistentry>
260 <varlistentry>
261 <term>max_number</term>
262 <listitem>
263 <para>The amount of servers to autoconnect to in this class. More precisely, no autoconnects are done if the number of servers in this class is greater than or equal max_number</para>
264 </listitem>
265 </varlistentry>
266 <varlistentry>
267 <term>sendq</term>
268 <listitem>
269 <para>The maximum size of the queue of data to be sent to a server before it is dropped.</para>
270 </listitem>
271 </varlistentry>
272 </variablelist>
273 </sect2>
274 <sect2>
275 <title>auth {} block</title>
276 <synopsis>
277auth {
278 user = "<replaceable>hostmask</replaceable>";
279 password = "<replaceable>text</replaceable>";
280 spoof = "<replaceable>text</replaceable>";
281 flags = <replaceable>list</replaceable>;
282 class = "<replaceable>text</replaceable>";
283};</synopsis>
284 <para>
285 auth {} blocks allow client connections to the server, and set various properties concerning those connections.
286 </para>
287 <para>
288 Auth blocks are evaluated from top to bottom in priority, so put special blocks first.
289 </para>
290 <variablelist>
291 <title>auth {} variables</title>
292 <varlistentry>
293 <term>user</term>
294 <listitem>
0c304043 295 <para>
296 A hostmask (user@host) that the auth {} block applies to.
297 It is matched against the hostname and IP address (using ::
298 shortening for IPv6 and prepending a 0 if it starts with
299 a colon) and can also use CIDR masks.
300 You can have multiple user entries.
301 </para>
212380e3 302 </listitem>
303 </varlistentry>
304 <varlistentry>
305 <term>password</term>
306 <listitem>
307 <para>
308 An optional password to use for authenticating into this auth{}
309 block. If the password is wrong the user will not be able to
310 connect (will not fall back on another auth{} block).
311 </para>
312 </listitem>
313 </varlistentry>
314 <varlistentry>
315 <term>spoof</term>
316 <listitem>
7c3a2f70 317 <para>An optional fake hostname (or user@host) to apply to users authenticated to this auth{} block. In STATS i and TESTLINE, an equals sign (=) appears before the user@host and the spoof is shown.</para>
212380e3 318 </listitem>
319 </varlistentry>
320 <varlistentry>
321 <term>flags</term>
322 <listitem>
7c3a2f70 323 <para>A list of flags to apply to this auth{} block. They are listed below. Some of the flags appear as a special character, parenthesized in the list, before the user@host in STATS i and TESTLINE.</para>
212380e3 324 </listitem>
325 </varlistentry>
326 <varlistentry>
327 <term>class</term>
328 <listitem>
329 <para>A name of a class to put users matching this auth{} block into.</para>
330 </listitem>
331 </varlistentry>
332 </variablelist>
333 <variablelist>
334 <title>auth {} flags</title>
335 <varlistentry>
336 <term>encrypted</term>
337 <listitem>
338 <para>The password used has been encrypted.</para>
339 </listitem>
340 </varlistentry>
341 <varlistentry>
342 <term>spoof_notice</term>
343 <listitem>
344 <para>Causes the IRCd to send out a server notice when activating a spoof provided by this auth{} block.</para>
345 </listitem>
346 </varlistentry>
347 <varlistentry>
7c3a2f70 348 <term>exceed_limit (&gt;)</term>
212380e3 349 <listitem>
350 <para>Users in this auth{} block can exceed class-wide limitations.</para>
351 </listitem>
352 </varlistentry>
353 <varlistentry>
7c3a2f70 354 <term>dnsbl_exempt ($)</term>
212380e3 355 <listitem>
356 <para>Users in this auth{} block are exempted from DNS blacklist checks. However, they will still be warned if they are listed.</para>
357 </listitem>
358 </varlistentry>
359 <varlistentry>
7c3a2f70 360 <term>kline_exempt (^)</term>
212380e3 361 <listitem>
f3d2fceb 362 <para>Users in this auth{} block are exempted from DNS blacklists, k:lines, g:lines and x:lines.</para>
212380e3 363 </listitem>
364 </varlistentry>
365 <varlistentry>
7c3a2f70 366 <term>gline_exempt (_)</term>
212380e3 367 <listitem>
368 <para>Users in this auth{} block are exempted from g:lines.</para>
369 </listitem>
370 </varlistentry>
371 <varlistentry>
372 <term>spambot_exempt</term>
373 <listitem>
374 <para>Users in this auth{} block are exempted from spambot checks.</para>
375 </listitem>
376 </varlistentry>
377 <varlistentry>
378 <term>shide_exempt</term>
379 <listitem>
380 <para>Users in this auth{} block are exempted from some serverhiding effects.</para>
381 </listitem>
382 </varlistentry>
383 <varlistentry>
384 <term>jupe_exempt</term>
385 <listitem>
386 <para>Users in this auth{} block do not trigger an alarm when joining juped channels.</para>
387 </listitem>
388 </varlistentry>
389 <varlistentry>
390 <term>resv_exempt</term>
391 <listitem>
392 <para>Users in this auth{} block may use reserved nicknames and channels.</para>
393 <note><para>The initial nickname may still not be reserved.</para></note>
394 </listitem>
395 </varlistentry>
396 <varlistentry>
7c3a2f70 397 <term>flood_exempt (|)</term>
212380e3 398 <listitem>
399 <para>
400 Users in this auth{} block may send arbitrary amounts of
401 commands per time unit to the server. This does not exempt
402 them from any other flood limits.
403 You should use this setting with caution.
404 </para>
405 </listitem>
406 </varlistentry>
407 <varlistentry>
7c3a2f70 408 <term>no_tilde (-)</term>
212380e3 409 <listitem>
410 <para>Users in this auth{} block will not have a tilde added to their username if they do not run identd.</para>
411 </listitem>
412 </varlistentry>
413 <varlistentry>
7c3a2f70 414 <term>need_ident (+)</term>
212380e3 415 <listitem>
416 <para>Users in this auth{} block must have identd, otherwise they will be rejected.</para>
417 </listitem>
418 </varlistentry>
419 <varlistentry>
420 <term>need_sasl</term>
421 <listitem>
422 <para>Users in this auth{} block must identify via SASL, otherwise they will be rejected.</para>
423 </listitem>
424 </varlistentry>
425 </variablelist>
426 </sect2>
427 <sect2>
428 <title>exempt {} block</title>
429 <synopsis>
430exempt {
431 ip = "<replaceable>ip</replaceable>";
432};</synopsis>
433 <para>
b808adf9 434 An exempt block specifies IP addresses which are exempt from D:lines
435 and throttling.
212380e3 436 Multiple addresses can be specified in one block.
437 Clients coming from these addresses can still be K/G/X:lined or
438 banned by a DNS blacklist unless
439 they also have appropriate flags in their auth{} block.
440 </para>
441 <variablelist>
442 <title>exempt {} variables</title>
443 <varlistentry>
444 <term>ip</term>
445 <listitem>
446 <para>The IP address or CIDR range to exempt.</para>
447 </listitem>
448 </varlistentry>
449 </variablelist>
450 </sect2>
451 <sect2>
452 <title>operator {} block</title>
453 <synopsis>
454operator "<replaceable>name</replaceable>" {
455 user = "<replaceable>hostmask</replaceable>";
456 password = "<replaceable>text</replaceable>";
457 rsa_public_key_file = "<replaceable>text</replaceable>";
458 umodes = <replaceable>list</replaceable>;
459 snomask = "<replaceable>text</replaceable>";
460 flags = <replaceable>list</replaceable>;
461};</synopsis>
462 <para>
463 Operator blocks define who may use the OPER command to gain extended privileges.
464 </para>
465 <variablelist>
466 <title>operator {} variables</title>
467 <varlistentry>
468 <term>user</term>
469 <listitem>
470 <para>
471 A hostmask that users trying to use this operator {} block
472 must match. This is checked against the original host and IP
473 address; CIDR is also supported. So auth {} spoofs work in
474 operator {} blocks; the real host behind them is not checked.
475 Other kind of spoofs do not work in operator {} blocks; the
476 real host behind them is checked.
477 </para>
478 <para>
479 Note that this is different from charybdis 1.x where all
480 kinds of spoofs worked in operator {} blocks.
481 </para>
482 </listitem>
483 </varlistentry>
484 <varlistentry>
485 <term>password</term>
486 <listitem>
487 <para>
488 A password used with the OPER command to use this operator {} block.
489 Passwords are encrypted by default, but may be unencrypted if ~encrypted is present
490 in the flags list.
491 </para>
492 </listitem>
493 </varlistentry>
494 <varlistentry>
495 <term>rsa_public_key_file</term>
496 <listitem>
497 <para>
498 An optional path to a RSA public key file associated with the operator {} block.
499 This information is used by the CHALLENGE command, which is an alternative authentication
500 scheme to the traditional OPER command.
501 </para>
502 </listitem>
503 </varlistentry>
504 <varlistentry>
505 <term>umodes</term>
506 <listitem>
507 <para>A list of usermodes to apply to successfully opered clients.</para>
508 </listitem>
509 </varlistentry>
510 <varlistentry>
511 <term>snomask</term>
512 <listitem>
513 <para>
514 An snomask to apply to successfully opered clients.
515 </para>
516 </listitem>
517 </varlistentry>
518 <varlistentry>
519 <term>flags</term>
520 <listitem>
521 <para>
522 A listing of privileges granted to operators using this block.
625b1e58
JT
523 By default, the mass_notice, operwall, remoteban and resv privileges are granted;
524 use ~mass_notice, ~operwall, ~remoteban and ~resv to disable them if necessary.
212380e3 525 </para>
526 <para>
527 In addition, a flag designating if the password is encrypted is here.
528 Privileges are documented elsewhere in this guide.
529 </para>
530 </listitem>
531 </varlistentry>
532 </variablelist>
533 </sect2>
534 <sect2>
535 <title>connect {} block</title>
536 <synopsis>
537connect "<replaceable>name</replaceable>" {
538 host = "<replaceable>text</replaceable>";
539 send_password = "<replaceable>text</replaceable>";
540 accept_password = "<replaceable>text</replaceable>";
541 port = <replaceable>number</replaceable>;
542 hub_mask = "<replaceable>mask</replaceable>";
543 leaf_mask = "<replaceable>mask</replaceable>";
544 class = "<replaceable>text</replaceable>";
545 flags = <replaceable>list</replaceable>;
546 aftype = <replaceable>protocol</replaceable>;
547};</synopsis>
548 <para>
549 Connect blocks define what servers may connect or be connected to.
550 </para>
551 <variablelist>
552 <title>connect {} variables</title>
553 <varlistentry>
554 <term>host</term>
555 <listitem>
556 <para>The hostname or IP to connect to.</para>
557 <note><para>
558 Charybdis uses solely DNS for all hostname/address lookups
559 (no <filename>/etc/hosts</filename> or anything else).
560 Furthermore, if a hostname is used, it must have an A or AAAA
561 record (no CNAME) and it must be the primary
562 hostname for inbound connections to work.
0c304043 563 </para><para>
564 IPv6 addresses must be in :: shortened form; addresses which
565 then start with a colon must be prepended with a zero,
566 for example 0::1.
212380e3 567 </para></note>
568 </listitem>
569 </varlistentry>
570 <varlistentry>
571 <term>send_password</term>
572 <listitem>
573 <para>The password to send to the other server.</para>
574 </listitem>
575 </varlistentry>
576 <varlistentry>
577 <term>accept_password</term>
578 <listitem>
579 <para>The password that should be accepted from the other server.</para>
580 </listitem>
581 </varlistentry>
582 <varlistentry>
583 <term>port</term>
584 <listitem>
585 <para>The port on the other server to connect to.</para>
586 </listitem>
587 </varlistentry>
588 <varlistentry>
589 <term>hub_mask</term>
590 <listitem>
591 <para>
592 An optional domain mask of servers allowed to be introduced
593 by this link. Usually, "*" is fine. Multiple hub_masks may be
594 specified, and any of them may be introduced.
595 Violation of hub_mask and leaf_mask restrictions will
596 cause the local link to be closed.
597 </para>
598 </listitem>
599 </varlistentry>
600 <varlistentry>
601 <term>leaf_mask</term>
602 <listitem>
603 <para>
604 An optional domain mask of servers not allowed to be
605 introduced by this link. Multiple leaf_masks may be specified,
606 and none of them may be introduced. leaf_mask has priority
607 over hub_mask.
608 </para>
609 </listitem>
610 </varlistentry>
611 <varlistentry>
612 <term>class</term>
613 <listitem>
614 <para>The name of the class this server should be placed into.</para>
615 </listitem>
616 </varlistentry>
617 <varlistentry>
618 <term>flags</term>
619 <listitem>
620 <para>A list of flags concerning the connect block. They are listed below.</para>
621 </listitem>
622 </varlistentry>
623 <varlistentry>
624 <term>aftype</term>
625 <listitem>
626 <para>The protocol that should be used to connect with, either ipv4 or ipv6. This defaults to ipv4 unless host is a numeric IPv6 address.</para>
627 </listitem>
628 </varlistentry>
629 </variablelist>
630 <variablelist>
631 <title>connect {} flags</title>
632 <varlistentry>
633 <term>encrypted</term>
634 <listitem>
635 <para>The value for accept_password has been encrypted.</para>
636 </listitem>
637 </varlistentry>
638 <varlistentry>
639 <term>autoconn</term>
640 <listitem>
641 <para>
642 The server should automatically try to connect to the server defined in this
643 connect {} block if it's not connected already and max_number
644 in the class is not reached yet.
645 </para>
646 </listitem>
647 </varlistentry>
648 <varlistentry>
649 <term>compressed</term>
650 <listitem>
651 <para>Ziplinks should be used with this server connection.
652 This compresses traffic using zlib, saving some bandwidth
653 and speeding up netbursts.</para>
654 <para>If you have trouble setting up a link, you should
655 turn this off as it often hides error messages.</para>
656 </listitem>
657 </varlistentry>
658 <varlistentry>
659 <term>topicburst</term>
660 <listitem>
661 <para>Topics should be bursted to this server.</para>
662 </listitem>
663 </varlistentry>
664 </variablelist>
665 </sect2>
666 <sect2>
667 <title>listen {} block</title>
668 <synopsis>
669listen {
670 host = "<replaceable>text</replaceable>";
671 port = <replaceable>number</replaceable>;
672};</synopsis>
673 <para>
674 A listen block specifies what ports a server should listen on.
675 </para>
676 <variablelist>
677 <title>listen {} variables</title>
678 <varlistentry>
679 <term>host</term>
680 <listitem>
681 <para>An optional host to bind to. Otherwise, the ircd will listen on all available hosts.</para>
682 </listitem>
683 </varlistentry>
684 <varlistentry>
685 <term>port</term>
686 <listitem>
687 <para>
688 A port to listen on. You can specify multiple ports via commas, and define a range by seperating
689 the start and end ports with two dots (..).
690 </para>
691 </listitem>
692 </varlistentry>
693 </variablelist>
694 </sect2>
695 <sect2>
696 <title>modules {} block</title>
697 <synopsis>
698modules {
699 path = "<replaceable>text</replaceable>";
700 module = <replaceable>text</replaceable>;
701};</synopsis>
702 <para>
703 The modules block specifies information for loadable modules.
704 </para>
705 <variablelist>
706 <title>modules {} variables</title>
707 <varlistentry>
708 <term>path</term>
709 <listitem>
710 <para>Specifies a path to search for loadable modules.</para>
711 </listitem>
712 </varlistentry>
713 <varlistentry>
714 <term>module</term>
715 <listitem>
716 <para>
717 Specifies a module to load, similar to loadmodule.
718 </para>
719 </listitem>
720 </varlistentry>
721 </variablelist>
722 </sect2>
723 <sect2>
724 <title>general {} block</title>
725 <synopsis>
726modules {
727 <replaceable>values</replaceable>
728};</synopsis>
729 <para>
730 The general block specifies a variety of options, many of which
731 were in <filename>config.h</filename> in older daemons.
732 The options are documented in <filename>reference.conf</filename>.
733 </para>
734 </sect2>
735 <sect2>
736 <title>channel {} block</title>
737 <synopsis>
738modules {
739 <replaceable>values</replaceable>
740};</synopsis>
741 <para>
742 The channel block specifies a variety of channel-related options,
743 many of which were in <filename>config.h</filename> in older daemons.
744 The options are documented in <filename>reference.conf</filename>.
745 </para>
746 </sect2>
747 <sect2>
748 <title>serverhide {} block</title>
749 <synopsis>
750modules {
751 <replaceable>values</replaceable>
752};</synopsis>
753 <para>
754 The serverhide block specifies options related to server hiding.
755 The options are documented in <filename>reference.conf</filename>.
756 </para>
757 </sect2>
758 <sect2>
759 <title>blacklist {} block</title>
760 <synopsis>
761blacklist {
762 host = "<replaceable>text</replaceable>";
763 reject_reason = "<replaceable>text</replaceable>";
764};</synopsis>
765 <para>
766 The blacklist block specifies DNS blacklists to check.
767 Listed clients will not be allowed to connect.
768 IPv6 clients are not checked against these.
769 </para>
770 <para>
771 Multiple blacklists can be specified, in pairs with first host
772 then reject_reason.
773 </para>
774 <variablelist>
775 <title>blacklist {} variables</title>
776 <varlistentry>
777 <term>host</term>
778 <listitem>
779 <para>The DNSBL to use.</para>
780 </listitem>
781 </varlistentry>
782 <varlistentry>
783 <term>reject_reason</term>
784 <listitem>
785 <para>The reason to send to listed clients when disconnecting them.</para>
786 </listitem>
787 </varlistentry>
788 </variablelist>
789 </sect2>
790 <sect2>
791 <title>alias {} block</title>
792 <synopsis>
793alias "<replaceable>name</replaceable>" {
794 target = "<replaceable>text</replaceable>";
795};</synopsis>
796 <para>
797 Alias blocks allow the definition of custom commands.
798 These commands send PRIVMSG to the given target. A real
799 command takes precedence above an alias.
800 </para>
801 <variablelist>
802 <title>alias {} variables</title>
803 <varlistentry>
804 <term>target</term>
805 <listitem>
806 <para>
807 The target nick (must be a network service (umode +S)) or
808 user@server.
809 In the latter case, the server cannot be this server,
810 only opers can use user starting with "opers" reliably and
811 the user is interpreted on the target server only
812 so you may need to use nick@server instead).
813 </para>
814 </listitem>
815 </varlistentry>
816 </variablelist>
817 </sect2>
818 <sect2>
819 <title>cluster {} block</title>
820 <synopsis>
821cluster {
822 name = "<replaceable>text</replaceable>";
823 flags = <replaceable>list</replaceable>;
824};</synopsis>
825 <para>
826 The cluster block specifies servers we propagate things to
827 automatically.
828 This does not allow them to set bans, you need a separate shared{}
829 block for that.
830 </para>
831 <para>
832 Having overlapping cluster{} items will cause the command to
833 be executed twice on the target servers. This is particularly
834 undesirable for ban removals.
835 </para>
836 <para>
837 The letters in parentheses denote the flags in /stats U.
838 </para>
839 <variablelist>
840 <title>cluster {} variables</title>
841 <varlistentry>
842 <term>name</term>
843 <listitem>
844 <para>The server name to share with, this may contain wildcards
845 and may be stacked.</para>
846 </listitem>
847 </varlistentry>
848 <varlistentry>
849 <term>flags</term>
850 <listitem>
851 <para>The list of what to share, all the name lines above this
852 (up to another flags entry) will receive these flags.
853 They are listed below.</para>
854 </listitem>
855 </varlistentry>
856 </variablelist>
857 <variablelist>
858 <title>cluster {} flags</title>
859 <varlistentry>
860 <term>kline (K)</term>
861 <listitem>
862 <para>Permanent K:lines</para>
863 </listitem>
864 </varlistentry>
865 <varlistentry>
866 <term>tkline (k)</term>
867 <listitem>
868 <para>Temporary K:lines</para>
869 </listitem>
870 </varlistentry>
871 <varlistentry>
872 <term>unkline (U)</term>
873 <listitem>
874 <para>K:line removals</para>
875 </listitem>
876 </varlistentry>
877 <varlistentry>
878 <term>xline (X)</term>
879 <listitem>
880 <para>Permanent X:lines</para>
881 </listitem>
882 </varlistentry>
883 <varlistentry>
884 <term>txline (x)</term>
885 <listitem>
886 <para>Temporary X:lines</para>
887 </listitem>
888 </varlistentry>
889 <varlistentry>
890 <term>unxline (Y)</term>
891 <listitem>
892 <para>X:line removals</para>
893 </listitem>
894 </varlistentry>
895 <varlistentry>
896 <term>resv (Q)</term>
897 <listitem>
898 <para>Permanently reserved nicks/channels</para>
899 </listitem>
900 </varlistentry>
901 <varlistentry>
902 <term>tresv (q)</term>
903 <listitem>
904 <para>Temporarily reserved nicks/channels</para>
905 </listitem>
906 </varlistentry>
907 <varlistentry>
908 <term>unresv (R)</term>
909 <listitem>
910 <para>RESV removals</para>
911 </listitem>
912 </varlistentry>
913 <varlistentry>
914 <term>locops (L)</term>
915 <listitem>
916 <para>LOCOPS messages (sharing this with * makes LOCOPS rather
917 similar to OPERWALL which is not useful)</para>
918 </listitem>
919 </varlistentry>
920 <varlistentry>
921 <term>all</term>
922 <listitem>
923 <para>All of the above</para>
924 </listitem>
925 </varlistentry>
926 </variablelist>
927 </sect2>
928 <sect2>
929 <title>shared {} block</title>
930 <synopsis>
931shared {
932 oper = "<replaceable>user@host</replaceable>", "<replaceable>server</replaceable>";
933 flags = <replaceable>list</replaceable>;
934};</synopsis>
935 <para>
936 The shared block specifies opers allowed to perform certain actions
937 on our server remotely.
938 These are ordered top down. The first one matching will determine
939 the oper's access.
940 If access is denied, the command will be silently ignored.
941 </para>
942 <para>
943 The letters in parentheses denote the flags in /stats U.
944 </para>
945 <variablelist>
946 <title>shared {} variables</title>
947 <varlistentry>
948 <term>oper</term>
949 <listitem>
950 <para>The user@host the oper must have, and the server they must
951 be on. This may contain wildcards.</para>
952 </listitem>
953 </varlistentry>
954 <varlistentry>
955 <term>flags</term>
956 <listitem>
957 <para>The list of what to allow, all the oper lines above this
958 (up to another flags entry) will receive these flags.
959 They are listed below.</para>
960 </listitem>
961 </varlistentry>
962 </variablelist>
963 <note><para>
964 While they have the same names, the flags have subtly different
965 meanings from those in the cluster{} block.
966 </para></note>
967 <variablelist>
968 <title>shared {} flags</title>
969 <varlistentry>
970 <term>kline (K)</term>
971 <listitem>
972 <para>Permanent and temporary K:lines</para>
973 </listitem>
974 </varlistentry>
975 <varlistentry>
976 <term>tkline (k)</term>
977 <listitem>
978 <para>Temporary K:lines</para>
979 </listitem>
980 </varlistentry>
981 <varlistentry>
982 <term>unkline (U)</term>
983 <listitem>
984 <para>K:line removals</para>
985 </listitem>
986 </varlistentry>
987 <varlistentry>
988 <term>xline (X)</term>
989 <listitem>
990 <para>Permanent and temporary X:lines</para>
991 </listitem>
992 </varlistentry>
993 <varlistentry>
994 <term>txline (x)</term>
995 <listitem>
996 <para>Temporary X:lines</para>
997 </listitem>
998 </varlistentry>
999 <varlistentry>
1000 <term>unxline (Y)</term>
1001 <listitem>
1002 <para>X:line removals</para>
1003 </listitem>
1004 </varlistentry>
1005 <varlistentry>
1006 <term>resv (Q)</term>
1007 <listitem>
1008 <para>Permanently and temporarily reserved nicks/channels</para>
1009 </listitem>
1010 </varlistentry>
1011 <varlistentry>
1012 <term>tresv (q)</term>
1013 <listitem>
1014 <para>Temporarily reserved nicks/channels</para>
1015 </listitem>
1016 </varlistentry>
1017 <varlistentry>
1018 <term>unresv (R)</term>
1019 <listitem>
1020 <para>RESV removals</para>
1021 </listitem>
1022 </varlistentry>
1023 <varlistentry>
1024 <term>all</term>
1025 <listitem>
1026 <para>All of the above; this does not include locops or rehash</para>
1027 </listitem>
1028 </varlistentry>
1029 <varlistentry>
1030 <term>locops (L)</term>
1031 <listitem>
1032 <para>LOCOPS messages (accepting this from * makes LOCOPS rather
1033 similar to OPERWALL which is not useful); unlike the other flags,
1034 this can only be accepted from *@* although it can be
1035 restricted based on source server.</para>
1036 </listitem>
1037 </varlistentry>
1038 <varlistentry>
1039 <term>rehash (H)</term>
1040 <listitem>
1041 <para>REHASH commands; all options can be used</para>
1042 </listitem>
1043 </varlistentry>
1044 <varlistentry>
1045 <term>none</term>
1046 <listitem>
1047 <para>Allow nothing to be done</para>
1048 </listitem>
1049 </varlistentry>
1050 </variablelist>
1051 </sect2>
1052 <sect2>
1053 <title>service {} block</title>
1054 <synopsis>
1055service {
1056 name = "<replaceable>text</replaceable>";
1057};</synopsis>
1058 <para>
1059 The service block specifies privileged servers (services). These
1060 servers have extra privileges such as setting login names on users
1061 and introducing clients with umode +S (unkickable, hide channels, etc).
1062 This does not allow them to set bans, you need a separate shared{}
1063 block for that.
1064 </para>
1065 <para>
1066 Do not place normal servers here.
1067 </para>
1068 <para>
1069 Multiple names may be specified but there may be only one service{}
1070 block.
1071 </para>
1072 <variablelist>
1073 <title>service {} variables</title>
1074 <varlistentry>
1075 <term>name</term>
1076 <listitem>
1077 <para>The server name to grant special privileges. This may not
1078 contain wildcards.</para>
1079 </listitem>
1080 </varlistentry>
1081 </variablelist>
1082 </sect2>
1083 </sect1>
1084 </chapter>
1085<!-- Keep this comment at the end of the file
1086Local variables:
1087mode: sgml
1088sgml-omittag:t
1089sgml-shorttag:t
1090sgml-namecase-general:t
1091sgml-general-insert-case:lower
1092sgml-minimize-attributes:nil
1093sgml-always-quote-attributes:t
1094sgml-indent-step:2
1095sgml-indent-data:t
1096sgml-parent-document: ("dancer-oper-guide.sgml" "book")
1097sgml-exposed-tags:nil
1098fill-column:105
1099sgml-validate-command: "nsgmls -e -g -s -u dancer-oper-guide.sgml"
1100End:
1101-->