X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=conf%2Finspircd.conf.example;h=fba35bd86c7c09bb5b281248188e7aafefc1860b;hb=c64333e02a4449616683e672739526f4cc762101;hp=fa43280227cc667fa516acf62353493f0a67c551;hpb=76d29d4d591e35d2451e5c4f2260bd1f6d94e7c9;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/conf/inspircd.conf.example b/conf/inspircd.conf.example
index fa4328022..fba35bd86 100644
--- a/conf/inspircd.conf.example
+++ b/conf/inspircd.conf.example
@@ -207,6 +207,16 @@
 <connect deny="3ffe::0/32">
 
 <connect
+         # name: Name to use for this connect block. Mainly used for
+         # connect class inheriting.
+         name="secret"
+
+         # parent: This setting is to specify if this connect class
+         # inherits settings from any other. Put the other class's name
+         # in here to use its settings as a template - for example,  if
+         # you only want to adjust sendq and a password
+         parent="main"
+
          # allow: What IP addresses/hosts to allow for this block.
          allow="196.12.*"
 
@@ -229,25 +239,25 @@
          # disconnecting a user if they do not do anything on connect.
          # (Note, this is a client-side thing, if the client does not
          # send /nick, /user or /pass)
-         timeout="60"
+         timeout="10"
 
          # pingfreq: How often (in seconds) the server tries to ping connecting clients.
          pingfreq="120"
 
-         # sendq: Amount of data that the server is allowed to send to the user
+         # sendq: Amount of data (in bytes) that the server is allowed to send to the user
          # before they are dropped.
          sendq="262144"
 
-         # recvq: amount of data allowed in a clients queue before they are dropped.
+         # recvq: Amount of data (in bytes) allowed in a clients queue before they are dropped.
          recvq="8192"
 
-         # localmax: Maximum local connections per IP.
+         # localmax: Maximum local connections per IP (or CIDR mask, see below).
          localmax="3"
 
-         # globalmax: Maximum global (network-wide) connections per IP.
+         # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
          globalmax="3"
 
-         # useident: Defines if users in this class must respond to a ident query or not.
+         # useident: Defines if users in this class MUST respond to a ident query or not.
          useident="no"
 
          # limit: How many users are allowed in this class
@@ -256,6 +266,8 @@
          # modes: Usermodes that are set on users in this block on connect.
          # Enabling this option requires that the m_conn_umodes module be loaded.
          # This entry is highly recommended to use for/with IP Cloaking/masking.
+         # For the example to work, this also requires that the m_cloaking
+         # module be loaded as well.
          modes="+x"
 
          # port: What port this user is allowed to connect on. (optional)
@@ -263,6 +275,10 @@
          port="6667">
 
 <connect
+         # name: Name to use for this connect block. Mainly used for
+         # connect class inheriting.
+         name="main"
+
          # allow: What IP addresses/hosts to allow for this block.
          allow="*"
 
@@ -274,7 +290,7 @@
          # disconnecting a user if they do not do anything on connect.
          # (Note, this is a client-side thing, if the client does not
          # send /nick, /user or /pass)
-         timeout="60"
+         timeout="10"
 
          # pingfreq: How often (in seconds) the server tries to ping connecting clients.
          pingfreq="120"
@@ -301,6 +317,8 @@
          # modes: Usermodes that are set on users in this block on connect.
          # Enabling this option requires that the m_conn_umodes module be loaded.
          # This entry is highly recommended to use for/with IP Cloaking/masking.
+         # For the example to work, this also requires that the m_cloaking
+         # module be loaded as well.
          modes="+x">
 
 
@@ -310,7 +328,9 @@
 # throttle limits across a CIDR range. (A CIDR range is a group of    #
 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be   #
 # represented as 192.168.1.0/24). This means that abuse across an ISP #
-# is detected and curtailed much easier.                              #
+# is detected and curtailed much easier. Here is a good chart that    #
+# shows how many IPs the different CIDRs correspond to:               #
+# http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation                #
 #                                                                     #
 
 <cidr
@@ -342,6 +362,7 @@
        motd="inspircd.motd.example"
 
        # rules: Path to your rules file. Path is relative to the conf directory.
+       # This is optional and is displayed when a user does /rules on the network.
        rules="inspircd.rules.example">
 
 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -360,7 +381,13 @@
 
 <dns
      # server: DNS server to use to attempt to resolve IP's to hostnames.
-     server="127.0.0.1"
+     # in most cases, you won't need to change this, as inspircd will
+     # automatically detect the nameserver depending on /etc/resolv.conf
+     # (or, on windows, your set nameservers in the registry.)
+     # Note that this must be an IP address and not a hostname, because
+     # there is no resolver to resolve the name until this is defined!
+     #
+     # server="127.0.0.1"
 
      # timeout: seconds to wait to try to resolve DNS/hostname.
      timeout="5">
@@ -459,12 +486,12 @@
          # it will just message the user normally.
          ircumsgprefix="no"
 
-         # announcets: If set to yes, when the TS on a channel changes, all users
+         # announcets: If set to yes, when the TimeStamp on a channel changes, all users
          # in channel will be sent a NOTICE about it.
          announcets="yes"
 
          # hostintopic: If enabled, channels will show the host of the topicsetter
-         # in the topic.
+         # in the topic. If set to no, it will only show the nick of the topicsetter.
          hostintopic="yes"
 
          # pingwarning: If a server does not respond to a ping within x seconds,
@@ -624,6 +651,10 @@
 # defined to account for a null terminator on the end of the text.    #
 #                                                                     #
 # These values should match network-wide otherwise issues will occur. #
+#                                                                     #
+# The highest safe value you can set any of these options to is 500,  #
+# but it is recommended that you keep them somewhat                   #
+# near their defaults (or lower).                                     #
 
 <limits
         # maxnick: Maximum length of a nickname.