Log in | Back to darenet.org
Share

DareNET IRCd Configuration/1.5

m (→UWorld Block)
(→Connect block)
 
(77 intermediate revisions not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
-
This is a reference guide for ircd-darenet 1.4.1+'s configuration file.
+
This is a reference guide for ircd-darenet 1.5.x's configuration file.
-
<pre>BlockName
+
The configuration format consists of various blocks, each containing name-value pairs, tags or string data. It is designed to be easily readable by both human ircd.
-
{
+
-
  setting = number;
+
-
  setting2 = "string";
+
-
  setting3 = yes;
+
-
};</pre>
+
-
Comments may continue to start with a hash(#), or use the C or C++ style. For example:
+
A block consists of a name, an opening '{' brace, statements, a closing '}' brace, and a ';' semicolon. A statement consists of a name possibly followed by an '=' equals sign and a value, ending with a semicolon. All strings must be surrounded by '"' double quotes.
-
<pre># This is a valid comment
+
A sample block:
-
/* This is a valid C-style comment. */
+
<html><pre><strong>blockname</strong> {
 +
    name = value;
 +
    name = <span class="qstring">"string"</span>;
 +
    name = <span class="integer">123</span>;
 +
    tag;
 +
};</pre></html>
-
// This is a valid C++ style comment.
+
All elements of the configuration are separated by whitespace, and can be packed on one line, or broken up over several lines. Whitespace is defined as space, tab or carriage return/linefeed. Three forms of comments are allowed:
-
</pre>
+
-
Whitespace(space, tab or carriage return/linefeed) are ignored and may be used to make the configuration more readable. In fact, we recommend you use utilizie whitespace -- don't cram everything together, as you only make it more difficult for others to read/edit.
+
-
'''Order of blocks:'''
+
<pre>/* C style single/multi-line */
-
When the ircd puts the configuration lines into practice, it parses them backwards. That is, it uses the blocks exactly in reverse than how they are listed in the configuration file. This means that you should start with Client {} blocks with the "fall through", most vanilla and end with the most detailed.
+
// C++ style single-line
-
== General Block ==
+
# Shell style single-line
 +
</pre>
 +
{{info|text=Blocks are used in the reverse order than how they're listed, when the configuration file is parsed. This means you should start multiple block definitions with the "fall through", and end with the most detailed.}}
-
{| class="wikitable" width="40%" style="font-size: 97%; text-align: left;"
+
== General block ==
-
| Requirement:
+
 
-
| REQUIRED
+
{| class="simpletable" width="100%"
 +
|width="250px"|Requirement:
 +
|REQUIRED
|-
|-
-
| Old conf format equivalents:
+
|Old conf format equivalents:
-
| M:line
+
|<code>M:name:vhost:description::numeric</code>
|}
|}
-
The General {} block defines information about the server itself.
+
The General block defines information about the server itself. It is required for the server to start.
-
<pre>General  
+
<html><pre><strong>General</strong> {
-
{
+
    <span class="comment">/* name: the name of our server. */</span>
-
  name = "servername";
+
    name = <span class="qstring">"test.area.zone.darenet.org"</span>;
-
  description = "description";
+
-
  numeric = numericnumber;
+
-
  vhost = "ipv4vhost";
+
-
  ssl_pem = "path/to/ircd.pem";
+
-
  ssl_private_key = "path/to/ircd.key";
+
-
};</pre>
+
-
'''Required tokens:''' <code>name, description, numeric</code>
+
    <span class="comment">/* description: the description of our server. */</span>
 +
    description = <span class="qstring">"ircd-darenet test server"</span>;
-
'''Optional tokens:''' <code>vhost, ssl_pem, ssl_private_key</code>
+
    <span class="comment">/* numeric: the unique server numeric for our server. It must be a
 +
    * digit between 0 and 4095, and is not updated on a rehash.
 +
    */</span>
 +
    numeric = <span class="integer">999</span>;
-
Note that the server <numeric> must be unique on the network the server is linked to, and may be between 0 and 4095. It is not updated on a rehash. If linking to DareNET, you should use the numeric assigned to you by the Infrastructure team.
+
    <span class="comment">/* vhost: the IP to bind to when we connect outward to other servers.
 +
    * It must contain either a * or a valid ipv4 address in dotted quad notation.  
 +
    */</span>
 +
    vhost = <span class="qstring">"192.169.0.1"</span>;
-
If <vhost> is specified, it must contain either a <code>*</code> or a valid IPv4 address in dotted quad notation (e.g., 127.0.0.1). The address MUST be the address of a physical interface on the host. It is used only for outgoing connections; see Port {} blocks for listener virtual hosting. If in doubt what to put here, use the IP of your primary interface.
+
    <span class="comment">/* ssl_private_key: our ssl private key. */</span>
 +
    ssl_private_key = <span class="qstring">"etc/ircd.key"</span>;
-
If SSL is enabled, you MUST specify the path to your pem (containing your cert and private key) and private key files using the ssl_pem and ssl_private_key tokens.
+
    <span class="comment">/* ssl_pem: file containing our ssl certificate and private key */</span>
 +
    ssl_pem = <span class="qstring">"etc/ircd.pem"</span>;
-
There may only be one General {} block.  
+
    <span class="comment">/* dpass: (optional) password for DIE command. */</span>
 +
    dpass = <span class="qstring">"encrypted pass"</span>;
-
'''Example block:'''
+
    <span class="comment">/* rpass: (optional) password for RESTART command. */</span>
 +
    rpass = <span class="qstring">"$PLAIN$password"</span>; 
 +
};
 +
</pre></html>
-
<c>General
+
The server name may only be changed by a server restart. The description can be changed on rehash, but will not propagate to other linked servers.
-
{
+
-
  name = "servername.area.zone.darenet.org";
+
-
  description = "DareNET Client Server";
+
-
  numeric = 10;
+
-
  vhost = "127.0.0.1";
+
-
  ssl_pem = "etc/ircd.pem";
+
-
  ssl_private_key = "etc/ircd.key";
+
-
};</c>
+
-
== Admin Block ==
+
There must be exactly one General block.
-
{| class="wikitable" width="40%" style="font-size: 97%; text-align: left;"
+
== Admin block ==
-
| Requirement:
+
 
-
| SUGGESTED
+
{| class="simpletable" width="100%"
 +
|width="250px"|Requirement:
 +
|SUGGESTED
|-
|-
-
| Old conf format equivalents:
+
|Old conf format equivalents:
-
| A:line
+
|<code>A:line1:line2:line3</code>
|}
|}
-
The Admin {} block defines information that can be retrieved with the /ADMIN command.
+
The Admin block defines information that can be retrieved with the <code>/ADMIN</code> command.
-
There may only be one Admin {} block.
+
<html><pre><strong>Admin</strong> {
 +
    location = <span class="qstring">"DareNET - http://www.darenet.org"</span>;
 +
    location = <span class="qstring">"Infrastructure Team"</span>;
 +
    contact = <span class="qstring">"&lt;infrastructure@darenet.org&gt;"</span>;
 +
};
 +
</pre></html>
-
<pre>Admin  
+
Not all lines are required. There may only be one Admin block.
-
{
+
-
  Location = "string 1 here";
+
-
  Location = "string 2 here";
+
-
  Contact = "string 3 here";
+
-
};</pre>
+
-
'''Example block:'''
+
== Class block ==
-
<c>Admin
+
{| class="simpletable" width="100%"
-
{
+
|width="250px"|Requirement:
-
  Location = "DareNET";
+
|RECOMMENDED
-
  Location = "Infrastructure Team";
+
|-
-
  Contact = "<infrastructure@darenet.org>";
+
|Old conf format equivalents:
-
};</c>
+
|<code>Y:class:pingfreq::maxlinks:sendq (clients)</code><br /><code>Y:class:pingfreq:connectfreq:maxlinks:sendq (servers)</code>
-
 
+
-
== Class Block ==
+
-
 
+
-
{| class="wikitable" width="40%" style="font-size: 97%; text-align: left;"
+
-
| Requirement:
+
-
| SUGGESTED
+
|-
|-
-
| Old conf format equivalents:
 
-
| Y:line
 
|}
|}
-
The Class {} blocks define connection classes. All connections to the server are associated with a "connection class", whether they be incoming or outgoing (initiated by the server), be they clients or servers.
+
The Class blocks define connection classes. All connections to the server are associated with a "connection class", whether they be incoming or outgoing (initiated by the server), be they clients or servers.
-
<pre>Class
+
<html><pre><strong>Class</strong> {
-
{
+
    <span class="comment">/* name: a name for the connection class. */</span>
-
  name = "<class>";
+
    name = <span class="qstring">"Users"</span>;
-
  pingfreq = time;
+
-
  connectfreq = time;
+
-
  maxlinks = number;
+
-
  sendq = size;
+
-
  usermode = "+modes";
+
-
};</pre>
+
-
'''Required tokens:''' <code>name, pingfreq, sendq</code>
+
    <span class="comment">/* pingfreq: how often to PING idle connections. */</span>
 +
    pingfreq = 1 minute 30 seconds;
-
'''Optional tokens (client classes only):''' <code>maxlinks, usermode</code>
+
    <span class="comment">/* sendq: send buffer limit (i.e., the amount of data allowed in
 +
    * a client's queue before they are dropped.
 +
    */</span>
 +
    sendq = 100 kilobytes;
-
'''Optional tokens (server classes only):''' <code>connectfreq</code>
+
    <span class="comment">/* maxlinks: the maximum number of connections that may use this
 +
    * class. May be between 0 and 4,000,000,000.
 +
    */</span>
 +
    maxlinks = <span class="integer">100</span>;
-
For connection classes used on server links, maxlinks should be set to either 0 (for hubs) or 1 (for leafs). Client connection classes may use maxlinks between 0 and approximately 4,000,000,000. A maxlinks of 0 means there is no limit on the number of connections using the class.
+
    <span class="comment">/* usermode: an optional list of user modes that should set
 +
    * upon the user while connecting.
 +
    */</span>
 +
    usermode = <span class="qstring">"+iw"</span>;
-
<connect freq> applies only to servers, and specifies the frequency that the server tries to auto connect. Setting this to 0 will cause the server to attempt to connect repeatedly with no delay until the <maximum links> condition is satisfied. This is a Bad Thing(tm). Time can be specified as a number, or by giving something like: 1 minutes 2 seconds, or 1*60+20.
+
    <span class="comment">/* maxchans: the maximum number of channels that clients may join.
 +
    */</span>
 +
    maxchans = <span class="integer">50</span>;
 +
};
-
For connection classes intended for operator use, you can specify privileges used when the Operator {} block (see below) names this class. The local (aka globally_opered) privilege MUST be defined by either the Class or Operator block. It is highly recommended privileges be specified in the operator's Operator {} block, instead of in Class {} blocks.
+
<strong>Class</strong> {
 +
    name = <span class="qstring">"Opers"</span>;
 +
    pingfreq = 2 minutes;
 +
    sendq = 100 kilobytes;
 +
    maxlinks = <span class="integer">10</span>;
 +
    usermode = <span class="qstring">"+iw"</span>;
 +
    whox;
 +
};
-
A "default" class is created internally. This class is used when no other class is specified, but its settings are not useful for most situations. Custom classes are strongly suggested.
+
<strong>Class</strong> {
 +
    name = <span class="qstring">"Server"</span>;
 +
    pingfreq = 3 minutes;
-
There may be multiple Class {} blocks.
+
    <span class="comment">/* connectfreq: this token applies only to servers, and specifies
 +
    * the frequency that the server tries to auto connect. Setting this to 0 will cause a
 +
    * server to attempt to connect repeatedly, with no delay until the maxlinks condition
 +
    * is satisfied (which is not a good thing).
 +
    */</span>
 +
    connectfreq = 5 minutes;
-
'''Example blocks:'''
+
    <span class="comment">/* maxlinks: for server classes, specifies the maximum number of
 +
    * servers to autoconnect to. This should be 0 for hubs, and 1 for leafs.
 +
    */</span>
 +
    maxlinks = <span class="integer">0</span>;
-
Uplinks you are not a hub for:
+
    sendq = 10 megabytes;
-
<c>Class
+
};
-
{
+
-
  name = "Server";
+
-
  pingfreq = 1 minutes 30 seconds;
+
-
  connectfreq = 5 minutes;
+
-
  maxlinks = 1;
+
-
  sendq = 9000000;
+
-
};</c>
+
-
Leaf servers you hub for:
+
-
<c>Class
+
-
{
+
-
  name = "Leaf Server";
+
-
  pingfreq = 1 minutes 30 seconds;
+
-
  connectfreq = 5 minutes;
+
-
  maxlinks = 0;
+
-
  sendq = 9000000;
+
-
};</c>
+
-
All clients:
+
-
<c>Class
+
-
{
+
-
  name = "Users";
+
-
  pingfreq = 1 minutes 30 seconds;
+
-
  sendq = 60000;
+
-
  usermode = "+iw";
+
-
};</c>
+
-
Opers:
+
-
<c>Class
+
-
{
+
-
  name = "Opers";
+
-
  pingfreq = 1 minutes 30 seconds;
+
-
  sendq = 60000;
+
-
  whox = yes;
+
-
};</c>
+
-
== Client Block ==
+
<strong>Class</strong> {
 +
    name = <span class="qstring">"Leaf_Server"</span>;
 +
    pingfreq = 3 minutes;
 +
    connectfreq = 5 minutes;
 +
    maxlinks = 1;
 +
    sendq = 10 megabytes;
 +
};
 +
</pre></html>
-
{| class="wikitable" width="97%" style="font-size: 97%; text-align: left;"
+
For connection classes intended for operator use, you can specify privileges the operator should be granted when the Operator block names the class. The local privilege MUST be defined by either the Class or Operator block. It is highly recommended that most privileges be explicitly specified in the operator's Operator block on DareNET.
-
| ''Old I:lines''
+
 
 +
A "default" class is created internally. This class is used when no other class is specified, but its settings are not useful for most situations. Custom classes are strongly recommended.
 +
 
 +
There may be multiple Class blocks; at least one is recommended.
 +
 
 +
== Client block ==
 +
 
 +
{| class="simpletable" width="100%"
 +
|width="250px"|Requirement:
 +
|RECOMMENDED
 +
|-
 +
|Old conf format equivalents:
 +
|<code>I:ipmask:passwd:hostmask:port:class</code>
|}
|}
-
To allow clients to connect, they need authorization. This can be done based on hostmask, address mask and/or with a password. With intelligent use of classes and the maxlinks field in the Client {} blocks, you can let in a specific domain, but get rid of all other domains in the same top level, thus setting up some sort of "reverse Kill {} block."
+
The Client blocks define the hosts client connections are allowed from, and places them into classes. While the server will start without a Client block, it will not be usable.
-
<pre>Client  
+
<html><pre><strong>Client</strong> {
-
{
+
    <span class="comment">/* host: resolved user@host mask allowed to connect. This is optional
-
  host = "host";
+
    * if you are using the ip mask to match against. Additionally, if you specify *@loc for
-
  ip = "127.0.0.0/8";
+
    * this field it will match all LOC users.
-
  password = "password";
+
    */</span>
-
  class = "classname";
+
    host = <span class="qstring">"*@*.wirehub.net"</span>;
-
  maxlinks = number;
+
-
};</pre>
+
-
Everything in a Client {} block is optional. If a username mask is specified, it must match the clients username from the IDENT protocol. If a hostmask is given, the client's hostname must resolve and match the hostmask. If a CIDR-style IP mask is given, the client must have an IP matching that range. If maxlinks is given, it limits the number of matching clients allowed from a particular IP address.
+
    <span class="comment">/* ip: unresolved user@ip mask allowed to connect. */</span>
 +
    ip = <span class="qstring">"*@195.86.128.*"</span>;
-
'''Technical Description:'''
+
    <span class="comment">/* password: (optional) password that is required to use this block.
 +
    * This password string is not encrypted.
 +
    */</span>
 +
    password = <span class="qstring">"letMEHin"</span>;
-
For every connectiong client, the IP address is known. A reverse lookup is performed on this IP-number to get the (/all) hostname(s). Each hostname that belongs to this IP-number is matched to <hostmask>, and the Client {} block is used when any matches; the client will then show with this particular hostname. If none of the hostnames match, then the IP-number is matched against the <IP mask ...> field, and if this matches, the Client {} block is used nevertheless and the client will show with the first (main) hostname, if any. If the IP-number does not resolve, then the client will show with the dot notation of the IP-number.
+
    <span class="comment">/* class: the class the user should be placed in. */</span>
 +
    class = <span class="qstring">"Users"</span>;
-
There is a special case for UNIX domain sockets and localhost connections. In these cases, the <IP mask...> field is compared with the name of the server (thus not with any IP-number representation). The name of the server is the one returned in the numeric 002 reply. For example:
+
    <span class="comment">/* maxlinks: if specified, the server will only accept clients when
 +
    * the total number of connections to the network from the same IP number doesn't exceed
 +
    * this number.
 +
    */</span>
 +
    maxlinks = <span class="integer">6</span>;
-
<code>002 Your host is 2.darenet.org[jolan.ppro], running version ...</code>
+
    <span class="comment">/* port: (optional) a port to limit this block to. */</span>
 +
    port = <span class="integer">6660</span>;
 +
};
 +
</pre></html>
-
In this example, "jolan.ppro" is the name used for matching. Therefore, UNIX domain sockets, and connections to localhost, would match this block:
+
The server uses a default deny policy for incoming connections. You need to define at least one Client block if you wish to use your server.
-
<code>host = "*@jolan.ppro";</code>
+
The <code>host</code> and <code>ip</code> fields specify which connections the block matches. The server always performs a DNS and ident lookup for connections. If DNS cannot find a hostname, the IP address is used instead. If ident cannot get a valid reply, "unknown" is used during this state. The client's resolved hostname, IP address, ident reply, and username (from the USER line) are used according to the results of the matches described below.
-
Example blocks:
+
'''Note:''' There is a specify case for UNIX domain sockets and localhost connections. In these cases, the <code>ip / host</code> field is compared with the name of the server, and thus not with any IP number representation. The name of the server is that returned in the numeric 002 reply, example: <code>002 Your host is 2.darenet.org[jolan.ppro]. running version ...</code> In this example, "jolan.ppro" is the name used for matching; therefore, UNIX domain sockets and connections to localhost would match a block containing: <code>host = "*@jolan.ppro";</code>.
-