doc/sgml/oper-guide/config.sgml

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