]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Add HTTP auth
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 36e3b9c99526340dcfceb6ca1f3736edf5f3d403..f2287ab7e6a989983dcaee29225e530f0485b02b 100644 (file)
 #                  especially in the case of bots, and it is          #
 #                  recommended that this option is enabled.           #
 #                                                                     #
-#  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)          #
-#                                                                     #
-#  maxwho        - The maximum number of results returned by a /WHO   #
-#                  query. This is to prevent /WHO being used as a     #
-#                  spam vector or means of flooding an ircd. The      #
-#                  default is 128, it is not recommended to raise it  #
-#                  above 1024. Values up to 65535 are permitted. If   #
-#                  this value is omitted, any size WHO is allowed by  #
-#                  anyone.                                            #
-#                                                                     #
-#  somaxconn     - The maximum number of sockets that may be waiting  #
-#                  in the accept queue. This usually allows the ircd  #
-#                  to soak up more connections in a shorter space of  #
-#                  time when increased but please be aware there is a #
-#                  system defined maximum value to this, the same way #
-#                  there is a system defined maximum number of file   #
-#                  descriptors. Some systems may only allow this to   #
-#                  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         #
-#                                                                     #
-#  nouserdns     - If set to yes, true or 1, no user DNS lookups      #
-#                  will be performed for connecting users. This can   #
-#                  save a lot of resources on very busy IRC servers.  #
-#                                                                     #
 #  syntaxhints   - If set to yes, true or 1, when a user does not     #
 #                  give enough parameters for a command, a syntax     #
 #                  hint will be given (using the RPL_TEXT numeric)    #
 #                  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. #
          suffixquit=""
          prefixpart="\""
          suffixpart="\""
-         netbuffersize="10240"
-         maxwho="128"
          noservices="no"
          qprefix="~"
          aprefix="&"
          deprotectself="no"
          deprotectothers="no"
-         somaxconn="128"
-         softlimit="12800"
-         nouserdns="no"
          syntaxhints="no"
          cyclehosts="yes"
          ircumsgprefix="no"
          announcets="yes"
          hostintopic="yes"
-         quietbursts="yes"
          pingwarning="15"
          serverpingfreq="60"
          allowhalfop="yes"
          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
          exemptchanops="">
 
+
+#-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+#  maxwho        - The maximum number of results returned by a /WHO   #
+#                  query. This is to prevent /WHO being used as a     #
+#                  spam vector or means of flooding an ircd. The      #
+#                  default is 128, it is not recommended to raise it  #
+#                  above 1024. Values up to 65535 are permitted. If   #
+#                  this value is omitted, any size WHO is allowed by  #
+#                  anyone.                                            #
+#                                                                     #
+#  somaxconn     - The maximum number of sockets that may be waiting  #
+#                  in the accept queue. This usually allows the ircd  #
+#                  to soak up more connections in a shorter space of  #
+#                  time when increased but please be aware there is a #
+#                  system defined maximum value to this, the same way #
+#                  there is a system defined maximum number of file   #
+#                  descriptors. Some systems may only allow this to   #
+#                  be up to 5 (ugh) while others such as FreeBSD will #
+#                  default to a much nicer 128.                       #
+#                                                                     #
+#  softlimit     - This optional feature allows a defined softlimit.  #
+#                  if defined sets a soft maxconnections value, has   #
+#                  to be less than the ./configure maxclients         #
+#                                                                     #
+#  nouserdns     - If set to yes, true or 1, no user DNS lookups      #
+#                  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)          #
+#                                                                     #
+
+<performance netbuffersize="10240"
+             maxwho="128"
+             somaxconn="128"
+             softlimit="12800"
+             quietbursts="yes"
+             nouserdns="no">
+
 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # announceinvites                                                     #
 # 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.
 #<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