]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Merge peaveydk's example conf change.
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 3945a2ece945bb9941bab1a76f524fd40e7e93d0..34aee0c6c1bd0310a9f02877af7225d1e89441f9 100644 (file)
 #                 apply to autoconnected servers as well as manually  #
 #                 connected ones.                                     #
 #                                                                     #
+# timeout       - If this is defined, then outbound connections will  #
+#                 time out if they are not connected within this many #
+#                 seconds. If this is not defined, the default of ten #
+#                 seconds is used.                                    #
+#                                                                     #
 # to u:line a server (give it extra privilages required for running   #
 # services, Q, etc) you must include the <uline server> tag as shown  #
 # in the example below. You can have as many of these as you like.    #
        allowmask="69.58.44.0/24"
         autoconnect="300"
        failover="hub.other.net"
+       timeout="15"
         sendpass="outgoing!password"
         recvpass="incoming!password">
 
 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #   These options let you define the path to your motd and rules      #
-#   files. These should be absolute paths.                            #
+#   files. If these are relative paths, they are relative to the      #
+#   configurtion directory.                                           #
 #                                                                     #
 
-<files  motd="/home/cc/inspircd/conf/inspircd.motd"
-        rules="/home/cc/inspircd/conf/inspircd.rules">
+<files  motd="inspircd.motd"
+        rules="inspircd.rules">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # Define the path to the PID file here. The PID file can be used to   #
 # rehash the ircd from the shell or to terminate the ircd from the    #
 # shell using shell scripts, perl scripts etc, and to monitor the     #
-# ircd's state via cron jobs. This is IMPORTANT and you must define   #
-# it or the ircd will refuse to start.                                #
+# ircd's state via cron jobs. If this is a relative path, it will be  #
+# relative to the configuration directory, and if it is not defined,  #
+# the default of 'inspircd.pid' is used.                              #
 #                                                                     #
 
-<pid file="/path/to/inspircd.pid">
+#<pid file="/path/to/inspircd.pid">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #                  used in unreal. This is only useful on networks    #
 #                  running the m_chanprotect module                   #
 #                                                                     #
+#  deprotectself - If this value is set to yes, true, or 1, then any  #
+#                  user with +q or +a may remove the +q or +a from    #
+#                  themselves. The default setting is to not enable   #
+#                  this feature, which stops even the founder taking  #
+#                  away their founder status without using services.  #
+#                                                                     #
 #  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 #
          loglevel="default"
          netbuffersize="10240"
          maxwho="128"
-         noservices="0"
-         qaprefixes="0"
+         noservices="no"
+         qaprefixes="no"
+        deprotectself="no"
          somaxconn="128"
          softlimit="12800"
          userstats="Pu"
 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
 #  each modules link for any additional conf tags they require.       #
 #                                                                     #
+#  You may use wildcards in a <module> tag to load all modules which  #
+#  match a glob pattern (e.g. m_sa????.so would load m_sajoin,        #
+#  m_sapart, m_saquit and m_sanick)                                   #
+#                                                                     #
 #    ____                _   _____ _     _       ____  _ _   _        #
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
 #<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">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Alltime module: Shows time on all connected servers at once
+# #<module name="m_alltime.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Antibear security module: Prevents 'bear.txt' based trojans from
 # connecting to your network by sending them a numeric they can't handle.
 #
 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# Optional - If you specify to use the m_censor module, then specfiy  #
-# below the path to the censor.conf file. See also:                   #
-# Censor file, see http://www.inspircd.org/wiki/Censor_Module         #
+# Optional - If you specify to use the m_censor module, then you must #
+# specify some censor tags. See also:                                 #
+# http://www.inspircd.org/wiki/Censor_Module                          #
 #
-#<censor file="/path/to/censor.conf">
+#<include file="censor.conf">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Channel filter module: Allows channel-op defined message
 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # Optional - If you specify to use the m_filter or m_filter_pcre      #
-# modules, then specfiy below the path to the filter.conf file.       #
+# modules, then specfiy below the path to the filter.conf file,       #
+# or define some <filter> tags.                                       #
 #                                                                     #
-#<filter file="/path/to/inspircd/filter.conf">
+#<include file="filter.conf">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Foobar module: does nothing - historical relic
 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # Optional - If you specify to use the m_helpop.so module, then       #
-# specify below the path to the helpop.conf file.                     #
+# specify below the path to the helpop.conf file, or if you like to   #
+# make a mess, define your helpop tags in this conf.                  #
 #                                                                     #
-#<helpop file="/path/to/inspircd/helpop.conf">
+#<include file="helpop.conf">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# HIDECHANS module: Allows opers to hide their channels list from non-
+# opers by setting user mode +I on themselves.
+# <module name="m_hidechans.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# HIDEOPER module: Allows opers to hide their oper status from non-
+# opers by setting user mode +H on themselves.
+# <module name="m_hideoper.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Hostchange module: Allows a different style of cloaking
 # SILENCE module: Adds support for /SILENCE
 #<module name="m_silence.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# SQLutils module: Provides some utilities to SQL client modules, such
+# as mapping queries to users and channels. You must copy the source
+# for this module from the directory src/modules/extra/m_sqlutils.cpp
+# and src/modules/extra/m_sqlutils.h into /src/modules
+# Needed for, and loaded before: SQLauth and SQLoper
+#<module name="m_sqlutils.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SQL authentication module: Allows IRCd connections to be tied into
 # a database table (for example a forum). You must copy the source for
 # this module from the directory src/modules/extra
+# Depends on the SQLutils module being loaded first.
 #<module name="m_sqlauth.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SQL oper module: Allows you to store oper credentials in an SQL table
 # You must copy the source for this module from the directory src/modules/extra
+# Depends on the SQLutils module being loaded first.
 #<module name="m_sqloper.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#