]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/conf/inspircd.conf.example
Move the <disabled> tag out of the core to a new module.
[user/henk/code/inspircd.git] / docs / conf / inspircd.conf.example
index 12fc613aaebf9ce127f967be17111f98ffb7d65a..890c9cc4cbf61684d36ffdb969b5325e46af01cd 100644 (file)
          allow="203.0.113.*"
 
          # hash: the hash function this password is hashed with. Requires the
-         # module for the selected function (bcrypt, md5, sha1, sha256, or
-         # ripemd160) and the password hashing module (password_hash) to be
-         # loaded.
+         # module for the selected function (bcrypt, md5, sha1, or sha256) and
+         # the password hashing module (password_hash) to be loaded.
+         #
          # You may also use any of the above other than bcrypt prefixed with
          # either "hmac-" or "pbkdf2-hmac-" (requires the pbkdf2 module).
          # Create hashed passwords with: /mkpasswd <hash> <password>
          # Italic:        \i
          # Monospace:     \m  (not widely supported)
          # Reset:         \x
+         # Reverse:       \r
          # Strikethrough: \s  (not widely supported)
          # Underline:     \u
          # See https://defs.ircdocs.horse/info/formatting.html for more information
 
          # softsendq: amount of data in a client's send queue before the server
          # begins delaying their commands in order to allow the sendq to drain
-         softsendq="8192"
+         softsendq="10240"
 
          # recvq: amount of data allowed in a client's queue before they are dropped.
-         # Entering "8K" is equivalent to "8192", see above.
-         recvq="8K"
+         # Entering "10K" is equivalent to "10240", see above.
+         recvq="10K"
 
          # threshold: This specifies the amount of command penalty a user is allowed to have
          # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
 
 #<pid file="/path/to/inspircd.pid">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#-#-#-#-#-#-#-#-#-#-#-#-#- LIST MODE LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# Use these tags to customise the ban limits on a per channel basis.  #
-# The tags are read from top to bottom, and any tag found which       #
-# matches the channels name applies the banlimit to that channel.     #
+# The <maxlist> tag is used customise the maximum number of each list #
+# mode that can be set on a channel.                                  #
+# The tags are read from top to bottom and the list mode limit from   #
+# the first tag found which matches the channel name and mode type is #
+# applied to that channel.                                            #
 # It is advisable to put an entry with the channel as '*' at the      #
-# bottom of the list. If none are specified or no maxbans tag is      #
+# bottom of the list. If none are specified or no maxlist tag is      #
 # matched, the banlist size defaults to 100 entries.                  #
 #                                                                     #
 
-<banlist chan="#largechan" limit="200">
-<banlist chan="*" limit="100">
-
-#-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# This tag is optional, and specifies one or more features which are  #
-# not available to non-operators.                                     #
-#                                                                     #
-# For example you may wish to disable NICK and prevent non-opers from #
-# changing their nicknames.                                           #
-# Note that any disabled commands take effect only after the user has #
-# 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
-# so for example disabling NICK will not cripple your network.        #
-#                                                                     #
-# You can also define if you want to disable any channelmodes         #
-# or usermodes from your users.                                       #
-#                                                                     #
-# `fakenonexistant' will make the ircd pretend that nonexistant       #
-# commands simply don't exist to non-opers ("no such command").       #
-#                                                                     #
-#<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
-
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-#   Just remove this... Its here to make you read ALL of the config   #
-#   file options ;)                                                   #
-
-<die value="You should probably edit your config *PROPERLY* and try again.">
+# Allows #largechan to have up to 200 ban entries.
+#<maxlist mode="ban" chan="#largechan" limit="200">
 
+# Allows #largechan to have up to 200 ban exception entries.
+#<maxlist mode="e" chan="#largechan" limit="200">
 
+# Allows all channels and list modes not previously matched to have
+# up to 100 entries.
+<maxlist chan="*" limit="100">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
              # Default value is true
              clonesonconnect="true"
 
+             # timeskipwarn: The time period that a server clock can jump by before
+             # operators will be warned that the server is having performance issues.
+             timeskipwarn="2s"
+
              # quietbursts: When syncing or splitting from a network, a server
              # can generate a lot of connect and quit messages to opers with
              # +C and +Q snomasks. Setting this to yes squelches those messages,
           # when a remote whois (/WHOIS <nick> <nick>) is used.
           #hideserver="*.example.com"
 
-          # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
+          # hidebans: If this value is set to yes, when a user is banned ([KGZ]-lined)
           # only opers will see the ban message when the user is removed
           # from the server.
           hidebans="no"
 <badhost host="root@*" reason="Don't IRC as root!">
 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
 
-# exception: Hosts that are exempt from [kgz]lines.
+# exception: Hosts that are exempt from [KGZ]-lines.
 <exception
            # host: ident@hostname to exempt.
            # Wildcards and CIDR (if you specify an IP) can be used.
 
 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# This optional tag allows you to specify how wide a gline, eline,    #
-# kline, zline or qline can be before it is forbidden from being      #
-# set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
+# This optional tag allows you to specify how wide a G-line, E-line,  #
+# K-line, Z-line or Q-line can be before it is forbidden from being   #
+# set. By setting hostmasks="yes", you can allow all G-, K-, E-lines, #
 # no matter how many users the ban would cover. This is not           #
-# recommended! By setting ipmasks="yes", you can allow all Z lines,   #
+# recommended! By setting ipmasks="yes", you can allow all Z-lines,   #
 # no matter how many users these cover too. Needless to say we        #
 # don't recommend you do this, or, set nickmasks="yes", which will    #
-# allow any qline.                                                    #
+# allow any Q-line.                                                   #
 #                                                                     #
 
 <insane
         # will be banning 955 or more users.
         trigger="95.5">
 
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-#   You should already know what to do here :)                        #
-
-<die value="User error. You didn't edit your config properly. Go back and try again.">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #    ____                _   _____ _     _       ____  _ _   _        #
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #