Support IPv6 blacklists. Also add a conf file option allowing the use of IPv4, IPv6...

[solanum.git] / doc / example.conf

diff --git a/doc/example.conf b/doc/example.conf
index 4587ea27fa1c2362be82e248a16e4c433db25dc7..558d51e52c12e45fe8e0f3ff792f8052f4d42bb1 100755 (executable)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -341,6 +341,7 @@ channel {
        only_ascii_channels = no;
        resv_forcepart = yes;
        channel_target_change = yes;
+       disable_local_channels = no;
 };
 
 serverhide {
@@ -360,7 +361,7 @@ 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
+ * As of charybdis 2.2, you can do some keyword substitution on the rejection
  * reason. The available keyword substitutions are:
  *
  *   ${ip}           - the user's IP
@@ -369,19 +370,32 @@ serverhide {
  *   ${nick}         - the user's nickname
  *   ${network-name} - the name of the network
  *
+ * As of charybdis 3.4, a type parameter is supported, which specifies the
+ * address families the blacklist supports. IPv4 and IPv6 are supported.
+ * IPv4 is currently the default as few blacklists support IPv6 operation
+ * as of this writing.
+ *
  * 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 {
        host = "rbl.efnetrbl.org";
+       type = ipv4;
        reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
 
 #      host = "ircbl.ahbl.org";
+#      type = ipv4;
 #      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";
+#      type = ipv4;
 #      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.";
+#
+       /* Example of a blacklist that supports both IPv4 and IPv6 */
+#      host = "foobl.blacklist.invalid";
+#      type = ipv4, ipv6;
+#      reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for some reason. In order to protect ${network-name} from abuse, we are not allowing connections listed in ${dnsbl-host} to connect";
 };
 
 alias "NickServ" {