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