]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Fixed false example info in config.
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index b8d0a1797498b76da82713c255312a83ed672e83..ac48be1ee6db277afc30d5805f9a599c5c9077f5 100644 (file)
@@ -11,9 +11,9 @@
 #         This is an example of the config file for InspIRCd.          #
 #             Change the options to suit your network                  #
 #                                                                     #
-#                 Last updated on : 01/05/2004                         #
+#                 Last updated on : 06/06/2005                         #
 #                 Written by      : CC  (cc@backchat.co.za)            #
-#                 Updated by      : BlackDeathX (james@dreamirc.org)   #
+#                 Updated by      : katsklaw (katsklaw@gmail.com)      #
 ########################################################################
 
 
@@ -44,9 +44,9 @@
 #              email="email@address.com">                            #
 #                                                                    #
 
-<admin  name="Johnny Casino"
-        nick="CC"
-        email="cc@monkeynut.co.za">
+<admin  name="Johnny English"
+        nick="MI5"
+        email="MI5@the.best.secret.agent">
 
 
 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 <power diepass="diepass" restartpass="restartpass" pause="2">
 
 
+#-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# This optional tag allows you to include another config file         #
+# allowing you to keep your configuration tidy. The configuration     #
+# file you include will be treated as part of the configuration file  #
+# which includes it, in simple terms the inclusion is transparent.    #
+#                                                                     #
+# All paths to config files are relative to the directory of the main #
+# config file inspircd.conf, unless the filename starts with a forward#
+# slash (/) in which case it is treated as an absolute path.          #
+#                                                                     #
+# Syntax is as follows:                                               #
+#       <include file="file.conf">                                    #
+#                                                                     #
+
 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
 #                                                                    #
 #   This is where you can configure which connections are allowed     #
 #                                                                     #
 
 <connect allow="196.12.*"  password="secret">
-<connect allow="*" timeout="60" flood="10" timeout="60" pingfreq="120" sendq="262144" recvq="4096">
+<connect allow="*" timeout="60" flood="10" threshold="60" pingfreq="120" sendq="262144" recvq="4096">
 
 <connect deny="69.254.*">
 
 #  classes    - specified above, used for flexibility for the         #
 #               server admin to decide on which operators get         #
 #              what commands                                         #
-#  host              - hostmask operators will recieve on oper-up            #
-#                                                                    #
+#  host              - hostmask operators will recieve on oper-up.           #
+#(optional)                                                          #
+#                                                                     #
 #  Syntax is as follows:                                             #
 #      <type name="name" classes="class name" host="oper hostmask">  #
 #                                                                    #
 #                                                                    #
 #  name      - oper name, best to use lower-case                     #
 #  password  - password to oper-up,                                  #
-#              encryption not yet available                          #
+#              encryption not supported by inspircd. However, there   #
+#              are modules that allow for oper password encryption.   #                      
+#                                                                     #
 #  host      - host of client allowed to oper-up, more hostmasks      #
 #              seperated by spaces, wildcards accepted               #
 #  type      - specified above, defines the kind of operator         #
 #             type="oper type">                                              #
 #                                                                    #
 
-<oper   name="cc"
+<oper   name="katsklaw"
        password="s3cret"
         host="*@*"
         type="NetAdmin">
 # Defines which servers can link to this one, and which servers this  #
 # server may create outbound links to.                                #
 #                                                                     #
-# name      - The name is the canocial name of the server, it does    #
-#             not have to resolve - but it is expected to be sent in  #
-#             the remote servers connection info.                     #
-# ipaddr    - Valid host or ip address for remote server. *           #
-# port      - Valid listening UDP port for remote server.             #
-# sendpass  - Password to send to create an outbound connection to    #
-#             this server.                                            #
-# recvpass  - Password to receive to accept an inbound connection     #
-#             from this server.                                       #
+# name        - The name is the canocial name of the server, it does  #
+#               not have to resolve - but it is expected to be sent   #
+#               in the remote servers connection info.                #
+# ipaddr      - Valid host or ip address for remote server. *         #
+# port        - Valid listening UDP port for remote server.           #
+# sendpass    - Password to send to create an outbound connection to  #
+#               this server.                                          #
+# recvpass    - Password to receive to accept an inbound connection   #
+#               from this server.                                     #
+# autoconnect - Sets the server to autoconnect. Where x is the number #
+# (optional)    of seconds between attempts.  300 = 5 minutes         #
 #                                                                     #
 # to u:line a server (give it extra privilages required for running   #
 # services, Q, etc) you must include the <uline server> tag as shown  #
 <link name="hub.penguin.org"
        ipaddr="penguin.box.com"
        port="7000"
