]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Revert this back to sanity, still doesnt work tho
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 9d5434f1b68a0c28503c4ddc998c801584a87bc7..3859934774de62305d330ad7d283362a05b174e5 100644 (file)
@@ -61,8 +61,8 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-#   Describes the Server Administrator's real name, nick              #
-#   and email address.                                                #
+#   Describes the Server Administrator's real name (optionally),      #
+#   nick, and email address.                                          #
 #                                                                     #
 #  Syntax is as follows:                                              #
 #       <admin name="real name"                                       #
 #   You should also include a flood="x" line which indicates          #
 #   the number of lines a user may place into their buffer at once    #
 #   before they are disconnected for excess flood. This feature can   #
-#   not be disabled, however it can be set to exremely high values,   #
+#   not be disabled, however it can be set to extremely high values,  #
 #   rendering it effectively disabled. A recommended value is 10.     #
 #   A counter is maintained for each user which is reset every        #
 #   'threshold' seconds and specifying this threshold value with      #
 #   The optional recvq value is the maximum size which users in this  #
 #   group may grow their receive queue to. This is recommended to be  #
 #   kept pretty low compared to the sendq, as users will always       #
-#   recieve more than they send in normal circumstances. The default  #
+#   receive more than they send in normal circumstances. The default  #
 #   if not specified is 4096.                                         #
 #                                                                     #
 #   IMPORTANT NOTE, CALL THE CONFUSION POLICE!                        #
 #               what commands. Class names are case sensitive,        #
 #               seperate multiple class names with spaces.            #
 #                                                                     #
-#  host       - optional hostmask operators will recieve on oper-up.  #
+#  host       - optional hostmask operators will receive on oper-up.  #
 #                                                                     #
 #  Syntax is as follows:                                              #
 #                                                                     #
 #                is not loaded, this configuration option has no      #
 #                effect and will be ignored.                          #
 #                                                                     #
-#  type        - Sefines the kind of operator. This must match a type #
+#  type        - Defines the kind of operator. This must match a type #
 #                tag you defined above, and is case sensitive.        #
 #                                                                     #
 #  Syntax is as follows:                                              #
 #                  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 off: NOTICE @#test :testing                     #
+#
 #  notimesync    - If this value is 'yes', 'true', or '1', time       #
 #                  synchronization is disabled on this server. This   #
 #                  means any servers you are linked to will not       #
          nouserdns="no"
          syntaxhints="no"
          cyclehosts="yes"
+         ircumsgprefix="no"
          announcets="yes"
          notimesync="no"
          allowhalfop="yes">
 # commands to services, however they are not limited to just this use.#
 # An alias tag requires the following values to be defined in it:     #
 #                                                                     #
-# text        -      The text to detect at the start of the line,     #
-#                    must be at the start of the line to trigger the  #
-#                    alias. Cant contain spaces, but case insensitive #
+# text        -      The text to detect as the actual command line,   #
+#                    Cant contain spaces, but case insensitive.       #
+#                    You may have multiple aliases with the same      #
+#                    command name (text="" value), however the first  #
+#                    found will be executed if its format value is    #
+#                    matched, or it has no format value. Aliases are  #
+#                    read from the top of the file to the bottom.     #
+#                                                                     #
+# format      -      If this is defined, the parameters of the alias  #
+#                    must match this glob pattern. For example if you #
+#                    want the first parameter to start with a # for   #
+#                    the alias to be executed, set format="#*" in the #
+#                    alias definition. Note that the :'s which are    #
+#                    part of IRC formatted lines will be preserved    #
+#                    for matching of this text. This value is         #
+#                    optional.                                        #
+#                                                                     #
 # replace     -      The text to replace 'text' with. Usually this    #
 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
 #                    You may use the variables $1 through $9 in the   #
 #                    commands with \n. If you wish to use the ACTUAL  #
 #                    characters \ and n together in a line, you must  #
 #                    use the sequence "\\n".                          #
+#                                                                     #
 # requires    -      If you provide a value for 'requires' this means #
 #                    the given nickname MUST be online for the alias  #
 #                    to successfully trigger. If they are not, then   #
 #                    the user receives a 'no such nick' 401 numeric.  #
+#                                                                     #
 # uline       -      Defining this value with 'yes', 'true' or '1'    #
 #                    will ensure that the user given in 'requires'    #
 #                    must also be on a u-lined server, as well as     #
 #                    online, but not on a u-lined server, then an     #
 #                    oper-alert is sent out as this is possibly signs #
 #                    of a user trying to impersonate a service.       #
+#                                                                     #
 # operonly    -      Defining this value, with a value of 'yes', '1'  #
 #                    or true will make the alias oper only. If a non- #
 #                    oper attempts to use the alias, it will appear   #
 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
