]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Whoops, remote users not being counted in map, fix
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 6b89a49b832da38b36751dd455c8ab201afec057..c925971d5a75a8aa171940beec8614b7d587691e 100644 (file)
 #                  nick!user@host is shown for who set a TOPIC last.  #
 #                  if set to no, then only the nickname is shown.     #
 #                                                                     #
-#  quietbursts   - When synching or splitting from the network, a     #
-#                  server can generate a lot of connect and quit      #
-#                  snotices to the +C and +Q snomasks. Setting this   #
-#                  value to yes squelches those messages, which can   #
-#                  make them more useful for opers, however it will   #
-#                  degrade their use by certain third party programs  #
-#                  such as BOPM which rely on them to scan users when #
-#                  a split heals in certain configurations.           #
-#                                                                     #
 #  serverpingfreq- This value, when set, allows you to change the     #
 #                  frequency of server to server PING messages. This  #
 #                  can help if you are having certain network issues. #
 #                  be up to 5 (ugh) while others such as FreeBSD will #
 #                  default to a much nicer 128.                       #
 #                                                                     #
-#  moduledir     - This optional value indicates a runtime change of  #
-#                  the location where modules are to be found. This   #
-#                  does not add a supplementary directory. There can  #
-#                  only be one module path.                           #
-#                                                                     #
 #  softlimit     - This optional feature allows a defined softlimit.  #
 #                  if defined sets a soft maxconnections value, has   #
 #                  to be less than the ./configure maxclients         #
 #                  will be performed for connecting users. This can   #
 #                  save a lot of resources on very busy IRC servers.  #
 #                                                                     #
+#  quietbursts   - When synching or splitting from the network, a     #
+#                  server can generate a lot of connect and quit      #
+#                  snotices to the +C and +Q snomasks. Setting this   #
+#                  value to yes squelches those messages, which can   #
+#                  make them more useful for opers, however it will   #
+#                  degrade their use by certain third party programs  #
+#                  such as BOPM which rely on them to scan users when #
+#                  a split heals in certain configurations.           #
+#                                                                     #
 #  netbuffersize - Size of the buffer used to receive data from       #
 #                  clients. The ircd may only read() this amount      #
 #                  of text in one go at any time. (OPTIONAL)          #
           operspywhois="no"
           userstats="Pu">
 
+#-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# This configuration tag defines the maximum sizes of various types   #
+# on IRC, such as the maximum length of a channel name, and the       #
+# maximum length of a channel. Note that with the exception of the    #
+# identmax value all values given here are the exact values you would #
+# expect to see on IRC. This contrasts with the older InspIRCd        #
+# releases where these values would be one character shorter than     #
+# defined to account for a null terminator on the end of the text.    #
+#                                                                     #
+# The identmax value has special meaning, as it may grow one          #
+# character longer than you specify, to accomodate for a ~ character  #
+# when m_ident is loaded.                                             #
+#                                                                     #
+# These values should match network-wide, otherwise you may end up    #
+# with desyncs, and confusing your users by being able to use a nick  #
+# of a certain length on one server but not on another. Servers will  #
+# link with mismatched values, but this is NOT recommended as a long  #
+# term measure!                                                       #
+#                                                                     #
+# Values here should be self explanitory:                             #
+#                                                                     #
+# maxnick         - The maximum length of a nickname                  #
+# maxchan         - The maximum length of a channel name              #
+# maxmodes        - The maximum number of parameterized mode changes  #
+#                   per line                                          #
+# maxident        - The maximum length of an ident/username value     #
+# maxquit         - The maximum length of a quit message              #
+# maxtopic        - The maximum length of a channel topic             #
+# maxkick         - The maximum length of a kick message              #
+# maxgecos        - The maximum length of a GECOS (real name)         #
+# maxaway         - The maximum length of an away message             #
+#                                                                     #
+
+<limits maxnick="31"
+        maxchan="64"
+        maxmodes="20"
+        maxident="11"
+        maxquit="255"
+        maxtopic="307"
+        maxkick="255"
+        maxgecos="128"
+        maxaway="200">
+
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Logging
 # -------
 # Channel cycle module. Server side /hop, with +ilk etc bypass.
 #<module name="m_cycle.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Connectban: Provides per-IP connection throttling. Any IP that disconnects
+# too many times (configurable) in an hour is zlined for a (configurable)
+# duration, and their count resets to 0.
+#
+# NOTE: This module may change name/behaviour later in 1.2. Please make sure
+# you read release announcements!
+#
+#<connectban threshold="10" duration="10m">
+# This allows for 10 quits in an hour with a 10 minute ban if that is exceeded.
+#
+#<module name="m_connectbanban.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Connection throttle module. Configuration:
 #<module name="m_connflood.so">
 # HTTP server.
 #
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# http ACL module: Provides access control lists for m_httpd dependent
+# modules. Use this module to restrict pages by IP address and by
+# password.
+#
+#<module name="m_httpd_acl.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+#
+# Restrict access to the m_httpd_stats module to all but the local
+# network and when the correct password is specified:
+#
+# <httpdacl path="/stats*" types="password,whitelist"
+#    username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
+# 
+# Deny all connections to all but the main index page:
+#
+# <httpdacl path="/*" types="blacklist" blacklist="*">
+#
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # http stats module: Provides basic stats pages over HTTP
 # Requires m_httpd.so to be loaded for it to function.
 #                    might be set, even bans. Use "yes" or "no".      #
 #                                                                     #
 #<operjoin channel="#channel" override="no">
+#
+# Alternatively you can use the autojoin="channellist" in a <type>    #
+# tag to set specific autojoins for a type of oper, for example:      #
+#
+#<type name="Helper" autojoin="#help" classes="...">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper MOTD module: Provides support for seperate message of the day
 #<module name="m_quietban.so">
 #
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Quitban: Provides per-IP connection throttling. Any IP that disconnects
-# too many times (configurable) in an hour is zlined for a (configurable)
-# duration, and their count resets to 0.
-#
-# NOTE: This module may change name/behaviour later in 1.2. Please make sure
-# you read release announcements!
-#
-#<quitban threshold="10" duration="10m">
-# This allows for 10 quits in an hour with a 10 minute ban if that is exceeded.
-#
-#<module name="m_quitban.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Random Quote module: provides a random quote on connect.
 # NOTE: Some of these may mimic fatal errors and confuse users and