]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/conf/inspircd.conf.example
Improve X-line text consistency.
[user/henk/code/inspircd.git] / docs / conf / inspircd.conf.example
index e28319a694bb984464c50148188326447a73134c..f65f6f5dea3803f3d55cd3f4a5f4870982940c33 100644 (file)
 # module).
 #<bind address="" port="7002" type="clients" hook="websocket">
 
+# EXPERIMENTAL: Listener that binds on a UNIX endpoint instead of a TCP/IP endpoint:
+#<bind path="/tmp/inspircd.sock" type="clients">
+
 # You can define a custom <sslprofile> tag which defines the SSL configuration
 # for this listener. See the wiki page for the SSL module you are using for
 # more details.
          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>
 
          # Alternate MOTD file for this connect class. The contents of this file are
          # specified using <files secretmotd="filename"> or <execfiles ...>
+         #
+         # NOTE: the following escape sequences for IRC formatting characters can be
+         # used in your MOTD:
+         # Bold:          \b
+         # Color:         \c<fg>[,<bg>]
+         # 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
+         # on client support for formatting characters.
          motd="secretmotd"
 
          # port: What port range this user is allowed to connect on. (optional)
 
 #<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">
+# 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">
 
 #-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #                                                                     #
 #<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.">
-
-
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #   Settings to define which features are usable on your server.      #
              # 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"
 
           # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
           # banned on a channel to change nickname or message channels they are
-          # banned on.
+          # banned on. This can also be set to silent to restrict the user but not
+          # notify them.
           restrictbannedusers="yes"
 
           # genericoper: Setting this value to yes makes all opers on this server
         # maxkick: Maximum length of a kick message.
         maxkick="255"
 
-        # maxgecos: Maximum length of a real name (gecos).
-        maxgecos="128"
+        # maxreal: Maximum length of a real name.
+        maxreal="128"
 
         # maxaway: Maximum length of an away message.
         maxaway="200">
 #  - USERS - information relating to user connection and disconnection
 #  - OPER - succesful and failed oper attempts
 #  - KILL - kill related messages
-#  - snomask - server notices (*all* snomasks will be logged)
 #  - FILTER - messages related to filter matches (filter module)
 #  - CONFIG - configuration related messages
 #  - COMMAND - die and restart messages, and messages related to unknown user types
 <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 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #    ____                _   _____ _     _       ____  _ _   _        #
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #