]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Added manpages
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 34316ab718fcd3efe997c0c639c6ed586e6525af..cccae5ed055b89ddbf30de4093b5b70f5fe9b3fd 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 : 30/10/2002                         #
+#                 Last updated on : 01/05/2004                         #
 #                 Written by      : CC  (cc@backchat.co.za)            #
-#                                                                     #
+#                 Updated by      : BlackDeathX (james@dreamirc.org)   #
 ########################################################################
 
 
@@ -57,7 +57,8 @@
 #  port                - opens an unused port                                #
 #  type         - can be 'clients' or 'servers'. The clients type is  #
 #                 a standard tcp based socket, the servers type is a  #
-                  UDP based connection.                               #
+#                 also a TCP based connection but of a different      #
+#                 format.                                             #
 #  default      - if the port type is 'servers' then this can be      #
 #                 specified. If set to 'yes', it indicates that this  #
 #                 port is the default route for all /connect commands.#
@@ -86,7 +87,7 @@
 #   need this ability should know the die and restart password.       #
 #                                                                     #
 #  Syntax is as follows:                                              #
-#       <power diepass="die password" restartpass="restart password"
+#       <power diepass="die password" restartpass="restart password"  #
 #       pause="secs before dying">                                   #
 #                                                                     #
 
 #                                                                    #
 #  Syntax is as follows:                                             #
 #      <connect allow="ip number">                                   #
-#      <connect allow="ip number"  password="blahblah">              #
+#      <connect allow="ip number" password="blahblah">               #
+#       <connect allow="ip number" password="blah" timeout="10">      #
+#      <connect allow="ip number" timeout="blah" flood="5">          #
 #      <connect deny="ip number">                                    #
+#                                                                     #
+#   You may optionally include timeout="x" on any allow line, which   #
+#   specifies the amount of time given before an unknown connection   #
+#   is closed if USER/NICK/PASS are not given. This value is in secs  #
 #                                                                    #
+#   You may also optionally 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. The default is to  #
+#   DISABLE this feature. A recommended value is 10.                  #
+
 
-<connect allow="196.12.*"  password="tiffany">
-<connect allow="*">
+<connect allow="196.12.*"  password="secret">
+<connect allow="*" timeout="60" flood="10">
 
 <connect deny="69.254.*">
 
         type="NetAdmin">
 
 
-#-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION   -#-#-#-#-#-#-#-#-#-
+#-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# 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 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.                                       #
+#                                                                     #
+# 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.    #
+#                                                                     #
+# WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
+# that server to operoverride modes. This should only be used for     #
+# services and protected oper servers!                                #
+#                                                                     #
+
+<link name="hub.penguin.org"
+       ipaddr="12.34.56.78"
+       port="7000"
+       sendpass="outgoing!password"
+       recvpass="incoming!password">
+
+<link name="services.antarctic.com"
+       ipaddr="98.76.54.32"
+       port="7000"
+       sendpass="penguins"
+       recvpass="polarbears">
+
+<uline server="services.antarctic.com">
+
+
+
+#-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                    #
 #   These options let you define the path to your motd and rules      #
 #   files.                                                           #
 #                                                                    #
 #   Settings to define which features are useable on your server.     #
 #                                                                    #
-#  prefixquit   - a prefix for a client's quit message                #
-#  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                         #
-#  allowprotect - allows the +a channel mode                         #
-#  allowfounder - allows the +q channel mode                         #
-#                                                                    #
+#  prefixquit    - a prefix for a client's quit message               #
+#  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   #
+#                  user into a channel gets founder status. This is   #
+#                  only useful on networks running the m_chanprotect  #
+#                  module without services.                           #
+#  netbuffersize - size of the buffer used to receive data from       #
+#                  clients. The ircd may only read() this amount      #
+#                 of text in one go at any time. (OPTIONAL)          #
+#  maxwho        - The maximum number of results returned by a /WHO   #
+#                  query. This is to prevent /WHO being used as a     #
+#                  spam vector or means of flooding an ircd. The      #
+#                  default is 128, it is not recommended to raise it  #
+#                  above 1024. Values up to 65535 are permitted.      #
 
 <options prefixquit="Quit: "
         loglevel="default"
-        allowhalfop="yes"
-        allowprotect="yes"
-        allowfounder="yes">
+        netbuffersize="10240"
+         maxwho="128"
+        noservices="0">
+        allowhalfop="yes">
 
 
 
 
 <module name="m_foobar.so">
 
+#-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# 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">
+
+
+#-#-#-#-#-#-#-#-#-#-#-#-  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">
+
+
+#-#-#-#-#-#-#-#-#-#-  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">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# The ban tags define nick masks, host masks and ip ranges which are  #
+# banned from your server. All details in these tags are local to     #
+# Your server.                                                        #
+#                                                                     #
+#                                                                     #
+# badip lines ban an ip range (same as a zline)                       #
+#                                                                     #
+# ipmask       -          The ip range to ban (wildcards possible)    #
+# reason       -          Reason to display when disconnected         #
+#                                                                     #
+# badnick lines ban a nick mask (same as a qline)                     #
+#                                                                     #
+# nick         -          Nick mask to ban (wildcards possible)       #
+# reason       -          Reason to display on /NICK                  #
+#                                                                     #
+# badhost lines ban a user@host mask (same as a kline)                #
+#                                                                     #
+# host         -          ident@hostname (wildcards possible)         #
+# reason       -          Reason to display on disconnection          #
+#                                                                     #
+
+<badip ipmask="69.69.69.69" reason="No porn here thanks.">
+
+<badnick nick="ChanServ" reason="Reserved For Services">
+<badnick nick="NickServ" reason="Reserved For Services">
+<badnick nick="OperServ" reason="Reserved For Services">
+<badnick nick="MemoServ" reason="Reserved For Services">
+
+<badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
+<badhost host="*@localhost" reason="No irc from localhost!">
+
+#-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# If you have the m_alias.so module loaded, you may also define       #
+# aliases as shown below. They are commonly used to provide shortcut  #
+# commands to services, however they are not limited to jsut 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. May contain spaces, but case insensitive. #
+# replace     -      The text to replace 'text' with. Usually this    #
+#                    will be "PRIVMSG ServiceName :" or similar.      #
+# 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     #
+#                    actually being on the network. If the user is    #
+#                    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.       #
+#                                                                     #
 
+<alias text="NICKSERV" replace="PRIVMSG NickServ :" requires="NickServ" uline="yes">
+<alias text="CHANSERV" replace="PRIVMSG ChanServ :" requires="ChanServ" uline="yes">
+<alias text="NS ID" replace="PRIVMSG NickServ :identify" requires="NickServ" uline="yes">
+<alias text="NS" replace="PRIVMSG NickServ :" requires="NickServ" uline="yes">
+<alias text="CS" replace="PRIVMSG ChanServ :" requires="ChanServ" uline="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #