]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Add support for blacklists and whitelists, just http password auth to go (the most...
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 8877bfe9098da7a0e5c34558591dd0ff6851bee6..66abfb9555fea3b2a3df9054240145434080c434 100644 (file)
 #                  parts. If specified, overrides both prefixpart     #
 #                  and suffixpart options.                            #
 #                                                                     #
-#  loglevel      - Specifies what detail of messages to log in the    #
-#                  log file. You may select from debug, verbose,      #
-#                  default, sparse and none.                          #
-#                                                                     #
 #  allowhalfop   - Allows the +h channel mode                         #
 #                                                                     #
 #  noservices    - If noservices is true, yes, or 1, then the first   #
 #                  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)          #
+#  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.                           #
+#                                                                     #
+#  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)    #
+#                  as well as the standard ERR_NEEDMOREPARAMS.        #
+#                                                                     #
+#  announcets    - If this value is defined to yes, true, or 1, then  #
+#                  a channels' timestamp is updated, the users on     #
+#                  the channel will be informed of the change via     #
+#                  a server notice to the channel with the old and    #
+#                  new TS values in the timestamp. If you think this  #
+#                  is just pointless noise, define the value to 0.    #
+#                                                                     #
+#  ircumsgprefix - Use undernet style message prefix for channel      #
+#                  NOTICE and PRIVMSG adding the prefix to the line   #
+#                  of text sent out. Eg. NOTICE @#test :@ testing     #
+#                  vs. the off setting: NOTICE @#test :testing        #
+#                                                                     #
+#  hostintopic   - If this is set to yes (the default) then the full  #
+#                  nick!user@host is shown for who set a TOPIC last.  #
+#                  if set to no, then only the nickname is shown.     #
+#                                                                     #
+#  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. #
+#                                                                     #
+#  pingwarning   - This should be set to a number between 1 and 59 if #
+#                  defined, and if it is defined will cause the server#
+#                  to send out a warning via snomask +l if a server   #
+#                  does not answer to PING after this many seconds.   #
+#                  This can be useful for finding servers which are   #
+#                  at risk of pinging out due to network issues.      #
+#                                                                     #
+#  exemptchanops - This option allows channel operators to be exempted#
+#                  from certain channel modes.                        #
+#                  Supported modes are +SfFgNc. Defaults to off.      #
+#                                                                     #
+#  defaultmodes  - The default modes to be given to each channel on   #
+#                  creation. Defaults to 'nt'. There should be no +   #
+#                  or - symbols in this sequence, if you add them     #
+#                  they will be ignored. You may add parameters for   #
+#                  modes which take them.                             #
+#                                                                     #
+#  moronbanner   - The NOTICE to show to users who are glined, zlined #
+#                  klined or qlined when they are disconnected. This  #
+#                  is totally freeform, you may place any text here   #
+#                  you wish.                                          #
+#                                                                     #
+
+<options prefixquit="Quit: "
+         suffixquit=""
+         prefixpart="\""
+         suffixpart="\""
+         noservices="no"
+         qprefix="~"
+         aprefix="&"
+         deprotectself="no"
+         deprotectothers="no"
+         syntaxhints="no"
+         cyclehosts="yes"
+         ircumsgprefix="no"
+         announcets="yes"
+         hostintopic="yes"
+         pingwarning="15"
+         serverpingfreq="60"
+         allowhalfop="yes"
+         defaultmodes="nt"
+         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     #
 #                  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         #
 #                                                                     #
-#  userstats     - The userstats field is optional and specifies      #
-#                  which stats characters in /STATS may be requested  #
-#                  by non-operators. Stats characters in this field   #
-#                  are case sensitive and are allowed to users        #
-#                  independent of if they are in a module or the core #
-#                                                                     #
-#  operspywhois  - If this is set then when an IRC operator uses      #
-#                  /WHOIS on a user they will see all channels, even  #
-#                  ones if channels are secret (+s), private (+p) or  #
-#                  if the target user is invisible +i.                #
-#                                                                     #
-#  customversion - If you specify this configuration item, and it is  #
-#                  not set to an empty value, then when a user does   #
-#                  a /VERSION command on the ircd, this string will   #
-#                  be displayed as the second portion of the output,  #
-#                  replacing the system 'uname', compile flags and    #
-#                  socket engine/dns engine names. You may use this   #
-#                  to enhance security, or simply for vanity.         #
-#                                                                     #
-#  maxtargets    - The maxtargets field is optional, and if not       #
-#                  defined, defaults to 20. It indicates the maximum  #
-#                  number of targets which may be given to commands   #
-#                  such as PRIVMSG, KICK etc.                         #
-#                                                                     #
-#  hidesplits    - When set to 'yes', will hide split server names    #
-#                  from non-opers. Non-opers will see '*.net *.split' #
-#                  instead of the server names in the quit message,   #
-#                  identical to the way IRCu displays them.           #
-#                                                                     #
-#  hidebans      - When set to 'yes', will hide gline, kline, zline   #
-#                  and qline quit messages from non-opers. For        #
-#                  example, user A who is not an oper will just see   #
-#                  (G-Lined) while user B who is an oper will see the #
-#                  text (G-Lined: Reason here) instead.               #
-#                                                                     #
-#  hidewhois     - When defined with a non-empty value, the given     #
-#                  text will be used in place of the user's server    #
-#                  in WHOIS, when a user is WHOISed by a non-oper.    #
-#                  For example, most nets will want to set this to    #
-#                  something like '*.netname.net' to conceal the      #
-#                  actual server the user is on.                      #
-#                                                                     #
-#  flatlinks     - When you are using m_spanningtree.so, and this     #
-#                  value is set to yes, true or 1, /MAP and /LINKS    #
-#                  will be flattened when shown to a non-opers.       #
-#                                                                     #
-#  hideulines    - When you are using m_spanningtree.so, and this     #
-#                  value is set to yes, true or 1, then U-lined       #
-#                  servers will be hidden in /LINKS and /MAP for non  #
-#                  opers. Please be aware that this will also hide    #
-#                  any leaf servers of a U-lined server, e.g. jupes.  #
-#                                                                     #
 #  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)    #
-#                  as well as the standard ERR_NEEDMOREPARAMS.        #
-#                                                                     #
-#  announcets    - If this value is defined to yes, true, or 1, then  #
-#                  a channels' timestamp is updated, the users on     #
-#                  the channel will be informed of the change via     #
-#                  a server notice to the channel with the old and    #
-#                  new TS values in the timestamp. If you think this  #
-#                  is just pointless noise, define the value to 0.    #
+#  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.           #
 #                                                                     #
-#  ircumsgprefix - Use undernet style message prefix for channel      #
-#                  NOTICE and PRIVMSG adding the prefix to the line   #
-#                  of text sent out. Eg. NOTICE @#test :@ testing     #
-#                  vs. the off setting: NOTICE @#test :testing        #
+#  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)          #
 #                                                                     #
-#  hostintopic   - If this is set to yes (the default) then the full  #
-#                  nick!user@host is shown for who set a TOPIC last.  #
-#                  if set to no, then only the nickname is shown.     #
+
+<performance netbuffersize="10240"
+             maxwho="128"
+             somaxconn="128"
+             softlimit="12800"
+             quietbursts="yes"
+             nouserdns="no">
+
+#-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # announceinvites                                                     #
 #                - If this option is set, then invites are announced  #
 #                  +b, as it may break some features in popular       #
 #                  clients such as mIRC.                              #
 #                                                                     #
-#  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.           #
+#  hidesplits    - When set to 'yes', will hide split server names    #
+#                  from non-opers. Non-opers will see '*.net *.split' #
+#                  instead of the server names in the quit message,   #
+#                  identical to the way IRCu displays them.           #
 #                                                                     #
-#  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. #
+#  hidebans      - When set to 'yes', will hide gline, kline, zline   #
+#                  and qline quit messages from non-opers. For        #
+#                  example, user A who is not an oper will just see   #
+#                  (G-Lined) while user B who is an oper will see the #
+#                  text (G-Lined: Reason here) instead.               #
 #                                                                     #
-#  pingwarning   - This should be set to a number between 1 and 59 if #
-#                  defined, and if it is defined will cause the server#
-#                  to send out a warning via snomask +l if a server   #
-#                  does not answer to PING after this many seconds.   #
-#                  This can be useful for finding servers which are   #
-#                  at risk of pinging out due to network issues.      #
+#  hidewhois     - When defined with a non-empty value, the given     #
+#                  text will be used in place of the user's server    #
+#                  in WHOIS, when a user is WHOISed by a non-oper.    #
+#                  For example, most nets will want to set this to    #
+#                  something like '*.netname.net' to conceal the      #
+#                  actual server the user is on.                      #
 #                                                                     #
-#  exemptchanops - This option allows channel operators to be exempted#
-#                  from certain channel modes.                        #
-#                  Supported modes are +SfFgNc. Defaults to off.      #
+#  flatlinks     - When you are using m_spanningtree.so, and this     #
+#                  value is set to yes, true or 1, /MAP and /LINKS    #
+#                  will be flattened when shown to a non-opers.       #
 #                                                                     #
-#  defaultmodes  - The default modes to be given to each channel on   #
-#                  creation. Defaults to 'nt'. There should be no +   #
-#                  or - symbols in this sequence, if you add them     #
-#                  they will be ignored. You may add parameters for   #
-#                  modes which take them.                             #
+#  hideulines    - When you are using m_spanningtree.so, and this     #
+#                  value is set to yes, true or 1, then U-lined       #
+#                  servers will be hidden in /LINKS and /MAP for non  #
+#                  opers. Please be aware that this will also hide    #
+#                  any leaf servers of a U-lined server, e.g. jupes.  #
 #                                                                     #
-#  moronbanner   - The NOTICE to show to users who are glined, zlined #
-#                  klined or qlined when they are disconnected. This  #
-#                  is totally freeform, you may place any text here   #
-#                  you wish.                                          #
+#  userstats     - The userstats field is optional and specifies      #
+#                  which stats characters in /STATS may be requested  #
+#                  by non-operators. Stats characters in this field   #
+#                  are case sensitive and are allowed to users        #
+#                  independent of if they are in a module or the core #
+#                                                                     #
+#  operspywhois  - If this is set then when an IRC operator uses      #
+#                  /WHOIS on a user they will see all channels, even  #
+#                  ones if channels are secret (+s), private (+p) or  #
+#                  if the target user is invisible +i.                #
+#                                                                     #
+#  customversion - If you specify this configuration item, and it is  #
+#                  not set to an empty value, then when a user does   #
+#                  a /VERSION command on the ircd, this string will   #
+#                  be displayed as the second portion of the output,  #
+#                  replacing the system 'uname', compile flags and    #
+#                  socket engine/dns engine names. You may use this   #
+#                  to enhance security, or simply for vanity.         #
+#                                                                     #
+#  maxtargets    - The maxtargets field is optional, and if not       #
+#                  defined, defaults to 20. It indicates the maximum  #
+#                  number of targets which may be given to commands   #
+#                  such as PRIVMSG, KICK etc.                         #
 #                                                                     #
 
-<options prefixquit="Quit: "
-         prefixpart="\""
-         suffixpart="\""
-         netbuffersize="10240"
-         maxwho="128"
-         noservices="no"
-         qprefix=""
-         aprefix=""
-         deprotectself="no"
-         deprotectothers="no"
-         somaxconn="128"
-         softlimit="12800"
-         userstats="Pu"
-         operspywhois="no"
-         customversion=""
-         maxtargets="20"
-         hidesplits="no"
-         hidebans="no"
-         hidewhois=""
-         flatlinks="no"
-         hideulines="no"
-         nouserdns="no"
-         syntaxhints="no"
-         cyclehosts="yes"
-         ircumsgprefix="no"
-         announcets="yes"
-         disablehmac="no"
-         hostintopic="yes"
-         hidemodes="eI"
-         quietbursts="yes"
-         pingwarning="15"
-        serverpingfreq="60"
-         allowhalfop="yes"
-        defaultmodes="nt"
-        announceinvites="dynamic"
-        moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
-        exemptchanops="">
+<security announceinvites="dynamic"
+          hidemodes="eI"
+          disablehmac="no"
+          hideulines="no"
+          flatlinks="no"
+          hidewhois=""
+          hidebans="no"
+          hidekills=""
+          hidesplits="no"
+          maxtargets="20"
+          customversion=""
+          operspywhois="no"
+          userstats="Pu">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Logging
 # client's IP address from, for further information, please see the
 # CGI:IRC documentation.
 #
+# Old style:
 # <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
-# <cgihost type="webirc" mask="somebox.mysite.com"> # Get IP from WEBIRC
 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
+# New style:
+# <cgihost type="webirc" pass="foobar"
+#   mask="somebox.mysite.com">                      # Get IP from WEBIRC
 #
 # IMPORTANT NOTE:
 # ---------------
 # 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">
 # the user in a 'connecting' state until the lookup is complete.      #
 # The bind value indicates which IP to bind outbound requests to.     #
 #                                                                     #
-#<ident timeout="5" bind="">                                          #
+#<ident timeout="5" bind="">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Invite except module: Adds support for channel invite exceptions (+I)
 # will remain open even after everyone else has left the channel, and
 # therefore keep things like modes, ban lists and topic. Permanent
 # channels -may- need support from your Services package to function
-# properly with them.
+# properly with them. This adds channel mode +P.
 #<module name="m_permchannels.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #<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 
 
 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
 
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #   You should already know what to do here :)                        #