]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Add <blockcolor:allowchanops>, mirroring <stripcolor:allowchanops>.
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 3ace28c39d69d780da98ca300c89d584c564231a..1379a077b340ed14f4217dfd8d3327a232bd3599 100644 (file)
@@ -20,7 +20,7 @@
 #         This is an example of the config file for InspIRCd.          #
 #             Change the options to suit your network                  #
 #                                                                      #
-#                Last updated on : 03 Feb 2007                         #
+#     $Id$
 #                                                                      #
 #    ____                _   _____ _     _       ____  _ _   _         #
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #   This is where you can configure which connections are allowed     #
-#   and denied access onto your server.                               #
-#   The password is optional.                                         #
-#   You may have as many of these as you require.                     #
-#   To allow/deny all connections use a *                             #
+#   and denied access onto your server. The password is optional.     #
+#   You may have as many of these as you require. To allow/deny all   #
+#   connections, use a '*' or 0.0.0.0/0.                              #
 #                                                                     #
 #  Syntax is as follows:                                              #
 #                                                                     #
-#       <connect allow="ip mask">                                     #
-#       <connect allow="ip mask" password="blahblah">                 #
-#       <connect allow="ip mask" password="blah" timeout="10">        #
-#       <connect allow="ip mask" timeout="blah" flood="5">            #
-#       <connect allow="ip mask" threshold="8" pingfreq="120">        #
-#       <connect allow="ip mask" sendq="99999" revcq="696969">        #
-#       <connect allow="ip mask" localmax="3" globalmax="3">          #
-#       <connect allow="ip mask" port="6660">                         #
-#       <connect deny="ip mask">                                      #
+#       <connect allow="1.2.3.0/24" password="blahblah"               #
+#                timeout="10" timeout="blah" flood="5"                #
+#                threshold="8" pingfreq="120" sendq="99999"           #
+#                revcq="696969" localmax="3" globalmax="3"            #
+#                port="6660">                                         #
+#                                                                     #
+#       <connect deny="127.0.0.1" port="6667">                        #
 #                                                                     #
 #   IP masks may be specified in CIDR format or wildcard format,      #
-#   for IPV4 and IPV6.                                                #
+#   for IPV4 and IPV6. You *cannot* use hostnames in the allow or     #
+#   deny field, as the state is applied before the user's DNS has     #
+#   been resolved.                                                    #
 #                                                                     #
 #   You may optionally include timeout="x" on any allow line, which   #
 #   specifies the amount of time given before an unknown connection   #
 #   receive more than they send in normal circumstances. The default  #
 #   if not specified is 4096.                                         #
 #                                                                     #
-#   IMPORTANT NOTE, CALL THE CONFUSION POLICE!                        #
 #   The sendq is the data waiting to be sent TO THE USER.             #
 #   The recvq is the data being received FROM THE USER.               #
 #   The names sendq and recvq are from the SERVER'S PERSPECTIVE not   #
 #                                                                     #
 #   The optional port value determines which port the connect tag is  #
 #   handling. If left out the connect tag covers all bound ports else #
-#   only incoming connections on the specified port will match.       #
+#   only incoming connections on the specified port will match. Port  #
+#   tags may be used on connect allow and connect deny tags.          #
 #                                                                     #
 
-<connect allow="196.12.*"  password="secret">
-<connect allow="*" timeout="60" flood="20" threshold="1" pingfreq="120" sendq="262144" recvq="8192" localmax="3" globalmax="3">
+<connect allow="196.12.*"  password="secret" port="6667">
+
+<connect allow="*"
+         timeout="60"
+         flood="20"
+         threshold="1"
+         pingfreq="120"
+         sendq="262144"
+         recvq="8192"
+         localmax="3"
+         globalmax="3">
 
 <connect deny="69.254.*">
 <connect deny="3ffe::0/32">
 #                  this feature, which stops even the founder taking  #
 #                  away their founder status without using services.  #
 #                                                                     #
+#  deprotectothers-If this value is set to yes, true, or 1, then any  #
+#                  user with +q or +a may remove the +q or +a from    #
+#                  other users. The default setting is to not enable  #
+#                  this feature, so that only +q may remove +a, and   #
+#                  nothing but services may remove +q.                #
+#                                                                     #
 #  cyclehosts    - If this is set to true, yes or 1, then when a      #
 #                  user's hostname changes, they will appear to quit  #
 #                  and then rejoin with their new host. This prevents #
 #                  authentication, this option can be used to turn it #
 #                  off.                                               #
 #                                                                     #
+#  hidemodes     - If this option is enabled, then the listmodes      #
+#                  given (e.g. +eI), will be hidden from users below  #
+#                  halfop. This is not recommended to be set on mode  #
+#                  +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.           #
+#                                                                     #
+#  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.      #
+#                                                                     #
 
 <options prefixquit="Quit: "
          loglevel="default"
          noservices="no"
          qaprefixes="no"
          deprotectself="no"
