projects / solanum.git / blame
| Commit | Line | Data |
|---|---|---|
| 212380e3 AC |
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>"; | |
| 212380e3 AC |
45 | sid = "<replaceable>text</replaceable>"; |
| 46 | description = "<replaceable>text</replaceable>"; | |
| 47 | network_name = "<replaceable>text</replaceable>"; | |
| 48 | network_desc = "<replaceable>text</replaceable>"; | |
| 49 | hub = <replaceable>boolean</replaceable>; | |
| 50 | vhost = "<replaceable>text</replaceable>"; | |
| 51 | vhost6 = "<replaceable>text</replaceable>"; | |
| 52 | };</synopsis> | |
| 53 | <para> | |
| 54 | The serverinfo {} block defines the core operational parameters of the IRC server. | |
| 55 | </para> | |
| 56 | <variablelist> | |
| 57 | <title>serverinfo {} variables</title> | |
| 58 | <varlistentry> | |
| 59 | <term>name</term> | |
| 60 | <listitem> | |
| 61 | <para> | |
| 62 | The name of the IRC server that you are configuring. This | |
| 63 | must contain at least one dot. It is not necessarily equal | |
| 64 | to any DNS name. This must be unique on the IRC network. | |
| 65 | </para> | |
| 66 | </listitem> | |
| 67 | </varlistentry> | |
| 212380e3 AC |
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> | |
| 0c304043 JT |
296 | <para> |
| 297 | A hostmask (user@host) that the auth {} block applies to. | |
| 298 | It is matched against the hostname and IP address (using :: | |
| 299 | shortening for IPv6 and prepending a 0 if it starts with | |
| 300 | a colon) and can also use CIDR masks. | |
| 301 | You can have multiple user entries. | |
| 302 | </para> | |
| 212380e3 AC |
303 | </listitem> |
| 304 | </varlistentry> | |
| 305 | <varlistentry> | |
| 306 | <term>password</term> | |
| 307 | <listitem> | |
| 308 | <para> | |
| 309 | An optional password to use for authenticating into this auth{} | |
| 310 | block. If the password is wrong the user will not be able to | |
| 311 | connect (will not fall back on another auth{} block). | |
| 312 | </para> | |
| 313 | </listitem> | |
| 314 | </varlistentry> | |
| 315 | <varlistentry> | |
| 316 | <term>spoof</term> | |
| 317 | <listitem> | |
| 318 | <para>An optional fake hostname (or user@host) to apply to users authenticated to this auth{} block.</para> | |
| 319 | </listitem> | |
| 320 | </varlistentry> | |
| 321 | <varlistentry> | |
| 322 | <term>flags</term> | |
| 323 | <listitem> | |
| 324 | <para>A list of flags to apply to this auth{} block. They are listed below.</para> | |
| 325 | </listitem> | |
| 326 | </varlistentry> | |
| 327 | <varlistentry> | |
| 328 | <term>class</term> | |
| 329 | <listitem> | |
| 330 | <para>A name of a class to put users matching this auth{} block into.</para> | |
| 331 | </listitem> | |
| 332 | </varlistentry> | |
| 333 | </variablelist> | |
| 334 | <variablelist> | |
| 335 | <title>auth {} flags</title> | |
| 336 | <varlistentry> | |
| 337 | <term>encrypted</term> | |
| 338 | <listitem> | |
| 339 | <para>The password used has been encrypted.</para> | |
| 340 | </listitem> | |
| 341 | </varlistentry> | |
| 342 | <varlistentry> | |
| 343 | <term>spoof_notice</term> | |
| 344 | <listitem> | |
| 345 | <para>Causes the IRCd to send out a server notice when activating a spoof provided by this auth{} block.</para> | |
| 346 | </listitem> | |
| 347 | </varlistentry> | |
| 348 | <varlistentry> | |
| 349 | <term>exceed_limit</term> | |
| 350 | <listitem> | |
| 351 | <para>Users in this auth{} block can exceed class-wide limitations.</para> | |
| 352 | </listitem> | |
| 353 | </varlistentry> | |
| 354 | <varlistentry> | |
| 355 | <term>dnsbl_exempt</term> | |
| 356 | <listitem> | |
| 357 | <para>Users in this auth{} block are exempted from DNS blacklist checks. However, they will still be warned if they are listed.</para> | |
| 358 | </listitem> | |
| 359 | </varlistentry> | |
| 360 | <varlistentry> | |
| 361 | <term>kline_exempt</term> | |
| 362 | <listitem> | |
| 363 | <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> | |
| 364 | </listitem> | |
| 365 | </varlistentry> | |
| 366 | <varlistentry> | |
| 367 | <term>gline_exempt</term> | |
| 368 | <listitem> | |
| 369 | <para>Users in this auth{} block are exempted from g:lines.</para> | |
| 370 | </listitem> | |
| 371 | </varlistentry> | |
| 372 | <varlistentry> | |
| 373 | <term>spambot_exempt</term> | |
| 374 | <listitem> | |
| 375 | <para>Users in this auth{} block are exempted from spambot checks.</para> | |
| 376 | </listitem> | |
| 377 | </varlistentry> | |
| 378 | <varlistentry> | |
| 379 | <term>shide_exempt</term> | |
| 380 | <listitem> | |
| 381 | <para>Users in this auth{} block are exempted from some serverhiding effects.</para> | |
| 382 | </listitem> | |
| 383 | </varlistentry> | |
| 384 | <varlistentry> | |
| 385 | <term>jupe_exempt</term> | |
| 386 | <listitem> | |
| 387 | <para>Users in this auth{} block do not trigger an alarm when joining juped channels.</para> | |
| 388 | </listitem> | |
| 389 | </varlistentry> | |
| 390 | <varlistentry> | |
| 391 | <term>resv_exempt</term> | |
| 392 | <listitem> | |
| 393 | <para>Users in this auth{} block may use reserved nicknames and channels.</para> | |
| 394 | <note><para>The initial nickname may still not be reserved.</para></note> | |
| 395 | </listitem> | |
| 396 | </varlistentry> | |
| 397 | <varlistentry> | |
| 398 | <term>flood_exempt</term> | |
| 399 | <listitem> | |
| 400 | <para> | |
| 401 | Users in this auth{} block may send arbitrary amounts of | |
| 402 | commands per time unit to the server. This does not exempt | |
| 403 | them from any other flood limits. | |
| 404 | You should use this setting with caution. | |
| 405 | </para> | |
| 406 | </listitem> | |
| 407 | </varlistentry> | |
| 408 | <varlistentry> | |
| 409 | <term>no_tilde</term> | |
| 410 | <listitem> | |
| 411 | <para>Users in this auth{} block will not have a tilde added to their username if they do not run identd.</para> | |
| 412 | </listitem> | |
| 413 | </varlistentry> | |
| 414 | <varlistentry> | |
| 415 | <term>need_ident</term> | |
| 416 | <listitem> | |
| 417 | <para>Users in this auth{} block must have identd, otherwise they will be rejected.</para> | |
| 418 | </listitem> | |
| 419 | </varlistentry> | |
| 420 | <varlistentry> | |
| 421 | <term>need_sasl</term> | |
| 422 | <listitem> | |
| 423 | <para>Users in this auth{} block must identify via SASL, otherwise they will be rejected.</para> | |
| 424 | </listitem> | |
| 425 | </varlistentry> | |
| 426 | </variablelist> | |
| 427 | </sect2> | |
| 428 | <sect2> | |
| 429 | <title>exempt {} block</title> | |
| 430 | <synopsis> | |
| 431 | exempt { | |
| 432 | ip = "<replaceable>ip</replaceable>"; | |
| 433 | };</synopsis> | |
| 434 | <para> | |
| b808adf9 JT |
435 | An exempt block specifies IP addresses which are exempt from D:lines |
| 436 | and throttling. | |
| 212380e3 AC |
437 | Multiple addresses can be specified in one block. |
| 438 | Clients coming from these addresses can still be K/G/X:lined or | |
| 439 | banned by a DNS blacklist unless | |
| 440 | they also have appropriate flags in their auth{} block. | |
| 441 | </para> | |
| 442 | <variablelist> | |
| 443 | <title>exempt {} variables</title> | |
| 444 | <varlistentry> | |
| 445 | <term>ip</term> | |
| 446 | <listitem> | |
| 447 | <para>The IP address or CIDR range to exempt.</para> | |
| 448 | </listitem> | |
| 449 | </varlistentry> | |
| 450 | </variablelist> | |
| 451 | </sect2> | |
| 452 | <sect2> | |
| 453 | <title>operator {} block</title> | |
| 454 | <synopsis> | |
| 455 | operator "<replaceable>name</replaceable>" { | |
| 456 | user = "<replaceable>hostmask</replaceable>"; | |
| 457 | password = "<replaceable>text</replaceable>"; | |
| 458 | rsa_public_key_file = "<replaceable>text</replaceable>"; | |
| 459 | umodes = <replaceable>list</replaceable>; | |
| 460 | snomask = "<replaceable>text</replaceable>"; | |
| 461 | flags = <replaceable>list</replaceable>; | |
| 462 | };</synopsis> | |
| 463 | <para> | |
| 464 | Operator blocks define who may use the OPER command to gain extended privileges. | |
| 465 | </para> | |
| 466 | <variablelist> | |
| 467 | <title>operator {} variables</title> | |
| 468 | <varlistentry> | |
| 469 | <term>user</term> | |
| 470 | <listitem> | |
| 471 | <para> | |
| 472 | A hostmask that users trying to use this operator {} block | |
| 473 | must match. This is checked against the original host and IP | |
| 474 | address; CIDR is also supported. So auth {} spoofs work in | |
| 475 | operator {} blocks; the real host behind them is not checked. | |
| 476 | Other kind of spoofs do not work in operator {} blocks; the | |
| 477 | real host behind them is checked. | |
| 478 | </para> | |
| 479 | <para> | |
| 480 | Note that this is different from charybdis 1.x where all | |
| 481 | kinds of spoofs worked in operator {} blocks. | |
| 482 | </para> | |
| 483 | </listitem> | |
| 484 | </varlistentry> | |
| 485 | <varlistentry> | |
| 486 | <term>password</term> | |
| 487 | <listitem> | |
| 488 | <para> | |
| 489 | A password used with the OPER command to use this operator {} block. | |
| 490 | Passwords are encrypted by default, but may be unencrypted if ~encrypted is present | |
| 491 | in the flags list. | |
| 492 | </para> | |
| 493 | </listitem> | |
| 494 | </varlistentry> | |
| 495 | <varlistentry> | |
| 496 | <term>rsa_public_key_file</term> | |
| 497 | <listitem> | |
| 498 | <para> | |
| 499 | An optional path to a RSA public key file associated with the operator {} block. | |
| 500 | This information is used by the CHALLENGE command, which is an alternative authentication | |
| 501 | scheme to the traditional OPER command. | |
| 502 | </para> | |
| 503 | </listitem> | |
| 504 | </varlistentry> | |
| 505 | <varlistentry> | |
| 506 | <term>umodes</term> | |
| 507 | <listitem> | |
| 508 | <para>A list of usermodes to apply to successfully opered clients.</para> | |
| 509 | </listitem> | |
| 510 | </varlistentry> | |
| 511 | <varlistentry> | |
| 512 | <term>snomask</term> | |
| 513 | <listitem> | |
| 514 | <para> | |
| 515 | An snomask to apply to successfully opered clients. | |
| 516 | </para> | |
| 517 | </listitem> | |
| 518 | </varlistentry> | |
| 519 | <varlistentry> | |
| 520 | <term>flags</term> | |
| 521 | <listitem> | |
| 522 | <para> | |
| 523 | A listing of privileges granted to operators using this block. | |
| 524 | By default, the operwall and remoteban privileges are granted; | |
| 525 | use ~operwall and ~remoteban to disable them if necessary. | |
| 526 | </para> | |
| 527 | <para> | |
| 528 | In addition, a flag designating if the password is encrypted is here. | |
| 529 | Privileges are documented elsewhere in this guide. | |
| 530 | </para> | |
| 531 | </listitem> | |
| 532 | </varlistentry> | |
| 533 | </variablelist> | |
| 534 | </sect2> | |
| 535 | <sect2> | |
| 536 | <title>connect {} block</title> | |
| 537 | <synopsis> | |
| 538 | connect "<replaceable>name</replaceable>" { | |
| 539 | host = "<replaceable>text</replaceable>"; | |
| 540 | send_password = "<replaceable>text</replaceable>"; | |
| 541 | accept_password = "<replaceable>text</replaceable>"; | |
| 542 | port = <replaceable>number</replaceable>; | |
| 543 | hub_mask = "<replaceable>mask</replaceable>"; | |
| 544 | leaf_mask = "<replaceable>mask</replaceable>"; | |
| 545 | class = "<replaceable>text</replaceable>"; | |
| 546 | flags = <replaceable>list</replaceable>; | |
| 547 | aftype = <replaceable>protocol</replaceable>; | |
| 548 | };</synopsis> | |
| 549 | <para> | |
| 550 | Connect blocks define what servers may connect or be connected to. | |
| 551 | </para> | |
| 552 | <variablelist> | |
| 553 | <title>connect {} variables</title> | |
| 554 | <varlistentry> | |
| 555 | <term>host</term> | |
| 556 | <listitem> | |
| 557 | <para>The hostname or IP to connect to.</para> | |
| 558 | <note><para> | |
| 559 | Charybdis uses solely DNS for all hostname/address lookups | |
| 560 | (no <filename>/etc/hosts</filename> or anything else). | |
| 561 | Furthermore, if a hostname is used, it must have an A or AAAA | |
| 562 | record (no CNAME) and it must be the primary | |
| 563 | hostname for inbound connections to work. | |
| 0c304043 JT |
564 | </para><para> |
| 565 | IPv6 addresses must be in :: shortened form; addresses which | |
| 566 | then start with a colon must be prepended with a zero, | |
| 567 | for example 0::1. | |
| 212380e3 AC |
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 | --> |