[svn] - add config option for setting max_clients.

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

diff --git a/doc/example.conf b/doc/example.conf
index a0576c58bbba57519b2219eb882e4ef4342cc7e5..dd10abdbed05c35e955e1101724b83470a5671d8 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 3131 2007-01-21 15:36:31Z jilles $
+ * $Id: example.conf 3251 2007-03-05 18:58:38Z nenolod $
  *
  * See reference.conf for more information.
  */
@@ -42,6 +42,11 @@ serverinfo {
        #vhost = "192.169.0.1";
        /* for IPv6 */
        #vhost6 = "3ffe:80e8:546::2";
+
+       /* max_clients: This should be set to the amount of connections
+        * the server can handle.
+        */
+       max_clients = 1024;
 };
 
 admin {
@@ -286,7 +291,7 @@ serverhide {
 
 /* These are the blacklist settings.
  * You can have multiple combinations of host and rejection reasons.
- * They are used in pairs of one host/rejection reason.
+ * They are used in pairs of one host/rejection reason, or multiple hosts/rejection reason.
  *
  * These settings should be adequate for most networks, and are (presently)
  * required for use on AthemeNet.
@@ -294,16 +299,25 @@ serverhide {
  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
  * connections.
  *
+ * 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
+ *   ${host}         - the user's canonical hostname
+ *   ${dnsbl-host}   - the dnsbl hostname the lookup was done against
+ *   ${nick}         - the user's nickname
+ *   ${network-name} - the name of the network
+ *
  * Note: AHBL (the providers of the below 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 {
 #      host = "ircbl.ahbl.org";
-#      reject_reason = "You have a host listed in the ircbl.ahbl.org blacklist.";
+#      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 = "You are connecting from a TOR exit node.";
+#      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" {