+         deprotectothers="no"
          somaxconn="128"
          softlimit="12800"
          userstats="Pu"
          cyclehosts="yes"
          ircumsgprefix="no"
          announcets="yes"
-        disablehmac="no"
+         disablehmac="no"
          hostintopic="yes"
+         hidemodes="eI"
+         quietbursts="yes"
+         pingwarning="15"
          allowhalfop="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#
 # Antibottler module: Labels bottler leech bots
 #<module name="m_antibottler.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Auditorium module: Adds channel mode +u which makes everyone else
+# except you in the channel invisible, used for large meetings etc.
+#<module name="m_auditorium.so">
+#
+# Auditorium settings:
+#
+#<auditorium showops="no">
+#
+# Setting this value to yes makes m_auditorium behave like unrealircd
+# +u channel mode, e.g. ops see users joining, parting, etc, and users
+# joining the channel see the ops. Without this flag, the mode acts
+# like ircnet's +a (anonymous channels), showing only the user in the
+# names list, and not even showing the ops in the list, or showing the
+# ops that the user has joined.
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Ban except module: Adds support for channel ban exceptions (+e)
 #<module name="m_banexception.so">
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Block colour module: Blocking colour-coded messages with cmode +c
 #<module name="m_blockcolor.so">
+#
+# Optionally, you can allow channel ops to bypass filtering. Defaults to no.
+# <blockcolor allowchanops="no">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Botmode module: Adds the user mode +B
 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
 
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Channel create module: Adds snomask +j, which will notify opers of
+# any new channels that are created
+#<module name="m_chancreate.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Channel filter module: Allows channel-op defined message
 # filtering using simple string matches (channel mode +g)
 # use hexdecimal numbers prefixed by "0x", as shown in this example,  #
 # with each key eight hex digits long.                                #
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Clones module: Adds an oper command /CLONES for detecting cloned
+# users. Warning: This module may be resource intensive when its
+# command is issued, use with care.
+#<module name="m_clones.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Conn-Join: Allows you to force users to join one or more channels
 # automatically upon connecting to the server.
 # Invite except module: Adds support for channel invite exceptions (+I)
 #<module name="m_inviteexception.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Invisible module - Adds support for usermode +Q (quiet) which lets an
+# oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
+# opers are still able to see invisible users, and if an oper with +Q
+# deopers, they will become visible. 
+# 
+# IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
+# must first add the value canquiet="yes" to that oper's type tag.
+#
+#<module name="m_invisible.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Join flood module: Adds support for join flood protection (+j)
 #<module name="m_joinflood.so">
 # Redirect module: Adds channel redirection (mode +L)
 #<module name="m_redirect.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Registered users only channel creation
+# Allows only registered users and opers to create new channels.
+#<module name="m_regonlycreate.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Remove module: Adds the /REMOVE command which is a peaceful
 # alternative to /KICK
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Strip colour module: Adds the channel mode +S
 #<module name="m_stripcolor.so">
+#
+# Optionally, you can allow channel ops to bypass filtering. Defaults to no.
+# <stripcolor allowchanops="no">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SILENCE module: Adds support for /SILENCE
 #<module name="m_silence.so">
+#
+# Configuration tags:
+#
+#<silence maxentries="32">
+#
+# Sets the maximum number of entries on a users silence list.
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Extended SILENCE module: Adds support for /SILENCE with additional
 # features to silence based on invites, channel messages, etc.
 #<module name="m_silence_ext.so">
+#
+# The configuration tags for this module are identical to those of
+# m_silence, shown above.
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SQLite3 module: Allows other SQL modules to access SQLite3          #
 # users a /GLINE or /ZLINE etc would match.
 #<module name="m_tline.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# UHNAMES support module: Adds support for the IRCX style UHNAMES
+# extension, which displays ident and hostname in the names list for
+# each user, saving clients from doing a WHO on the channel. Note that
+# this module is not widely supported yet. If a client does not support
+# UHNAMES it will not enable it, this will not break incompatible
+# clients.
+#<module name="m_uhnames.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Uninvite module: Adds the /UNINVITE command which lets users remove
 # pending invites from channels without waiting for the user to join.
 # Watch module: Adds the WATCH command, which is used by clients to 
 # maintain notify lists.
 #<module name="m_watch.so">
+#
+# Configuration tags:
+#
+#<watch maxentries="32">
+#
+# Sets the maximum number of entries on a user's watch list.
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# XMLSocket module: Adds support for connections using the shockwave
+# flash XMLSocket. Note that this does not work if the client you are
+# using has retarded ideas of the IRC protocol. Your client must still
+# send RFC-correct lines to the server, this module only changes the
+# line ending from newlines to null terminators.
+#
+#<module name="m_xmlsocket.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # ZipLinks module: Adds support for zlib deflate on server to server