]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Patch from aquanight to fix a problem introduced with some of the recent tidyups.
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 9bc3a095f92149236da301c25cd7913529f0a8f4..93e74e8b81b92c7e9abdaa9d232360d0be40454c 100644 (file)
@@ -95,8 +95,8 @@
 #  port         - The port number to bind to. You may specify a port  #
 #                 range here, e.g. "6667-6669,7000,7001". If you do   #
 #                 this, the server will count each port within your   #
-#                 range as a seperate binding, making the above       #
-#                 example equivalent to five seperate bind tags.      #
+#                 range as a separate binding, making the above       #
+#                 example equivalent to five separate bind tags.      #
 #                 A failure on one port in the range does not prevent #
 #                 the entire range from being bound, just that one    #
 #                 port number.                                        #
 #                                                                     #
 #  Syntax is as follows:                                              #
 #                                                                     #
-#       <connect name="myallow" allow="1.2.3.0/24"                    #
+#       <connect name="myallow" allow="1.2.3.0/24" limit="5"          #
 #                password="blahblah" timeout="10" timeout="blah"      #
 #                flood="5" threshold="8" pingfreq="120" sendq="99999" #
 #                revcq="696969" localmax="3" globalmax="3"            #
-#                port="6660" maxchans="50">                           #
+#                port="6660" maxchans="50" limit="999">               #
 #                                                                     #
 #       <connect name="blocked" deny="127.0.0.1" port="6667">         #
 #                                                                     #
 #   be copied from the parent.                                        #
 #                                                                     #
 #   If the value maxchans is included, this overrides all other max   #
-#   channels related settings, including the seperate oper maximum.   #
+#   channels related settings, including the separate oper maximum.   #
 #   You may set this to any (sane) value you wish and it applies to   #
 #   all users within this connect tag.                                #
 #                                                                     #
 #   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 optionally limit the number of clients that are matched   #
+#   by a single <connect> tag by specifying the maximum in the limit  #
+#   parameter. If set to 0, there is no limit, which is the default.  #
+#                                                                     #
 #   You should also 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. This feature can   #
 #   only incoming connections on the specified port will match. Port  #
 #   tags may be used on connect allow and connect deny tags.          #
 #                                                                     #
+#   The limit value determines the maximum number of users which may  #
+#   be in this class. Combine this with CIDR masks for various ISP    #
+#   subnets to limit the number of users which may connect at any one #
+#   time from a certain ISP. Omit this value to not limit the tag.    #
+#                                                                     #
 
 <connect allow="196.12.*"  password="secret" port="6667">
 
          sendq="262144"
          recvq="8192"
          localmax="3"
-         globalmax="3">
+         globalmax="3"
+        limit="5000">
 
 <connect deny="69.254.*">
 <connect deny="3ffe::0/32">
 #  classes    - specified above, used for flexibility for the         #
 #               server admin to decide on which operators get         #
 #               what commands. Class names are case sensitive,        #
-#               seperate multiple class names with spaces.            #
+#               separate multiple class names with spaces.            #
 #                                                                     #
 #  host       - optional hostmask operators will receive on oper-up.  #
 #                                                                     #
 #                plaintext password in this value.                    #
 #                                                                     #
 #  host        - hosts of client allowed to oper-up.                  #
-#                wildcards accepted, seperate multiple hosts with a   #
+#                wildcards accepted, separate multiple hosts with a   #
 #                space. You may also specify CIDR IP addresses.       #
 #                                                                     #
 #  fingerprint - when using the m_ssl_oper_cert.so module, you may    #
 # 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, does   #
+# name        -   the name is the canonical name of the server, does   #
 #                 not have to resolve - but it is expected to be set  #
 #                 in the remote servers connection info.              #
 #                                                                     #
 #                 hosts are resolved on rehash, and cached, if you    #
 #                 specify a hostname; so if you find that your server #
 #                 is still trying to connect to an old IP after you   #
-#                 have updated your dns, try rehashing and then       #
+#                 have updated your DNS, try rehashing and then       #
 #                 attempting the connect again.                       #
 #                                                                     #
 # port        -   the TCP port for the remote server.                 #
 #                 example to hide a non-client hub, for which clients #
 #                 do not have an IP address or resolvable hostname.   #
 #                                                                     #
-# to u:line a server (give it extra privilages required for running   #
+# to u:line a server (give it extra privileges 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.    #
 #                                                                     #
 #                                                                     #
 #   These options let you define the path to your motd and rules      #
 #   files. If these are relative paths, they are relative to the      #
-#   configurtion directory.                                           #
+#   configuration directory.                                           #
 #                                                                     #
 
 <files motd="inspircd.motd.example"
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-#   Settings to define which features are useable on your server.     #
+#   Settings to define which features are usable on your server.     #
 #                                                                     #
 #  prefixquit    - A prefix to be placed on the start of a client's   #
 #                  quit message                                       #
 #                  QUITS. If specified, overrides both prefixquit     #
 #                  and suffixquit options.                            #
 #                                                                     #