-#<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $3" requires="NickServ" uline="yes">
+#
+# An example of using the format value to create an alias with two
+# different behaviours depending on the format of the parameters.
+#
+#<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
+#  requires="ChanServ" uline="yes">
+#
+#<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
+#  requires="NickServ" uline="yes">
+#
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Alltime module: Shows time on all connected servers at once
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Block CAPS module: Blocking all-CAPS messages with cmode +P
 #<module name="m_blockcaps.so">
+#                                                                     #
+#-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# percent        - How many percent of text must be caps before text  #
+#                  will be blocked.                                   #
+#                                                                     #
+# minlen         - The minimum length a line must be for the block    #
+#                  percent to have any effect.                        #
+#                                                                     #
+#<blockcaps percent="95" minlen="5">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Block colour module: Blocking colour-coded messages with cmode +c
 #
 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# Optional - If ypu specify the m_cloaking.so module as above, you    #
+# Optional - If you specify the m_cloaking.so module as above, you    #
 # must define cloak keys, and optionally a cloak prefix as shown      #
 # below. When using cloaking, the cloak keys are MANDITORY and must   #
 # be included. However, if prefix is not included, it will default    #
 # to your networks name from the <server> tag.                        #
 #                                                                     #
-# <cloak key1="543241423"                                             #
-#        key2="5378410432"                                            #
-#        key3="1143242382"                                            #
-#        key4="9504324581"                                            #
+# <cloak key1="0x2AF39F40"                                            #
+#        key2="0x78E10B32"                                            #
+#        key3="0x4F2D2E82"                                            #
+#        key4="0x043A4C81"                                            #
 #        prefix="mynet">                                              #
 #                                                                     #
 # Please note that the key values will accept any number, and should  #
 # be large numbers. Using small numbers such as "7" or "1924" will    #
-# seriously weaken the security of your cloak.                        #
+# seriously weaken the security of your cloak. It is recommended you  #
+# use hexdecimal numbers prefixed by "0x", as shown in this example,  #
+# with each key eight hex digits long.                                #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Conn-Lusers: Shows the LUSERS output on connect
 # Devoice Module: Let users devoice themselves.
 #<module name="m_devoice.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# DNS Blacklist Module: Provides support for looking up IPs on one or #
+# more blacklists.                                                    #
+#<module name="m_dnsbl.so">                                           #
+#                                                                     #
+# For configuration options please see the wiki page for m_dnsbl at   #
+# http://inspircd.org/wiki/DNS_Blacklist_Module                       #
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Filter module: Provides glob-based message filtering
 #<module name="m_filter.so">
 # Knock module: adds the /KNOCK command and +K channel mode
 #<module name="m_knock.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
+# used to temporarily close/open for new connections to the server.   #
+# These commands require OPER status and that the LOCKSERV UNLOCKSERV #
+# are specified in a <class> tag that the oper is part of. This is so #
+# you can control who has access to this possible dangerous command.  #
+# If your server is locked and you got disconnected, do a REHASH from #
+# shell to open up again.
+#<module name="m_lockserv.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Msg flood module: Adds message/notice flood protection (+f)
 #<module name="m_messageflood.so">
 # features to silence based on invites, channel messages, etc.
 #<module name="m_silence_ext.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# SQLite3 module: Allows other SQL modules to access SQLite3          #
+# databases through a unified API. You must link the source for this  #
+# module from the directory src/modules/extra to src/modules, plus    #
+# the file m_sqlv2.h                                                  #
+#<module name="m_sqlite3.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# m_sqlite.so is more complex than described here, see the wiki for   #
+# more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module  #
+#
+#<database hostname="/full/path/to/database.db" id="anytext">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SQLutils module: Provides some utilities to SQL client modules, such
 # as mapping queries to users and channels. You must copy the source
 
 <exception host="*@ircop.host.com" reason="Opers hostname">
 
+#-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# This optional tag allows you to specify how wide a gline, eline,    #
+# kline, zline or qline can be before it is forbidden from being      #
+# set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
+# no matter how many users the ban would cover. This is not           #
+# recommended! By setting ipmasks="yes", you can allow all Z lines,   #
+# no matter how many users these cover too. Needless to say we        #
+# don't recommend you do this, or, set nickmasks="yes", which will    #
+# allow any qline.                                                    #
+#                                                                     #
+# The trigger value indicates how wide any mask will be before it is  #
+# prevented from being set. The default value is 95.5% if this tag is #
+# not defined in your configuration file, meaning that if your        #
+# network has 1000 users, a gline matching over 955 of them will be   #
+# prevented from being added.                                         #
+#                                                                     #
+# Please note that remote servers (and services) are exempt from      #
+# these restrictions and expected to enforce their own policies       #
+# locally!                                                            #
+#                                                                     #
+
+<insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #   You should already know what to do here :)                        #