DareNET IRCd Configuration/1.5

Current revision as of 18:00, 17 June 2013

This is a reference guide for ircd-darenet 1.5.x's configuration file.

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.

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.

A sample block:

blockname {
    name = value;
    name = "string";
    name = 123;
    tag;
};

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:

/* C style single/multi-line */

// C++ style single-line

# Shell style single-line

General block

The General block defines information about the server itself. It is required for the server to start.

General {
    /* name: the name of our server. */
    name = "test.area.zone.darenet.org";

    /* description: the description of our server. */
    description = "ircd-darenet test server";

    /* numeric: the unique server numeric for our server. It must be a
     * digit between 0 and 4095, and is not updated on a rehash.
     */
    numeric = 999;

    /* 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. 
     */
    vhost = "192.169.0.1";

    /* ssl_private_key: our ssl private key. */
    ssl_private_key = "etc/ircd.key";

    /* ssl_pem: file containing our ssl certificate and private key */
    ssl_pem = "etc/ircd.pem";

    /* dpass: (optional) password for DIE command. */
    dpass = "encrypted pass";

    /* rpass: (optional) password for RESTART command. */
    rpass = "$PLAIN$password";  
};

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.

There must be exactly one General block.

Admin block

The Admin block defines information that can be retrieved with the /ADMIN command.

Admin {
    location = "DareNET - http://www.darenet.org";
    location = "Infrastructure Team";
    contact = "<infrastructure@darenet.org>";
};

Not all lines are required. There may only be one Admin block.

Class block

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.

Class {
    /* name: a name for the connection class. */
    name = "Users";

    /* pingfreq: how often to PING idle connections. */
    pingfreq = 1 minute 30 seconds;

    /* sendq: send buffer limit (i.e., the amount of data allowed in
     * a client's queue before they are dropped.
     */
    sendq = 100 kilobytes;

    /* maxlinks: the maximum number of connections that may use this
     * class. May be between 0 and 4,000,000,000.
     */
    maxlinks = 100;

    /* usermode: an optional list of user modes that should set
     * upon the user while connecting.
     */
    usermode = "+iw"; 

    /* maxchans: the maximum number of channels that clients may join.
    */
    maxchans = 50;
};

Class {
    name = "Opers";
    pingfreq = 2 minutes;
    sendq = 100 kilobytes;
    maxlinks = 10;
    usermode = "+iw";
    whox;
};

Class {
    name = "Server";
    pingfreq = 3 minutes;

    /* 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).
     */
    connectfreq = 5 minutes;

    /* maxlinks: for server classes, specifies the maximum number of
     * servers to autoconnect to. This should be 0 for hubs, and 1 for leafs.
     */
    maxlinks = 0;

    sendq = 10 megabytes;
};

Class {
    name = "Leaf_Server";
    pingfreq = 3 minutes;
    connectfreq = 5 minutes;
    maxlinks = 1;
    sendq = 10 megabytes;
};

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.

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

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.

Client {
    /* host: resolved user@host mask allowed to connect. This is optional
     * if you are using the ip mask to match against.  Additionally, if you specify *@loc for 
     * this field it will match all LOC users.
     */
    host = "*@*.wirehub.net";

    /* ip: unresolved user@ip mask allowed to connect. */
    ip = "*@195.86.128.*";

    /* password: (optional) password that is required to use this block.
     * This password string is not encrypted.
     */
    password = "letMEHin";

    /* class: the class the user should be placed in. */
    class = "Users";

    /* 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.
     */
    maxlinks = 6;

    /* port: (optional) a port to limit this block to. */
    port = 6660;
};

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.

The host and ip 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.

Note: There is a specify case for UNIX domain sockets and localhost connections. In these cases, the ip / host 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: 002 Your host is 2.darenet.org[jolan.ppro]. running version ... In this example, "jolan.ppro" is the name used for matching; therefore, UNIX domain sockets and connections to localhost would match a block containing: host = "*@jolan.ppro";.

The host field attempts to match first against the resolved hostname, if available, and then against the IP address. To include the connection's ident reply in the match, use a mask in the form "ident@host". If a client matches, it appears on IRC using its resolved hostname.

The ip field attempts to match against the IP address only. An ident may be specified to match against, as well.

Note: If the ident portion is specified in a mask (i.e., "ident@host" instead of "host"), and no ident reply is received from the client, it will appear on IRC with its username prefixed with a '~' tilde. If the matching mask used only the "host" form, the client's username is not prefixed. If a valid ident reply is received, it is always used and not prefixed.

You need only specify a host or ip field, not both. If both are used, host is matched against first.

There may be multiple Client blocks; at least one is recommended.

Motd block