+#  prefixpart    - A prefix to be placed on the start of a client's   #
+#                  part message                                       #
+#                                                                     #
+#  suffixpart    - A suffix to be placed on the end of a client's     #
+#                  part message.                                      #
+#                                                                     #
+#  fixedpart     - A fixed part message to display for all client     #
+#                  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.                          #
 #                  actual server the user is on.                      #
 #                                                                     #
 #  flatlinks     - When you are using m_spanningtree.so, and this     #
-#                  value is set to true, yes or 1, /MAP and /LINKS    #
-#                  will be flattened when shown to a non-oper       #
+#                  value is set to yes, true or 1, /MAP and /LINKS    #
+#                  will be flattened when shown to a non-opers.       #
 #                                                                     #
 #  hideulines    - When you are using m_spanningtree.so, and this     #
-#                  value is set to true, yes or 1, then U-lined       #
-#                  servers will be hidden in /LINKS and /MAP. For non #
+#                  value is set to yes, true or 1, then U-lined       #
+#                  servers will be hidden in /LINKS and /MAP for non  #
 #                  opers. Please be aware that this will also hide    #
 #                  any leaf servers of a U-lined server, e.g. jupes.  #
 #                                                                     #
-#  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.                                           #
+#  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 set to 'yes', 'true' or '1', when a user does   #
-#                  not give enough parameters for a command, a syntax #
+#  syntaxhints   - If set 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.        #
 #                                                                     #
-#  announcets    - If this value is defined to 'yes', 'true' or '1',  #
-#                  then if a channel's timestamp is updated the users #
-#                  on the channel will be informed of the change via  #
+#  announcets    - If this value is defined to yes, true or 1, then   #
+#                  a channel's timestamp is updated, the users on     #
+#                  the channel will be informed of the change via     #
 #                  a server notice to the channel with the old and    #
 #                  new TS values in the timestamp. If you think this  #
 #                  is just pointless noise, define the value to 0.    #
 #                                                                     #
 # announceinvites                                                     #
 #                - If this option is set, then invites are announced  #
-#                  to the channel when a user invites annother user.  #
+#                  to the channel when a user invites another user.   #
 #                  If you consider this to be unnecessary noise,      #
 #                  set this to 'none'. To announce to all ops, set    #
 #                  this to 'ops' and to announce to all users set the #
 #                  creation. Defaults to 'nt'. There should be no +   #
 #                  or - symbols in this sequence, if you add them     #
 #                  they will be ignored. You may add parameters for   #
-#                  parameterised modes.                               #
+#                  modes which take them.                             #
 #                                                                     #
 #  moronbanner   - The NOTICE to show to users who are glined, zlined #
 #                  klined or qlined when they are disconnected. This  #
 #                                                                     #
 
 <options prefixquit="Quit: "
+         prefixpart="\""
+         suffixpart="\""
          loglevel="default"
          netbuffersize="10240"
          maxwho="128"
         exemptchanops="">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#
-# Time synchronisation options for m_spanningtree linking.             #
+# Time synchronisation options for m_spanningtree linking.            #
 #                                                                     #
 # Because IRC is very time and clock dependent, InspIRCd provides its #
-# own methods for synchronisation of time between servers as shown     #
+# own methods for synchronisation of time between servers as shown    #
 # in the example below, for servers that don't have ntpd running.     #
 #                                                                     #
 #  enable    -     If this value is 'yes', 'true', or '1', time       #
 #                    command "foo bar baz qux quz" then $3- will hold #
 #                    "baz qux quz" and $2 will contain "bar". You may #
 #                    also use the special variables: $nick, $ident,   #
-#                    $host and $vhost, and you may seperate multiple  #
+#                    $host and $vhost, and you may separate multiple  #
 #                    commands with \n. If you wish to use the ACTUAL  #
 #                    characters \ and n together in a line, you must  #
 #                    use the sequence "\\n".                          #
 # channel messages and channel notices.
 #<module name="m_deaf.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Delay join module: Adds the channel mode +D which delays all JOIN
+# messages from users until they speak. If they quit or part before
+# speaking, their quit or part message will not be shown to the channel
+# which helps cut down noise on large channels in a more friendly way
+# than the auditorium mode. Only channel ops may set the +D mode.
+#<module name="m_delayjoin.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Deny Channels: Deny Channels from being used by users
 #<module name="m_denychans.so"> 
 # If you have the m_denychans.so module loaded, you need to specify   #
 # the channels to deny:                                               #
 #                                                                     #
-# name        -      The channel name to deny.                        #
+# name        -      The channel name to deny. (glob masks are ok)    #
 #                                                                     #
 # allowopers  -      If operators are allowed to override the deny.   #
 #                                                                     #
 # reason      -      Reason given for the deny.                       #
 #                                                                     #
-#<badchan name="#gods" allowopers="yes" reason="Tortoises!">
+#<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
+#                                                                     #
+# Additionally, you may specify channels which are allowed, even if   #
+# a badchan tag specifies it would be denied:                         #
+#<goodchan name="#godsleeps">                                         #
+# Glob masks are accepted here also.
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Devoice Module: Let users devoice themselves.
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper modes module: Allows you to specify modes to add/remove on oper
 # Specify the modes as the 'modes' parameter of the <type> tag
+# and/or as the 'modes' parameter of the <oper> tag.
 #<module name="m_opermodes.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#