[svn] Clarify format of IPv6 addresses in auth{} and connect{}.

[irc/rqf/shadowircd.git] / doc / example.conf

diff --git a/doc/example.conf b/doc/example.conf
index 25d5979606a9e5d0feff51c18b8eb8fb789665b2..d68311da46448ba2cb0e310b1bee4053eb064e7a 100755 (executable)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -4,7 +4,7 @@
  * Copyright (C) 2002-2005 ircd-ratbox development team
  * Copyright (C) 2005-2006 charybdis development team
  *
- * $Id: example.conf 3159 2007-01-25 07:08:21Z nenolod $
+ * $Id: example.conf 3562 2007-08-29 22:04:45Z jilles $
  *
  * See reference.conf for more information.
  */
@@ -26,10 +26,10 @@
 #loadmodule "extensions/sno_farconnect.so";
 #loadmodule "extensions/sno_globalkline.so";
 #loadmodule "extensions/sno_globaloper.so";
+#loadmodule "extensions/sno_whois.so";
 
 serverinfo {
        name = "hades.arpa";
-       use_ts6 = yes;
        sid = "42X";
        description = "charybdis test server";
        network_name = "AthemeNET";
@@ -42,6 +42,13 @@ serverinfo {
        #vhost = "192.169.0.1";
        /* for IPv6 */
        #vhost6 = "3ffe:80e8:546::2";
+
+       /* max_clients: This should be set to the maximum amount of clients
+        * that the server should support. Note that you should leave some
+        * file descriptors free for log files, server connections, ident
+        * lookups (if enabled), exceed_limit clients, etc.
+        */
+       max_clients = 1024;
 };
 
 admin {
@@ -109,8 +116,11 @@ listen {
  * then general access, then restricted.
  */
 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:*";
@@ -235,7 +245,8 @@ connect "irc.uplink.com" {
        class = "server";
        flags = compressed, topicburst;
 
-       /* If the connection is IPv6, uncomment below */
+       /* If the connection is IPv6, uncomment below.
+        * Use 0::1, not ::1, for IPv6 localhost. */
        #aftype = ipv6;
 };
 
@@ -253,7 +264,7 @@ shared {
        flags = all, rehash;
 };
 
-/* exempt {}: IPs that are exempt from Dlines. (OLD d:) */
+/* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 exempt {
        ip = "127.0.0.1";
 };
@@ -263,7 +274,6 @@ channel {
        use_except = yes;
        use_knock = yes;
        use_forward = yes;
-       invite_ops_only = yes;
        knock_delay = 5 minutes;
        knock_delay_channel = 1 minute;
        max_chans_per_user = 15;
@@ -294,7 +304,7 @@ serverhide {
  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
  * connections.
  *
- * As of charybdis 2.2, you can do some keyword substitution on the rejection
+ * As of charybdis 2.1.3, you can do some keyword substitution on the rejection
  * reason. The available keyword substitutions are:
  *
  *   ${ip}           - the user's IP
@@ -303,17 +313,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 "NickServ" {
        target = "NickServ";
@@ -423,6 +436,7 @@ general {
        reject_ban_time = 1 minute;
        reject_after_count = 3;
        reject_duration = 5 minutes;
+       max_unknown_ip = 2;
 };
 
 modules {