]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
add a hint to users for using an IP instead of *
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 8574975ffd3685d08d33f36caf8348a2f22653bc..f0f68b3d32e85bbb958bc37758efd4fa9c6e1e40 100644 (file)
 # config file inspircd.conf, unless the filename starts with a forward#
 # slash (/) in which case it is treated as an absolute path.          #
 #                                                                     #
+# You may also include an executable file, in which case if you do so #
+# the output of the executable on the standard output will be added   #
+# to your config at the point of the include tag.                     #
+#                                                                     #
 # Syntax is as follows:                                               #
 #<include file="file.conf">                                           #
+#<include executable="/path/to/executable parameters">                #
 #                                                                     #
 
 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 #                  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   #
 #                                                                     #
 
 <options prefixquit="Quit: "
+         suffixquit=""
          prefixpart="\""
          suffixpart="\""
-         loglevel="default"
          netbuffersize="10240"
          maxwho="128"
          noservices="no"
-         qprefix=""
-         aprefix=""
+         qprefix="~"
+         aprefix="&"
          deprotectself="no"
          deprotectothers="no"
          somaxconn="128"
          hidemodes="eI"
          quietbursts="yes"
          pingwarning="15"
-        serverpingfreq="60"
+         serverpingfreq="60"
          allowhalfop="yes"
-        defaultmodes="nt"
-        announceinvites="dynamic"
-        moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
-        exemptchanops="">
+         defaultmodes="nt"
+         announceinvites="dynamic"
+         moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
+         exemptchanops="">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Logging
+# -------
+#
 # Logging is covered with the <log> tag, which you may use to change
 # the behaviour of the logging of the IRCd.
 #
 # You may also log *everything* by using a type of *, and subtract things out
 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
 #
-
 # Channel Logging
-# I'm aware this would probably better belong in the modules section, but this is heavily interrelated
-# to logging, and as such will be documented here.
+# ---------------
+#
+# I'm aware this would probably better belong in the modules section, but this
+# is heavily interrelated to logging, and as such will be documented here.
 #
 # m_chanlog is one of the modules which can alter logging to it's own thing.
 # An example of this may be:
-#      <log method="channel" type="OPER USERS CHANNELS" level="default" target="#services">
+#
 #<module name="m_chanlog.so">
+#<log method="channel" type="OPER USERS CHANNELS" level="default" target="#services">
 #
 # The following log tag is highly default and uncustomised. It is recommended you
 # sort out your own log tags. This is just here so you get some output.
 # usually for cryptographic uses and security.
 #
 # IMPORTANT:
-# Other modules such as m_opermd5.so may rely on this module being
-# loaded to function.
+# Other modules such as m_password_hash.so may rely on this module being
+# loaded to function. Certain modules such as m_spanningtree.so will
+# function without this module but when it is loaded their features will
+# be enhanced (for example the addition of HMAC authentication).
 #
 #<module name="m_sha256.so">
 
 #<blockamsg delay="3" action="killopers">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Block CAPS module: Blocking all-CAPS messages with cmode +P
+# Block CAPS module: Blocking all-CAPS messages with cmode +B
 #<module name="m_blockcaps.so">
 #                                                                     #
 #-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 # 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:
 # ---------------
 # 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)
 #<module name="m_namesx.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Quietban: Implements extended ban n:, which stops anyone matching
+# Nickban: Implements extended ban n:, which stops anyone matching
 # a mask like +b n:nick!user@host from changing their nick on channel.
-#<module name="m_quietban.so">
+#<module name="m_nickban.so">
 #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # and sha256 type hashing will be available (the most secure of which
 # is SHA256).
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Permanent Channels module: Channels with the permanent channels mode
+# 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. This adds channel mode +P.
+#<module name="m_permchannels.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
 # through a unified API. You must copy the source for this module
 #<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 
 #
 # Sets the maximum number of entries on a user's watch list.
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
+# in a file "xline.db" which can be re-loaded on restart. This is useful
+# for two reasons: it keeps bans so users may not evade them, and on
+# bigger networks, server connections will take less time as there will
+# be a lot less bans to apply - as most of them will already be there.
+#<module name="m_xline_db.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # XMLSocket module: Adds support for connections using the shockwave
 # flash XMLSocket. Note that this does not work if the client you are