2 <title>Server config file format</title>
4 <title>General format</title>
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.
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
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
18 Relative paths are first tried relative to PREFIX and then relative
19 to ETCPATH (normally PREFIX/etc).
22 Anything from a # to the end of a line is a comment. Blank lines are ignored. C-style comments are also supported.
25 <sect1 id="configlines">
26 <title>Specific blocks and directives</title>
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.
32 <title>loadmodule directive</title>
34 loadmodule "<replaceable>text</replaceable>";</synopsis>
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.
41 <title>serverinfo {} block</title>
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>";
54 The serverinfo {} block defines the core operational parameters of the IRC server.
57 <title>serverinfo {} variables</title>
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.
72 A unique ID which describes the server. This is required regardless of whether you are using
74 This consists of one digit and two characters which can be
80 <term>description</term>
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.
90 <term>network_name</term>
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.
99 <term>network_desc</term>
102 A description of the IRC network that this server will be a member of.
103 This is currently unused.
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.
119 An optional text field which defines an IP from which to connect outward to other IRC servers.
127 An optional text field which defines an IPv6 IP from which to connect outward to other IRC servers.
134 <title>admin {} block</title>
137 name = "<replaceable>text</replaceable>";
138 description = "<replaceable>text</replaceable>";
139 email = "<replaceable>text</replaceable>";
142 This block provides the information which is returned by the ADMIN command.
145 <title>admin {} variables</title>
149 <para>The name of the administrator running this service.</para>
153 <term>description</term>
155 <para>The description of the administrator's position in the network.</para>
161 <para>A point of contact for the administrator, usually an e-mail address.</para>
167 <title>class {} block</title>
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>;
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>;
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.
193 Classes are used both for client and server connections,
194 but most variables are different.
197 <title>class {} variables: client classes</title>
199 <term>ping_time</term>
201 <para>The amount of time between checking pings for clients, e.g.: 2 minutes</para>
205 <term>number_per_ident</term>
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>
211 <term>number_per_ip</term>
213 <para>The amount of clients which may be connected from a single IP address.</para>
217 <term>number_per_ip_global</term>
219 <para>The amount of clients which may be connected globally from a single IP address.</para>
223 <term>cidr_bitlen</term>
225 <para>The netblock length to use with CIDR-based client limiting for this class.</para>
229 <term>number_per_cidr</term>
231 <para>The amount of clients which may be connected from a single netblock.</para>
235 <term>max_number</term>
237 <para>The maximum amount of clients which may use this class at any given time.</para>
243 <para>The maximum size of the queue of data to be sent to a client before it is dropped.</para>
248 <title>class {} variables: server classes</title>
250 <term>ping_time</term>
252 <para>The amount of time between checking pings for servers, e.g.: 2 minutes</para>
256 <term>connectfreq</term>
258 <para>The amount of time between autoconnects. This must at least be one minute, as autoconnects are evaluated with that granularity.</para>
262 <term>max_number</term>
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>
270 <para>The maximum size of the queue of data to be sent to a server before it is dropped.</para>
276 <title>auth {} block</title>
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>";
286 auth {} blocks allow client connections to the server, and set various properties concerning those connections.
289 Auth blocks are evaluated from top to bottom in priority, so put special blocks first.
292 <title>auth {} variables</title>
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.
306 <term>password</term>
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).
318 <para>An optional fake hostname (or user@host) to apply to users authenticated to this auth{} block.</para>
324 <para>A list of flags to apply to this auth{} block. They are listed below.</para>
330 <para>A name of a class to put users matching this auth{} block into.</para>
335 <title>auth {} flags</title>
337 <term>encrypted</term>
339 <para>The password used has been encrypted.</para>
343 <term>spoof_notice</term>
345 <para>Causes the IRCd to send out a server notice when activating a spoof provided by this auth{} block.</para>
349 <term>exceed_limit</term>
351 <para>Users in this auth{} block can exceed class-wide limitations.</para>
355 <term>dnsbl_exempt</term>
357 <para>Users in this auth{} block are exempted from DNS blacklist checks. However, they will still be warned if they are listed.</para>
361 <term>kline_exempt</term>
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>
367 <term>gline_exempt</term>
369 <para>Users in this auth{} block are exempted from g:lines.</para>
373 <term>spambot_exempt</term>
375 <para>Users in this auth{} block are exempted from spambot checks.</para>
379 <term>shide_exempt</term>
381 <para>Users in this auth{} block are exempted from some serverhiding effects.</para>
385 <term>jupe_exempt</term>
387 <para>Users in this auth{} block do not trigger an alarm when joining juped channels.</para>
391 <term>resv_exempt</term>
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>
398 <term>flood_exempt</term>
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.
409 <term>no_tilde</term>
411 <para>Users in this auth{} block will not have a tilde added to their username if they do not run identd.</para>
415 <term>need_ident</term>
417 <para>Users in this auth{} block must have identd, otherwise they will be rejected.</para>
421 <term>need_sasl</term>
423 <para>Users in this auth{} block must identify via SASL, otherwise they will be rejected.</para>
429 <title>exempt {} block</title>
432 ip = "<replaceable>ip</replaceable>";
435 An exempt block specifies IP addresses which are exempt from D:lines
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.
443 <title>exempt {} variables</title>
447 <para>The IP address or CIDR range to exempt.</para>
453 <title>operator {} block</title>
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>;
464 Operator blocks define who may use the OPER command to gain extended privileges.
467 <title>operator {} variables</title>
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.
480 Note that this is different from charybdis 1.x where all
481 kinds of spoofs worked in operator {} blocks.
486 <term>password</term>
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
496 <term>rsa_public_key_file</term>
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.
508 <para>A list of usermodes to apply to successfully opered clients.</para>
515 An snomask to apply to successfully opered clients.
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.
528 In addition, a flag designating if the password is encrypted is here.
529 Privileges are documented elsewhere in this guide.
536 <title>connect {} block</title>
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>;
550 Connect blocks define what servers may connect or be connected to.
553 <title>connect {} variables</title>
557 <para>The hostname or IP to connect to.</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.
565 IPv6 addresses must be in :: shortened form; addresses which
566 then start with a colon must be prepended with a zero,
572 <term>send_password</term>
574 <para>The password to send to the other server.</para>
578 <term>accept_password</term>
580 <para>The password that should be accepted from the other server.</para>
586 <para>The port on the other server to connect to.</para>
590 <term>hub_mask</term>
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.
602 <term>leaf_mask</term>
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
615 <para>The name of the class this server should be placed into.</para>
621 <para>A list of flags concerning the connect block. They are listed below.</para>
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>
632 <title>connect {} flags</title>
634 <term>encrypted</term>
636 <para>The value for accept_password has been encrypted.</para>
640 <term>autoconn</term>
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.
650 <term>compressed</term>
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>
660 <term>topicburst</term>
662 <para>Topics should be bursted to this server.</para>
668 <title>listen {} block</title>
671 host = "<replaceable>text</replaceable>";
672 port = <replaceable>number</replaceable>;
675 A listen block specifies what ports a server should listen on.
678 <title>listen {} variables</title>
682 <para>An optional host to bind to. Otherwise, the ircd will listen on all available hosts.</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 (..).
697 <title>modules {} block</title>
700 path = "<replaceable>text</replaceable>";
701 module = <replaceable>text</replaceable>;
704 The modules block specifies information for loadable modules.
707 <title>modules {} variables</title>
711 <para>Specifies a path to search for loadable modules.</para>
718 Specifies a module to load, similar to loadmodule.
725 <title>general {} block</title>
728 <replaceable>values</replaceable>
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>.
737 <title>channel {} block</title>
740 <replaceable>values</replaceable>
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>.
749 <title>serverhide {} block</title>
752 <replaceable>values</replaceable>
755 The serverhide block specifies options related to server hiding.
756 The options are documented in <filename>reference.conf</filename>.
760 <title>blacklist {} block</title>
763 host = "<replaceable>text</replaceable>";
764 reject_reason = "<replaceable>text</replaceable>";
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.
772 Multiple blacklists can be specified, in pairs with first host
776 <title>blacklist {} variables</title>
780 <para>The DNSBL to use.</para>
784 <term>reject_reason</term>
786 <para>The reason to send to listed clients when disconnecting them.</para>
792 <title>alias {} block</title>
794 alias "<replaceable>name</replaceable>" {
795 target = "<replaceable>text</replaceable>";
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.
803 <title>alias {} variables</title>
808 The target nick (must be a network service (umode +S)) or
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).
820 <title>cluster {} block</title>
823 name = "<replaceable>text</replaceable>";
824 flags = <replaceable>list</replaceable>;
827 The cluster block specifies servers we propagate things to
829 This does not allow them to set bans, you need a separate shared{}
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.
838 The letters in parentheses denote the flags in /stats U.
841 <title>cluster {} variables</title>
845 <para>The server name to share with, this may contain wildcards
846 and may be stacked.</para>
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>
859 <title>cluster {} flags</title>
861 <term>kline (K)</term>
863 <para>Permanent K:lines</para>
867 <term>tkline (k)</term>
869 <para>Temporary K:lines</para>
873 <term>unkline (U)</term>
875 <para>K:line removals</para>
879 <term>xline (X)</term>
881 <para>Permanent X:lines</para>
885 <term>txline (x)</term>
887 <para>Temporary X:lines</para>
891 <term>unxline (Y)</term>
893 <para>X:line removals</para>
897 <term>resv (Q)</term>
899 <para>Permanently reserved nicks/channels</para>
903 <term>tresv (q)</term>
905 <para>Temporarily reserved nicks/channels</para>
909 <term>unresv (R)</term>
911 <para>RESV removals</para>
915 <term>locops (L)</term>
917 <para>LOCOPS messages (sharing this with * makes LOCOPS rather
918 similar to OPERWALL which is not useful)</para>
924 <para>All of the above</para>
930 <title>shared {} block</title>
933 oper = "<replaceable>user@host</replaceable>", "<replaceable>server</replaceable>";
934 flags = <replaceable>list</replaceable>;
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
941 If access is denied, the command will be silently ignored.
944 The letters in parentheses denote the flags in /stats U.
947 <title>shared {} variables</title>
951 <para>The user@host the oper must have, and the server they must
952 be on. This may contain wildcards.</para>
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>
965 While they have the same names, the flags have subtly different
966 meanings from those in the cluster{} block.
969 <title>shared {} flags</title>
971 <term>kline (K)</term>
973 <para>Permanent and temporary K:lines</para>
977 <term>tkline (k)</term>
979 <para>Temporary K:lines</para>
983 <term>unkline (U)</term>
985 <para>K:line removals</para>
989 <term>xline (X)</term>
991 <para>Permanent and temporary X:lines</para>
995 <term>txline (x)</term>
997 <para>Temporary X:lines</para>
1001 <term>unxline (Y)</term>
1003 <para>X:line removals</para>
1007 <term>resv (Q)</term>
1009 <para>Permanently and temporarily reserved nicks/channels</para>
1013 <term>tresv (q)</term>
1015 <para>Temporarily reserved nicks/channels</para>
1019 <term>unresv (R)</term>
1021 <para>RESV removals</para>
1027 <para>All of the above; this does not include locops or rehash</para>
1031 <term>locops (L)</term>
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>
1040 <term>rehash (H)</term>
1042 <para>REHASH commands; all options can be used</para>
1048 <para>Allow nothing to be done</para>
1054 <title>service {} block</title>
1057 name = "<replaceable>text</replaceable>";
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{}
1067 Do not place normal servers here.
1070 Multiple names may be specified but there may be only one service{}
1074 <title>service {} variables</title>
1078 <para>The server name to grant special privileges. This may not
1079 contain wildcards.</para>
1086 <!-- Keep this comment at the end of the file
1091 sgml-namecase-general:t
1092 sgml-general-insert-case:lower
1093 sgml-minimize-attributes:nil
1094 sgml-always-quote-attributes:t
1097 sgml-parent-document: ("dancer-oper-guide.sgml" "book")
1098 sgml-exposed-tags:nil
1100 sgml-validate-command: "nsgmls -e -g -s -u dancer-oper-guide.sgml"