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