]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Change to a const
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 5b918e3a080389aedd7926c00d667ef90afbd377..1e49fae93403ebc6df84ab2a80fd667b0981ef7d 100644 (file)
 #       <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" maxlocal="3" maxglobal="3">          #
+#       <connect allow="ip mask" localmax="3" globalmax="3">          #
 #       <connect deny="ip mask">                                      #
 #                                                                     #
 #   You may optionally include timeout="x" on any allow line, which   #
 #   This works alongside with the classes specified above.            #
 #                                                                     #
 #  type name  - a name for the combined class types                   #
+#               a type name cannot contain spaces, however if you     #
+#               put an _ symbol in the name, it will be translated    #
+#               to a space when displayed in a WHOIS.                 #
 #                                                                     #
 #  classes    - specified above, used for flexibility for the         #
 #               server admin to decide on which operators get         #
 # that server to operoverride modes. This should only be used for     #
 # services and protected oper servers!                                #
 #                                                                     #
-# IMPORTANT NOTE: When specifying the ip address and/or host, the     #
-# server software will prioritize RESOLVED hostnames above ip         #
-# addresses, so for example if your target server resolves to a.b.com #
-# you MUST put a.b.com into your link block, and NOT the IP address   #
-# of a.b.com. The system uses reverse resolution.                     #
-#                                                                     #
 #    ____                _   _____ _     _       ____  _ _   _        #
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 #                  oper-only 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   #
 #                  temporarily copied before loading. If not defined, #
 #                  defaults to /tmp.                                  #
 #                                                                     #
+#  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 et 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.        #
+#                                                                     #
 
 <options prefixquit="Quit: "
          loglevel="default"
          somaxconn="128"
          softlimit="128"
          operonlystats="oclgkz"
+         operspywhois="no"
          customversion=""
          maxtargets="20"
-        hidesplits="no"
-        hidebans="no"
-        hidewhois=""
-        flatlinks="no"
-        hideulines="no"
+         hidesplits="no"
+         hidebans="no"
+         hidewhois=""
+         flatlinks="no"
+         hideulines="no"
+        nouserdns="no"
+        syntaxhints="no"
          allowhalfop="yes">
 
 
 #
 #<waitpong sendsnotice="yes" killonbadreply="yes">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Connection throttle module. Configuration:
+#<module name="m_connflood.so">
+#
+#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+#  seconds, maxconns -  Amount of connections per <seconds>.
+#  timeout           -  Time to wait after the throttle was activated
+#                       before deactivating it. Be aware that the time
+#                       is seconds + timeout.
+#  quitmsg           -  The message that users get if they attempt to
+#                       connect while the throttle is active.
+#  bootwait          -  Amount of time to wait before enforcing the
+#                       throttling when the server just booted.
+#
+#<connflood seconds="30" maxconns="3" timeout="30"
+#   quitmsg="Throttled" bootwait="10">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Deny Channels: Deny Channels from being used by users
 #<module name="m_denychans.so"> 
 # Msg flood module: Adds message/notice flood protection (+f)
 #<module name="m_messageflood.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# MySQL module: Allows other SQL modules to access MySQL databases
+# through a unified API. You must copy the source for this module
+# from the directory src/modules/extra, plus the file m_sqlv2.h
+#<module name="m_mysql.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# m_mysql.so is more complex than described here, see the wiki for    #
+# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
+#
+#<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Nicklock module: Let opers change a user's nick and then stop that
 # user from changing their nick again. /NICKLOCK and /NICKUNLOCK
 #
 #<opermotd file="/path/to/oper.motd">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper WHO module: Provides a more revealing /WHO to opers
-#<module name="m_operwho.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Override module: Adds support for oper override
 #<module name="m_override.so">
 # m_park.so is too complex it describe here, see the wiki:            #
 # http://www.inspircd.org/wiki/User_Parking_Module                    #
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# PostgreSQL module: Allows other SQL modules to access PgSQL databases
+# through a unified API. You must copy the source for this module
+# from the directory src/modules/extra, plus the file m_sqlv2.h
+#<module name="m_pgsql.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# m_pgsql.so is more complex than described here, see the wiki for    #
+# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
+#
+#<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Random Quote module: provides a random quote on connect
 #<module name="m_randquote.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Services support module: Adds several usermodes such as +R and +M
+# this module implements the 'identified' state via user mode +r, which
+# is similar to the DALnet and dreamforge systems.
 #<module name="m_services.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Services support module: Adds several usermodes such as +R and +M
+# this module implements the 'identified' state via account names (AC)
+# and is similar in operation to the way asuka and ircu handle services.
+# it cannot be used at the same time as m_services, above.
+#<module name="m_services_account.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Sethost module: Adds the /SETHOST command
 #<module name="m_sethost.so">
 # SILENCE module: Adds support for /SILENCE
 #<module name="m_silence.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SQL module: Allows other SQL modules to access SQL databases
-# through a unified API. You must copy the source for this module
-# from the directory src/modules/extra
-#<module name="m_sql.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# m_sql.so is more complex than described here, see the wiki for more:#
-# http://www.inspircd.org/wiki/SQL_Service_Provider_Module            #
-#
-#<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="1">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SQL authentication module: Allows IRCd connections to be tied into
 # a database table (for example a forum). You must copy the source for