]> jfr.im git - irc/rqf/shadowircd.git/blobdiff - doc/reference.conf
Branch merge.
[irc/rqf/shadowircd.git] / doc / reference.conf
index d5a4f59ece456c9b30e01a8e8817ce15ea38c2d0..e1a6e6fdd6e31fb9ab7afc6ae57fd11f0a407168 100755 (executable)
@@ -6,7 +6,7 @@
  *
  * Written by ejb, wcampbel, db, leeh and others
  *
- * $Id: reference.conf 3251 2007-03-05 18:58:38Z nenolod $
+ * $Id: reference.conf 3582 2007-11-17 21:55:48Z jilles $
  */
 
 /* IMPORTANT NOTES:
@@ -57,6 +57,7 @@
  * Far connection notices (snomask +F)            -- sno_farconnect.so
  * Remote k/d/g/x line active notices             -- sno_globalkline.so
  * Remote oper up notices                         -- sno_globaloper.so
+ * /whois notifications (snomask +W)              -- sno_whois.so
  */
 #loadmodule "extensions/createauthonly.so";
 #loadmodule "extensions/extb_account.so";
 #loadmodule "extensions/sno_farconnect.so";
 #loadmodule "extensions/sno_globalkline.so";
 #loadmodule "extensions/sno_globaloper.so";
