]>
Commit | Line | Data |
---|---|---|
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> | |
34 | loadmodule "<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> | |
43 | serverinfo { | |
44 | name = "<replaceable>text</replaceable>"; | |
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> | |
68 | <varlistentry> | |
69 | <term>sid</term> | |
70 | <listitem> | |
71 | <para> | |
72 | A unique ID which describes the server. | |
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> | |
135 | admin { | |
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> | |
168 | class "<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> | |
179 | class "<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> | |
277 | auth { | |
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> | |
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> | |
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> | |
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> | |
318 | </listitem> | |
319 | </varlistentry> | |
320 | <varlistentry> | |
321 | <term>flags</term> | |
322 | <listitem> | |
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> | |
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> | |
348 | <term>exceed_limit (>)</term> | |
349 | <listitem> | |
350 | <para>Users in this auth{} block can exceed class-wide limitations.</para> | |
351 | </listitem> | |
352 | </varlistentry> | |
353 | <varlistentry> | |
354 | <term>dnsbl_exempt ($)</term> | |
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> | |
360 | <term>kline_exempt (^)</term> | |
361 | <listitem> | |
362 | <para>Users in this auth{} block are exempted from DNS blacklists, k:lines and x:lines.</para> | |
363 | </listitem> | |
364 | </varlistentry> | |
365 | <varlistentry> | |
366 | <term>spambot_exempt</term> | |
367 | <listitem> | |
368 | <para>Users in this auth{} block are exempted from spambot checks.</para> | |
369 | </listitem> | |
370 | </varlistentry> | |
371 | <varlistentry> | |
372 | <term>shide_exempt</term> | |
373 | <listitem> | |
374 | <para>Users in this auth{} block are exempted from some serverhiding effects.</para> | |
375 | </listitem> | |
376 | </varlistentry> | |
377 | <varlistentry> | |
378 | <term>jupe_exempt</term> | |
379 | <listitem> | |
380 | <para>Users in this auth{} block do not trigger an alarm when joining juped channels.</para> | |
381 | </listitem> | |
382 | </varlistentry> | |
383 | <varlistentry> | |
384 | <term>resv_exempt</term> | |
385 | <listitem> | |
386 | <para>Users in this auth{} block may use reserved nicknames and channels.</para> | |
387 | <note><para>The initial nickname may still not be reserved.</para></note> | |
388 | </listitem> | |
389 | </varlistentry> | |
390 | <varlistentry> | |
391 | <term>flood_exempt (|)</term> | |
392 | <listitem> | |
393 | <para> | |
394 | Users in this auth{} block may send arbitrary amounts of | |
395 | commands per time unit to the server. This does not exempt | |
396 | them from any other flood limits. | |
397 | You should use this setting with caution. | |
398 | </para> | |
399 | </listitem> | |
400 | </varlistentry> | |
401 | <varlistentry> | |
402 | <term>no_tilde (-)</term> | |
403 | <listitem> | |
404 | <para>Users in this auth{} block will not have a tilde added to their username if they do not run identd.</para> | |
405 | </listitem> | |
406 | </varlistentry> | |
407 | <varlistentry> | |
408 | <term>need_ident (+)</term> | |
409 | <listitem> | |
410 | <para>Users in this auth{} block must have identd, otherwise they will be rejected.</para> | |
411 | </listitem> | |
412 | </varlistentry> | |
413 | <varlistentry> | |
414 | <term>need_sasl</term> | |
415 | <listitem> | |
416 | <para>Users in this auth{} block must identify via SASL, otherwise they will be rejected.</para> | |
417 | </listitem> | |
418 | </varlistentry> | |
419 | </variablelist> | |
420 | </sect2> | |
421 | <sect2> | |
422 | <title>exempt {} block</title> | |
423 | <synopsis> | |
424 | exempt { | |
425 | ip = "<replaceable>ip</replaceable>"; | |
426 | };</synopsis> | |
427 | <para> | |
428 | An exempt block specifies IP addresses which are exempt from D:lines | |
429 | and throttling. | |
430 | Multiple addresses can be specified in one block. | |
431 | Clients coming from these addresses can still be K/G/X:lined or | |
432 | banned by a DNS blacklist unless | |
433 | they also have appropriate flags in their auth{} block. | |
434 | </para> | |
435 | <variablelist> | |
436 | <title>exempt {} variables</title> | |
437 | <varlistentry> | |
438 | <term>ip</term> | |
439 | <listitem> | |
440 | <para>The IP address or CIDR range to exempt.</para> | |
441 | </listitem> | |
442 | </varlistentry> | |
443 | </variablelist> | |
444 | </sect2> | |
445 | <sect2> | |
446 | <title>operator {} block</title> | |
447 | <synopsis> | |
448 | operator "<replaceable>name</replaceable>" { | |
449 | user = "<replaceable>hostmask</replaceable>"; | |
450 | password = "<replaceable>text</replaceable>"; | |
451 | rsa_public_key_file = "<replaceable>text</replaceable>"; | |
452 | umodes = <replaceable>list</replaceable>; | |
453 | snomask = "<replaceable>text</replaceable>"; | |
454 | flags = <replaceable>list</replaceable>; | |
455 | };</synopsis> | |
456 | <para> | |
457 | Operator blocks define who may use the OPER command to gain extended privileges. | |
458 | </para> | |
459 | <variablelist> | |
460 | <title>operator {} variables</title> | |
461 | <varlistentry> | |
462 | <term>user</term> | |
463 | <listitem> | |
464 | <para> | |
465 | A hostmask that users trying to use this operator {} block | |
466 | must match. This is checked against the original host and IP | |
467 | address; CIDR is also supported. So auth {} spoofs work in | |
468 | operator {} blocks; the real host behind them is not checked. | |
469 | Other kind of spoofs do not work in operator {} blocks; the | |
470 | real host behind them is checked. | |
471 | </para> | |
472 | <para> | |
473 | Note that this is different from charybdis 1.x where all | |
474 | kinds of spoofs worked in operator {} blocks. | |
475 | </para> | |
476 | </listitem> | |
477 | </varlistentry> | |
478 | <varlistentry> | |
479 | <term>password</term> | |
480 | <listitem> | |
481 | <para> | |
482 | A password used with the OPER command to use this operator {} block. | |
483 | Passwords are encrypted by default, but may be unencrypted if ~encrypted is present | |
484 | in the flags list. | |
485 | </para> | |
486 | </listitem> | |
487 | </varlistentry> | |
488 | <varlistentry> | |
489 | <term>rsa_public_key_file</term> | |
490 | <listitem> | |
491 | <para> | |
492 | An optional path to a RSA public key file associated with the operator {} block. | |
493 | This information is used by the CHALLENGE command, which is an alternative authentication | |
494 | scheme to the traditional OPER command. | |
495 | </para> | |
496 | </listitem> | |
497 | </varlistentry> | |
498 | <varlistentry> | |
499 | <term>umodes</term> | |
500 | <listitem> | |
501 | <para>A list of usermodes to apply to successfully opered clients.</para> | |
502 | </listitem> | |
503 | </varlistentry> | |
504 | <varlistentry> | |
505 | <term>snomask</term> | |
506 | <listitem> | |
507 | <para> | |
508 | An snomask to apply to successfully opered clients. | |
509 | </para> | |
510 | </listitem> | |
511 | </varlistentry> | |
512 | <varlistentry> | |
513 | <term>flags</term> | |
514 | <listitem> | |
515 | <para> | |
516 | A listing of privileges granted to operators using this block. | |
517 | By default, the mass_notice, operwall, remoteban and resv privileges are granted; | |
518 | use ~mass_notice, ~operwall, ~remoteban and ~resv to disable them if necessary. | |
519 | </para> | |
520 | <para> | |
521 | In addition, a flag designating if the password is encrypted is here. | |
522 | Privileges are documented elsewhere in this guide. | |
523 | </para> | |
524 | </listitem> | |
525 | </varlistentry> | |
526 | </variablelist> | |
527 | </sect2> | |
528 | <sect2> | |
529 | <title>connect {} block</title> | |
530 | <synopsis> | |
531 | connect "<replaceable>name</replaceable>" { | |
532 | host = "<replaceable>text</replaceable>"; | |
533 | send_password = "<replaceable>text</replaceable>"; | |
534 | accept_password = "<replaceable>text</replaceable>"; | |
535 | port = <replaceable>number</replaceable>; | |
536 | hub_mask = "<replaceable>mask</replaceable>"; | |
537 | leaf_mask = "<replaceable>mask</replaceable>"; | |
538 | class = "<replaceable>text</replaceable>"; | |
539 | flags = <replaceable>list</replaceable>; | |
540 | aftype = <replaceable>protocol</replaceable>; | |
541 | };</synopsis> | |
542 | <para> | |
543 | Connect blocks define what servers may connect or be connected to. | |
544 | </para> | |
545 | <variablelist> | |
546 | <title>connect {} variables</title> | |
547 | <varlistentry> | |
548 | <term>host</term> | |
549 | <listitem> | |
550 | <para>The hostname or IP to connect to.</para> | |
551 | <note><para> | |
552 | Furthermore, if a hostname is used, it must have an A or AAAA | |
553 | record (no CNAME) and it must be the primary | |
554 | hostname for inbound connections to work. | |
555 | </para><para> | |
556 | IPv6 addresses must be in :: shortened form; addresses which | |
557 | then start with a colon must be prepended with a zero, | |
558 | for example 0::1. | |
559 | </para></note> | |
560 | </listitem> | |
561 | </varlistentry> | |
562 | <varlistentry> | |
563 | <term>send_password</term> | |
564 | <listitem> | |
565 | <para>The password to send to the other server.</para> | |
566 | </listitem> | |
567 | </varlistentry> | |
568 | <varlistentry> | |
569 | <term>accept_password</term> | |
570 | <listitem> | |
571 | <para>The password that should be accepted from the other server.</para> | |
572 | </listitem> | |
573 | </varlistentry> | |
574 | <varlistentry> | |
575 | <term>port</term> | |
576 | <listitem> | |
577 | <para>The port on the other server to connect to.</para> | |
578 | </listitem> | |
579 | </varlistentry> | |
580 | <varlistentry> | |
581 | <term>hub_mask</term> | |
582 | <listitem> | |
583 | <para> | |
584 | An optional domain mask of servers allowed to be introduced | |
585 | by this link. Usually, "*" is fine. Multiple hub_masks may be | |
586 | specified, and any of them may be introduced. | |
587 | Violation of hub_mask and leaf_mask restrictions will | |
588 | cause the local link to be closed. | |
589 | </para> | |
590 | </listitem> | |
591 | </varlistentry> | |
592 | <varlistentry> | |
593 | <term>leaf_mask</term> | |
594 | <listitem> | |
595 | <para> | |
596 | An optional domain mask of servers not allowed to be | |
597 | introduced by this link. Multiple leaf_masks may be specified, | |
598 | and none of them may be introduced. leaf_mask has priority | |
599 | over hub_mask. | |
600 | </para> | |
601 | </listitem> | |
602 | </varlistentry> | |
603 | <varlistentry> | |
604 | <term>class</term> | |
605 | <listitem> | |
606 | <para>The name of the class this server should be placed into.</para> | |
607 | </listitem> | |
608 | </varlistentry> | |
609 | <varlistentry> | |
610 | <term>flags</term> | |
611 | <listitem> | |
612 | <para>A list of flags concerning the connect block. They are listed below.</para> | |
613 | </listitem> | |
614 | </varlistentry> | |
615 | <varlistentry> | |
616 | <term>aftype</term> | |
617 | <listitem> | |
618 | <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> | |
619 | </listitem> | |
620 | </varlistentry> | |
621 | </variablelist> | |
622 | <variablelist> | |
623 | <title>connect {} flags</title> | |
624 | <varlistentry> | |
625 | <term>encrypted</term> | |
626 | <listitem> | |
627 | <para>The value for accept_password has been encrypted.</para> | |
628 | </listitem> | |
629 | </varlistentry> | |
630 | <varlistentry> | |
631 | <term>autoconn</term> | |
632 | <listitem> | |
633 | <para> | |
634 | The server should automatically try to connect to the server defined in this | |
635 | connect {} block if it's not connected already and max_number | |
636 | in the class is not reached yet. | |
637 | </para> | |
638 | </listitem> | |
639 | </varlistentry> | |
640 | <varlistentry> | |
641 | <term>compressed</term> | |
642 | <listitem> | |
643 | <para>Ziplinks should be used with this server connection. | |
644 | This compresses traffic using zlib, saving some bandwidth | |
645 | and speeding up netbursts.</para> | |
646 | <para>If you have trouble setting up a link, you should | |
647 | turn this off as it often hides error messages.</para> | |
648 | </listitem> | |
649 | </varlistentry> | |
650 | <varlistentry> | |
651 | <term>topicburst</term> | |
652 | <listitem> | |
653 | <para>Topics should be bursted to this server.</para> | |
654 | <para>This is enabled by default.</para> | |
655 | </listitem> | |
656 | </varlistentry> | |
657 | </variablelist> | |
658 | </sect2> | |
659 | <sect2> | |
660 | <title>listen {} block</title> | |
661 | <synopsis> | |
662 | listen { | |
663 | host = "<replaceable>text</replaceable>"; | |
664 | port = <replaceable>number</replaceable>; | |
665 | };</synopsis> | |
666 | <para> | |
667 | A listen block specifies what ports a server should listen on. | |
668 | </para> | |
669 | <variablelist> | |
670 | <title>listen {} variables</title> | |
671 | <varlistentry> | |
672 | <term>host</term> | |
673 | <listitem> | |
674 | <para>An optional host to bind to. Otherwise, the ircd will listen on all available hosts.</para> | |
675 | </listitem> | |
676 | </varlistentry> | |
677 | <varlistentry> | |
678 | <term>port</term> | |
679 | <listitem> | |
680 | <para> | |
681 | A port to listen on. You can specify multiple ports via commas, and define a range by seperating | |
682 | the start and end ports with two dots (..). | |
683 | </para> | |
684 | </listitem> | |
685 | </varlistentry> | |
686 | </variablelist> | |
687 | </sect2> | |
688 | <sect2> | |
689 | <title>modules {} block</title> | |
690 | <synopsis> | |
691 | modules { | |
692 | path = "<replaceable>text</replaceable>"; | |
693 | module = <replaceable>text</replaceable>; | |
694 | };</synopsis> | |
695 | <para> | |
696 | The modules block specifies information for loadable modules. | |
697 | </para> | |
698 | <variablelist> | |
699 | <title>modules {} variables</title> | |
700 | <varlistentry> | |
701 | <term>path</term> | |
702 | <listitem> | |
703 | <para>Specifies a path to search for loadable modules.</para> | |
704 | </listitem> | |
705 | </varlistentry> | |
706 | <varlistentry> | |
707 | <term>module</term> | |
708 | <listitem> | |
709 | <para> | |
710 | Specifies a module to load, similar to loadmodule. | |
711 | </para> | |
712 | </listitem> | |
713 | </varlistentry> | |
714 | </variablelist> | |
715 | </sect2> | |
716 | <sect2> | |
717 | <title>general {} block</title> | |
718 | <synopsis> | |
719 | modules { | |
720 | <replaceable>values</replaceable> | |
721 | };</synopsis> | |
722 | <para> | |
723 | The general block specifies a variety of options, many of which | |
724 | were in <filename>config.h</filename> in older daemons. | |
725 | The options are documented in <filename>reference.conf</filename>. | |
726 | </para> | |
727 | </sect2> | |
728 | <sect2> | |
729 | <title>channel {} block</title> | |
730 | <synopsis> | |
731 | modules { | |
732 | <replaceable>values</replaceable> | |
733 | };</synopsis> | |
734 | <para> | |
735 | The channel block specifies a variety of channel-related options, | |
736 | many of which were in <filename>config.h</filename> in older daemons. | |
737 | The options are documented in <filename>reference.conf</filename>. | |
738 | </para> | |
739 | </sect2> | |
740 | <sect2> | |
741 | <title>serverhide {} block</title> | |
742 | <synopsis> | |
743 | modules { | |
744 | <replaceable>values</replaceable> | |
745 | };</synopsis> | |
746 | <para> | |
747 | The serverhide block specifies options related to server hiding. | |
748 | The options are documented in <filename>reference.conf</filename>. | |
749 | </para> | |
750 | </sect2> | |
751 | <sect2> | |
752 | <title>blacklist {} block</title> | |
753 | <synopsis> | |
754 | blacklist { | |
755 | host = "<replaceable>text</replaceable>"; | |
756 | reject_reason = "<replaceable>text</replaceable>"; | |
757 | };</synopsis> | |
758 | <para> | |
759 | The blacklist block specifies DNS blacklists to check. | |
760 | Listed clients will not be allowed to connect. | |
761 | IPv6 clients are not checked against these. | |
762 | </para> | |
763 | <para> | |
764 | Multiple blacklists can be specified, in pairs with first host | |
765 | then reject_reason. | |
766 | </para> | |
767 | <variablelist> | |
768 | <title>blacklist {} variables</title> | |
769 | <varlistentry> | |
770 | <term>host</term> | |
771 | <listitem> | |
772 | <para>The DNSBL to use.</para> | |
773 | </listitem> | |
774 | </varlistentry> | |
775 | <varlistentry> | |
776 | <term>reject_reason</term> | |
777 | <listitem> | |
778 | <para>The reason to send to listed clients when disconnecting them.</para> | |
779 | </listitem> | |
780 | </varlistentry> | |
781 | </variablelist> | |
782 | </sect2> | |
783 | <sect2> | |
784 | <title>alias {} block</title> | |
785 | <synopsis> | |
786 | alias "<replaceable>name</replaceable>" { | |
787 | target = "<replaceable>text</replaceable>"; | |
788 | };</synopsis> | |
789 | <para> | |
790 | Alias blocks allow the definition of custom commands. | |
791 | These commands send PRIVMSG to the given target. A real | |
792 | command takes precedence above an alias. | |
793 | </para> | |
794 | <variablelist> | |
795 | <title>alias {} variables</title> | |
796 | <varlistentry> | |
797 | <term>target</term> | |
798 | <listitem> | |
799 | <para> | |
800 | The target nick (must be a network service (umode +S)) or | |
801 | user@server. | |
802 | In the latter case, the server cannot be this server, | |
803 | only opers can use user starting with "opers" reliably and | |
804 | the user is interpreted on the target server only | |
805 | so you may need to use nick@server instead). | |
806 | </para> | |
807 | </listitem> | |
808 | </varlistentry> | |
809 | </variablelist> | |
810 | </sect2> | |
811 | <sect2> | |
812 | <title>cluster {} block</title> | |
813 | <synopsis> | |
814 | cluster { | |
815 | name = "<replaceable>text</replaceable>"; | |
816 | flags = <replaceable>list</replaceable>; | |
817 | };</synopsis> | |
818 | <para> | |
819 | The cluster block specifies servers we propagate things to | |
820 | automatically. | |
821 | This does not allow them to set bans, you need a separate shared{} | |
822 | block for that. | |
823 | </para> | |
824 | <para> | |
825 | Having overlapping cluster{} items will cause the command to | |
826 | be executed twice on the target servers. This is particularly | |
827 | undesirable for ban removals. | |
828 | </para> | |
829 | <para> | |
830 | The letters in parentheses denote the flags in /stats U. | |
831 | </para> | |
832 | <variablelist> | |
833 | <title>cluster {} variables</title> | |
834 | <varlistentry> | |
835 | <term>name</term> | |
836 | <listitem> | |
837 | <para>The server name to share with, this may contain wildcards | |
838 | and may be stacked.</para> | |
839 | </listitem> | |
840 | </varlistentry> | |
841 | <varlistentry> | |
842 | <term>flags</term> | |
843 | <listitem> | |
844 | <para>The list of what to share, all the name lines above this | |
845 | (up to another flags entry) will receive these flags. | |
846 | They are listed below.</para> | |
847 | </listitem> | |
848 | </varlistentry> | |
849 | </variablelist> | |
850 | <variablelist> | |
851 | <title>cluster {} flags</title> | |
852 | <varlistentry> | |
853 | <term>kline (K)</term> | |
854 | <listitem> | |
855 | <para>Permanent K:lines</para> | |
856 | </listitem> | |
857 | </varlistentry> | |
858 | <varlistentry> | |
859 | <term>tkline (k)</term> | |
860 | <listitem> | |
861 | <para>Temporary K:lines</para> | |
862 | </listitem> | |
863 | </varlistentry> | |
864 | <varlistentry> | |
865 | <term>unkline (U)</term> | |
866 | <listitem> | |
867 | <para>K:line removals</para> | |
868 | </listitem> | |
869 | </varlistentry> | |
870 | <varlistentry> | |
871 | <term>xline (X)</term> | |
872 | <listitem> | |
873 | <para>Permanent X:lines</para> | |
874 | </listitem> | |
875 | </varlistentry> | |
876 | <varlistentry> | |
877 | <term>txline (x)</term> | |
878 | <listitem> | |
879 | <para>Temporary X:lines</para> | |
880 | </listitem> | |
881 | </varlistentry> | |
882 | <varlistentry> | |
883 | <term>unxline (Y)</term> | |
884 | <listitem> | |
885 | <para>X:line removals</para> | |
886 | </listitem> | |
887 | </varlistentry> | |
888 | <varlistentry> | |
889 | <term>resv (Q)</term> | |
890 | <listitem> | |
891 | <para>Permanently reserved nicks/channels</para> | |
892 | </listitem> | |
893 | </varlistentry> | |
894 | <varlistentry> | |
895 | <term>tresv (q)</term> | |
896 | <listitem> | |
897 | <para>Temporarily reserved nicks/channels</para> | |
898 | </listitem> | |
899 | </varlistentry> | |
900 | <varlistentry> | |
901 | <term>unresv (R)</term> | |
902 | <listitem> | |
903 | <para>RESV removals</para> | |
904 | </listitem> | |
905 | </varlistentry> | |
906 | <varlistentry> | |
907 | <term>locops (L)</term> | |
908 | <listitem> | |
909 | <para>LOCOPS messages (sharing this with * makes LOCOPS rather | |
910 | similar to OPERWALL which is not useful)</para> | |
911 | </listitem> | |
912 | </varlistentry> | |
913 | <varlistentry> | |
914 | <term>all</term> | |
915 | <listitem> | |
916 | <para>All of the above</para> | |
917 | </listitem> | |
918 | </varlistentry> | |
919 | </variablelist> | |
920 | </sect2> | |
921 | <sect2> | |
922 | <title>shared {} block</title> | |
923 | <synopsis> | |
924 | shared { | |
925 | oper = "<replaceable>user@host</replaceable>", "<replaceable>server</replaceable>"; | |
926 | flags = <replaceable>list</replaceable>; | |
927 | };</synopsis> | |
928 | <para> | |
929 | The shared block specifies opers allowed to perform certain actions | |
930 | on our server remotely. | |
931 | These are ordered top down. The first one matching will determine | |
932 | the oper's access. | |
933 | If access is denied, the command will be silently ignored. | |
934 | </para> | |
935 | <para> | |
936 | The letters in parentheses denote the flags in /stats U. | |
937 | </para> | |
938 | <variablelist> | |
939 | <title>shared {} variables</title> | |
940 | <varlistentry> | |
941 | <term>oper</term> | |
942 | <listitem> | |
943 | <para>The user@host the oper must have, and the server they must | |
944 | be on. This may contain wildcards.</para> | |
945 | </listitem> | |
946 | </varlistentry> | |
947 | <varlistentry> | |
948 | <term>flags</term> | |
949 | <listitem> | |
950 | <para>The list of what to allow, all the oper lines above this | |
951 | (up to another flags entry) will receive these flags. | |
952 | They are listed below.</para> | |
953 | </listitem> | |
954 | </varlistentry> | |
955 | </variablelist> | |
956 | <note><para> | |
957 | While they have the same names, the flags have subtly different | |
958 | meanings from those in the cluster{} block. | |
959 | </para></note> | |
960 | <variablelist> | |
961 | <title>shared {} flags</title> | |
962 | <varlistentry> | |
963 | <term>kline (K)</term> | |
964 | <listitem> | |
965 | <para>Permanent and temporary K:lines</para> | |
966 | </listitem> | |
967 | </varlistentry> | |
968 | <varlistentry> | |
969 | <term>tkline (k)</term> | |
970 | <listitem> | |
971 | <para>Temporary K:lines</para> | |
972 | </listitem> | |
973 | </varlistentry> | |
974 | <varlistentry> | |
975 | <term>unkline (U)</term> | |
976 | <listitem> | |
977 | <para>K:line removals</para> | |
978 | </listitem> | |
979 | </varlistentry> | |
980 | <varlistentry> | |
981 | <term>xline (X)</term> | |
982 | <listitem> | |
983 | <para>Permanent and temporary X:lines</para> | |
984 | </listitem> | |
985 | </varlistentry> | |
986 | <varlistentry> | |
987 | <term>txline (x)</term> | |
988 | <listitem> | |
989 | <para>Temporary X:lines</para> | |
990 | </listitem> | |
991 | </varlistentry> | |
992 | <varlistentry> | |
993 | <term>unxline (Y)</term> | |
994 | <listitem> | |
995 | <para>X:line removals</para> | |
996 | </listitem> | |
997 | </varlistentry> | |
998 | <varlistentry> | |
999 | <term>resv (Q)</term> | |
1000 | <listitem> | |
1001 | <para>Permanently and temporarily reserved nicks/channels</para> | |
1002 | </listitem> | |
1003 | </varlistentry> | |
1004 | <varlistentry> | |
1005 | <term>tresv (q)</term> | |
1006 | <listitem> | |
1007 | <para>Temporarily reserved nicks/channels</para> | |
1008 | </listitem> | |
1009 | </varlistentry> | |
1010 | <varlistentry> | |
1011 | <term>unresv (R)</term> | |
1012 | <listitem> | |
1013 | <para>RESV removals</para> | |
1014 | </listitem> | |
1015 | </varlistentry> | |
1016 | <varlistentry> | |
1017 | <term>all</term> | |
1018 | <listitem> | |
1019 | <para>All of the above; this does not include locops, rehash, dline, tdline or undline.</para> | |
1020 | </listitem> | |
1021 | </varlistentry> | |
1022 | <varlistentry> | |
1023 | <term>locops (L)</term> | |
1024 | <listitem> | |
1025 | <para>LOCOPS messages (accepting this from * makes LOCOPS rather | |
1026 | similar to OPERWALL which is not useful); unlike the other flags, | |
1027 | this can only be accepted from *@* although it can be | |
1028 | restricted based on source server.</para> | |
1029 | </listitem> | |
1030 | </varlistentry> | |
1031 | <varlistentry> | |
1032 | <term>rehash (H)</term> | |
1033 | <listitem> | |
1034 | <para>REHASH commands; all options can be used</para> | |
1035 | </listitem> | |
1036 | </varlistentry> | |
1037 | <varlistentry> | |
1038 | <term>dline (D)</term> | |
1039 | <listitem> | |
1040 | <para>Permanent and temporary D:lines</para> | |
1041 | </listitem> | |
1042 | </varlistentry> | |
1043 | <varlistentry> | |
1044 | <term>tdline (d)</term> | |
1045 | <listitem> | |
1046 | <para>Temporary D:lines</para> | |
1047 | </listitem> | |
1048 | </varlistentry> | |
1049 | <varlistentry> | |
1050 | <term>undline (E)</term> | |
1051 | <listitem> | |
1052 | <para>D:line removals</para> | |
1053 | </listitem> | |
1054 | </varlistentry> | |
1055 | <varlistentry> | |
1056 | <term>none</term> | |
1057 | <listitem> | |
1058 | <para>Allow nothing to be done</para> | |
1059 | </listitem> | |
1060 | </varlistentry> | |
1061 | </variablelist> | |
1062 | </sect2> | |
1063 | <sect2> | |
1064 | <title>service {} block</title> | |
1065 | <synopsis> | |
1066 | service { | |
1067 | name = "<replaceable>text</replaceable>"; | |
1068 | };</synopsis> | |
1069 | <para> | |
1070 | The service block specifies privileged servers (services). These | |
1071 | servers have extra privileges such as setting login names on users | |
1072 | and introducing clients with umode +S (unkickable, hide channels, etc). | |
1073 | This does not allow them to set bans, you need a separate shared{} | |
1074 | block for that. | |
1075 | </para> | |
1076 | <para> | |
1077 | Do not place normal servers here. | |
1078 | </para> | |
1079 | <para> | |
1080 | Multiple names may be specified but there may be only one service{} | |
1081 | block. | |
1082 | </para> | |
1083 | <variablelist> | |
1084 | <title>service {} variables</title> | |
1085 | <varlistentry> | |
1086 | <term>name</term> | |
1087 | <listitem> | |
1088 | <para>The server name to grant special privileges. This may not | |
1089 | contain wildcards.</para> | |
1090 | </listitem> | |
1091 | </varlistentry> | |
1092 | </variablelist> | |
1093 | </sect2> | |
1094 | </sect1> | |
1095 | <sect1> | |
1096 | <title>Hostname resolution (DNS)</title> | |
1097 | <para> | |
1098 | Charybdis uses solely DNS for all hostname/address lookups | |
1099 | (no <filename>/etc/hosts</filename> or anything else). | |
1100 | The DNS servers are taken from <filename>/etc/resolv.conf</filename>. | |
1101 | If this file does not exist or no valid IP addresses are listed in it, | |
1102 | the local host (127.0.0.1) is used. (Note that the latter part | |
1103 | did not work in older versions of Charybdis.) | |
1104 | </para> | |
1105 | <para> | |
1106 | IPv4 as well as IPv6 DNS servers are supported, but it is not | |
1107 | possible to use both IPv4 and IPv6 in | |
1108 | <filename>/etc/resolv.conf</filename>. | |
1109 | </para> | |
1110 | <para> | |
1111 | For both security and performance reasons, it is recommended | |
1112 | that a caching nameserver such as BIND be run on the same machine | |
1113 | as Charybdis and that <filename>/etc/resolv.conf</filename> only | |
1114 | list 127.0.0.1. | |
1115 | </para> | |
1116 | </sect1> | |
1117 | </chapter> | |
1118 | <!-- Keep this comment at the end of the file | |
1119 | Local variables: | |
1120 | mode: sgml | |
1121 | sgml-omittag:t | |
1122 | sgml-shorttag:t | |
1123 | sgml-namecase-general:t | |
1124 | sgml-general-insert-case:lower | |
1125 | sgml-minimize-attributes:nil | |
1126 | sgml-always-quote-attributes:t | |
1127 | sgml-indent-step:2 | |
1128 | sgml-indent-data:t | |
1129 | sgml-parent-document: ("dancer-oper-guide.sgml" "book") | |
1130 | sgml-exposed-tags:nil | |
1131 | fill-column:105 | |
1132 | sgml-validate-command: "nsgmls -e -g -s -u dancer-oper-guide.sgml" | |
1133 | End: | |
1134 | --> |