+        autoconnect="300"
        sendpass="outgoing!password"
        recvpass="incoming!password">
 
 <uline server="services.antarctic.com">
 
 
-
 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                    #
 #   These options let you define the path to your motd and rules      #
 #   files.                                                           #
 #                                                                    #
 
-<files  motd="/home/cc/inspircd-1.0/conf/inspire.motd"
-       rules="/home/cc/inspircd-1.0/conf/inspire.rules">
+<files  motd="/home/cc/inspircd/conf/inspire.motd"
+       rules="/home/cc/inspircd/conf/inspire.rules">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #                  the location where modules are to be found. This   #
 #                  does not add a supplementary directory. There can  #
 #                  only be one module path.                           #
+#  softlimit     - This optional feature allows a defined softlimit.  #
+#                  if defined sets a soft maxconnections value, has   #
+#                  to be less than the ./configure maxclients         #
+#                                                                     #
 
 <options prefixquit="Quit: "
         loglevel="default"
          maxwho="128"
         noservices="0"
          somaxconn="128"
-        allowhalfop="yes">
+        softlimit="128"
+         allowhalfop="yes">
 
 
 
 #  in the config, or via /LOADMODULE, you will receive an error.      #
 #                                                                     #
 #  By default, ALL modules are commented out. You must uncomment them #
-#  or add lines to your config to load modules.                       #
+#  or add lines to your config to load modules. Please refer to       #
+#  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
+#  each modules link for any additional conf tags they require.       #
+#                                                                     #
+#  WINDOWS USERS PLEASE NOTE: You can still load these modules! They  #
+#  are incorporated into the executable and can be loaded and removed #
+#  similarly to if they were in a ramdisk.                            #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Foobar module - does nothing
 # Restricted channels module: Allows only opers to create channels
 #<module name="m_restrictchans.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Deny Channels: Deny Channels from being used by users
+#<module name="m_denychans.so"> 
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Services support module: Adds several usermodes such as +R and +M
 #<module name="m_services.so">
 # Antibottler module: Labels bottler leech bots
 #<module name="m_antibottler.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Watch module: Adds the WATCH command, which is used by clients to 
+# maintain notify lists.
+#<module name="m_watch.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Cloaking module: Adds usermode +x and cloaking support
 #<module name="m_cloaking.so">
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper levels module: Gives each oper a level and prevents
 # actions being taken against higher level opers
+#<module name="m_operlevels.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-#<module name="m_operlevels.so">
 # Remove module: Adds the /REMOVE command which is a peaceful
 # alternative to /KICK
 #<module name="m_remove.so">
 # Optional - If you specify to use the m_filter.so module, then       #
 # specfiy below the path to the filter.conf file.                     #
 
-<filter file="/path/to/inspircd/filter.conf">
+#<filter file="/path/to/inspircd/filter.conf">
 
 
 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 # Optional - If you specify to use the m_helpop.so module, then       #
 # specify below the path to the helpop.conf file.                     #
 
-<helpop file="/path/to/inspircd/helpop.conf">
+<die value="If you used the helpop include above then do *NOT* use this tag.">
+#<helpop file="/path/to/inspircd/helpop.conf">
 
 
 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
 # Optional - If you specify to use the m_randquotes.so module, then   #
 # specify below the path to the randquotes.conf file.                 #
 
-# <randquote file="/path/to/inspircd/randquotes.conf">
+#<randquote file="/path/to/inspircd/randquotes.conf">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #