]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - conf/inspircd.conf.example
Move autoconnect next-server to TreeSocket::cull, and drop autoconnect reference...
[user/henk/code/inspircd.git] / conf / inspircd.conf.example
index b207597650a7239437924a5266e4c5f3c7c66f64..0b860bb815dcec6573f98ae51e74e0050ee3d710 100644 (file)
          # send /nick, /user or /pass)
          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
-         # before they are dropped.
-         sendq="262144"
-
-         # recvq: amount of data 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
          # 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)
          # 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
-         # before they are dropped.
-         sendq="262144"
+         # hardsendq: maximum amount of data allowed in a client's send queue
+         # before they are dropped. Keep this value higher than the length of
+         # your network's /LIST or /WHO output, or you will have lots of
+         # disconnects from sendq overruns!
+         hardsendq="1048576"
 
-         # recvq: amount of data allowed in a clients queue before they are dropped.
+         # softsendq: amount of data in a client's send queue before the server
+         # begins delaying their commands
+         softsendq="8192"
+
+         # recvq: amount of data allowed in a client's queue before they are dropped.
          recvq="8192"
 
          # localmax: Maximum local connections per IP.
          # 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">
 
 
 # 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
        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 -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
      # 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.
          # should be suffixed with.
          suffixpart="\""
 
+         # fixedquit: Set all users' quit messages to this value.
+         #fixedquit=""
+
+         # fixedpart: Set all users' part messages in all channels
+         # to this value.
+         #fixedpart=""
+
          # syntaxhints: If enabled, if a user fails to send the correct parameters
          # for a command, the ircd will give back some help text of what
          # the correct parameters are.
          # 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"
 
+         # allowmismatched: Setting this option to yes will allow servers to link even
+        # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to
+        # yes may introduce some desyncs and weirdness.
+        allowmismatched="no"
+
          # 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,
              netbuffersize="10240"
 
              # maxwho: Maximum number of results to show in a /who query.
-             # It is not recommended to set this above 1024.
-             maxwho="128"
+             maxwho="4096"
 
              # somaxconn: The maximum number of connections that may be waiting
              # in the accept queue. This is *NOT* the total maximum number of
 # 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.