+#loadmodule "extensions/sno_whois.so";
  
 /* serverinfo {}:  Contains information about the server. (OLD M:) */
 serverinfo {
        /* name: the name of our server */
        name = "hades.arpa";
 
-       /* use ts6: whether we want to use the TS6 protocol to other servers
-        * or not.
-        */
-       use_ts6 = yes;
-
        /* sid: the unique server id of our server.  This must be three
         * characters long.  The first character must be a digit [0-9], the
         * remaining two chars may be letters [A-Z] or digits [0-9].
         *
-        * This must be specified even if use_ts6 is set to no.
+        * This parameter must be specified for the server to start.
         */
        sid = "42X";
 
@@ -119,10 +116,12 @@ serverinfo {
         */
        #vhost6 = "3ffe:80e8:546::2";
 
-       /* max_clients: this should be set to the maximum amount of clients
-        * that the server should support.
+       /* default max clients: the default maximum number of clients\r
+        * allowed to connect.  This can be changed once ircd has started by\r
+        * issuing:\r
+        *   /quote set maxclients <limit>\r
         */
-       max_clients = 1024;
+       default_max_clients = 1024;
 };
 
 /* admin {}: contains admin information about the server. (OLD A:) */
@@ -262,8 +261,11 @@ listen {
 
 /* auth {}: allow users to connect to the ircd (OLD I:) */
 auth {
-       /* user: the user@host allowed to connect.  multiple IPv4/IPv6 user 
-        * lines are permitted per auth block.
+       /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
+        * lines are permitted per auth block.  This is matched against the
+        * hostname and IP address (using :: shortening for IPv6 and
+        * prepending a 0 if it starts with a colon) and can also use CIDR
+        * masks.
         */
        user = "*@172.16.0.0/12";
        user = "*test@123D:B567:*";
@@ -376,11 +378,11 @@ operator "god" {
         * global_kill:  allows local and remote users to be 
         *               /KILL'd                           (OLD 'O' flag)
         * remote:       allows remote SQUIT and CONNECT   (OLD 'R' flag)
-        * kline:        allows KILL, KLINE and DLINE      (OLD 'K' flag)
+        * kline:        allows KLINE and DLINE            (OLD 'K' flag)
         * unkline:      allows UNKLINE and UNDLINE        (OLD 'U' flag)
         * gline:        allows GLINE                      (OLD 'G' flag)
         * nick_changes: allows oper to see nickchanges    (OLD 'N' flag)
-        *               via usermode +n
+        *               via snomask +n
         * rehash:       allows oper to REHASH config      (OLD 'H' flag)
         * die:          allows DIE and RESTART            (OLD 'D' flag)
         * admin:        gives admin privileges.  admins
@@ -390,11 +392,13 @@ operator "god" {
         *               will not have the admin lines in
         *               stats p and whois.
         * xline:        allows use of /quote xline/unxline
-        * operwall:     allows the oper to send operwalls [DEFAULT]
+        * resv:         allows /quote resv/unresv and cmode +LP [DEFAULT]
+        * operwall:     allows the oper to send/receive operwalls [DEFAULT]
         * oper_spy:     allows 'operspy' features to see through +s
         *               channels etc. see /quote help operspy
         * hidden_oper:  hides the oper from /stats p    (OLD UMODE +p) 
         * remoteban:    allows remote kline etc [DEFAULT]
+        * mass_notice:  allows sending wallops and mass notices [DEFAULT]
          */
        flags = global_kill, remote, kline, unkline, gline,
                die, rehash, admin, xline, operwall;
@@ -446,6 +450,10 @@ connect "irc.uplink.com" {
 };
 
 connect "ipv6.some.server" {
+       /* Hosts that are IPv6 addresses must be in :: shortened form
+        * if applicable.  Addresses starting with a colon get an extra
+        * zero prepended, for example: 0::1
+        */
         host = "3ffd:dead:beef::1";
         send_password = "password";
         accept_password = "password";
@@ -553,7 +561,7 @@ shared {
        flags = tkline;
 };
 
-/* exempt {}: IPs that are exempt from Dlines. (OLD d:) */
+/* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 exempt {
        ip = "192.168.0.0/16";
 
@@ -585,11 +593,6 @@ channel {
         */
        use_knock = yes;
 
-       /* invite ops only: Restrict /invite to ops on channels, rather than
-        * allowing unopped users to invite people to a -i channel.
-        */
-       invite_ops_only = yes;
-
        /* knock delay: The amount of time a user must wait between issuing
         * the knock command.
         */
@@ -657,18 +660,19 @@ channel {
 
 /* The serverhide block contains the options regarding serverhiding */
 serverhide {
-       /* flatten links: this option will show all servers in /links appear
-        * that they are linked to this current server
+       /* flatten links: this option will hide various routing information
+        * and make all servers in /links appear that they are linked to
+        * this server.
         */
        flatten_links = no;
 
-       /* links delay: how often to update the links file when it is
-        * flattened.
+       /* links delay: how long to wait before showing splits or new
+        * servers in a flattened /links output.
         */
        links_delay = 5 minutes;
 
-       /* hidden: hide this server from a /links output on servers that
-        * support it.  this allows hub servers to be hidden etc.
+       /* hidden: hide this server from a /links output on servers with
+        * flatten_links enabled.  this allows hub servers to be hidden etc.
         */
         hidden = no;
 
@@ -697,17 +701,20 @@ serverhide {
  *   ${nick}         - the user's nickname
  *   ${network-name} - the name of the network
  *
- * Note: AHBL (the providers of the below BLs) request that they be
+ * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
  * contacted, via email, at admins@2mbit.com before using these BLs.
  * See <http://www.ahbl.org/services.php> for more information.
  */
-#blacklist {
+blacklist {
+       host = "dnsbl.dronebl.org";
+       reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
+
 #      host = "ircbl.ahbl.org";
 #      reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for having an open proxy. In order to protect ${network-name} from abuse, we are not allowing connections with open proxies to connect.";
 #
 #      host = "tor.ahbl.org";
 #      reject_reason = "${nick}, your IP (${ip}) is listed as a TOR exit node. In order to protect ${network-name} from tor-based abuse, we are not allowing TOR exit nodes to connect to our network.";
-#};
+};
 
 /*
  * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
@@ -758,11 +765,13 @@ alias "MS" {
  */
 general {
        /* hide error messages: defines whether error messages from
-        * servers are hidden or not.  These can sometimes contain IPs and
-        * can have an adverse effect on server ip hiding.  Set to:
+        * servers that are not deemed fully safe are hidden or not.
+        * These can sometimes contain IPs and can have an adverse
+        * effect on server ip hiding.  Set to:
         *   yes:   hide from opers and admin
         *   opers: hide from opers only
         *   no:    do not hide error messages
+        * Admins on other servers count as opers.
         */
        hide_error_messages = opers;
 
@@ -827,12 +836,6 @@ general {
         */
        dots_in_ident=2;
 
-       /* dot in ipv6: ircd-hybrid-6.0 and earlier will disallow hosts 
-        * without a '.' in them.  this will add one to the end.  only needed
-        * for older servers.
-        */
-        dot_in_ip6_addr = no;
-        
         /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
         * placed via the server.  klines hand placed are exempt from limits.
         * wildcard chars: '.' '*' '?' '@'
@@ -1023,11 +1026,6 @@ general {
         */
        gline_min_cidr = 16;
 
-       /* idletime: the maximum amount of time a user may idle before
-        * they are disconnected
-        */
-        idletime = 0;
-
        /* REMOVE ME.  The following line checks you've been reading. */
        havent_read_conf = yes;
        
@@ -1122,6 +1120,11 @@ general {
 
        /* reject duration: the amount of time to cache the rejection */
        reject_duration = 5 minutes;
+
+       /* max_unknown_ip: maximum number of pending connections to the server
+         * that are allowed per IP address
+        */
+       max_unknown_ip = 2;
 };
 
 modules {