]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/conf/inspircd.conf.example
Merge branch 'insp20' into insp3.
[user/henk/code/inspircd.git] / docs / conf / inspircd.conf.example
index 890c9cc4cbf61684d36ffdb969b5325e46af01cd..18b9cd366f6298400a6fb365e53f0eb4da3edb65 100644 (file)
       # ssl: If you want the port(s) in this bind tag to use SSL, set this to
       # the name of a custom <sslprofile> tag that you have defined or one
       # of "openssl", "gnutls", "mbedtls" if you have not defined any. See the
-      # wiki page for the SSL module you are using for more details.
+      # docs page for the SSL module you are using for more details.
       #
       # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
       # for GnuTLS and ssl_mbedtls for mbedTLS.
 #<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
+# for this listener. See the docs page for the SSL module you are using for
 # more details.
 #
 # Alternatively, you can use one of the default SSL profiles which are created
 #  -- It is important to note that connect tags are read from the  -- #
 #     TOP DOWN. This means that you should have more specific deny    #
 #    and allow tags at the top, progressively more general, followed  #
-#        by a <connect allow="*" (should you wish to have one).       #
+#        by a <connect allow="*"> (should you wish to have one).      #
 #                                                                     #
 # Connect blocks are searched twice for each user - once when the TCP #
 # connection is accepted, and once when the user completes their      #
          #
          # 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>
+         # Create hashed passwords with: /MKPASSWD <hashtype> <plaintext>
          #hash="bcrypt"
 
          # password: Password to use for this block/user(s)
          # timeout: How long the server will wait before disconnecting
          # a user if they do not do anything on connect.
          # (Note, this is a client-side thing, if the client does not
-         # send /nick, /user or /pass)
+         # send /NICK, /USER or /PASS)
          timeout="10"
 
          # localmax: Maximum local connections per IP (or CIDR mask, see below).
          # limit: How many users are allowed in this class
          limit="5000"
 
-         # modes: Usermodes that are set on users in this block on connect.
+         # modes: User modes that are set on users in this block on connect.
          # Enabling this option requires that the conn_umodes module be loaded.
-         # This entry is highly recommended to use for/with IP Cloaking/masking.
-         # For the example to work, this also requires that the "cloaking"
+         # This entry is highly recommended to use for/with IP cloaking/masking.
+         # For the example to work, this also requires that the cloaking
          # module be loaded as well.
          modes="+x"
 
          # timeout: How long the server will wait before disconnecting
          # a user if they do not do anything on connect.
          # (Note, this is a client-side thing, if the client does not
-         # send /nick, /user or /pass)
+         # send /NICK, /USER or /PASS)
          timeout="10"
 
          # pingfreq: How often the server tries to ping connecting clients.
          # limit: How many users are allowed in this class
          limit="5000"
 
-         # modes: Usermodes that are set on users in this block on connect.
+         # modes: User modes that are set on users in this block on connect.
          # Enabling this option requires that the conn_umodes module be loaded.
-         # This entry is highly recommended to use for/with IP Cloaking/masking.
+         # This entry is highly recommended to use for/with IP cloaking/masking.
          # For the example to work, this also requires that the cloaking
          # module be loaded as well.
          modes="+x">
          # See m_exemptchanops in modules.conf.example for more details.
          exemptchanops="censor:o filter:o nickflood:o nonick:v regmoderated:o"
 
-         # invitebypassmodes: This allows /invite to bypass other channel modes.
+         # invitebypassmodes: This allows /INVITE to bypass other channel modes.
          # (Such as +k, +j, +l, etc.)
          invitebypassmodes="yes"
 
           announceinvites="dynamic"
 
           # hideulines: If this value is set to yes, U-lined servers will
-          # be hidden from non-opers in /links and /map.
+          # be hidden from non-opers in /LINKS and /MAP.
           hideulines="no"
 
-          # flatlinks: If this value is set to yes, /map and /links will
+          # flatlinks: If this value is set to yes, /MAP and /LINKS will
           # be flattened when shown to non-opers.
           flatlinks="no"
 
           # from the server.
           hidebans="no"
 
-          # hidekills: If defined, replaces who set a /kill with a custom string.
+          # hidekills: If defined, replaces who executed a /KILL with a custom string.
           hidekills=""
 
           # hideulinekills: Hide kills from clients of ulined servers from server notices.
           hidesplits="no"
 
           # maxtargets: Maximum number of targets per command.
-          # (Commands like /notice, /privmsg, /kick, etc)
+          # (Commands like /NOTICE, /PRIVMSG, /KICK, etc)
           maxtargets="20"
 
           # customversion: A custom message to be displayed in the comments field
           restrictbannedusers="yes"
 
           # genericoper: Setting this value to yes makes all opers on this server
-          # appear as 'is an IRC operator' in their WHOIS, regardless of their
+          # appear as 'is a server operator' in their WHOIS, regardless of their
           # oper type, however oper types are still used internally. This only
           # affects the display in WHOIS.
           genericoper="no"
 
-          # userstats: /stats commands that users can run (opers can run all).
+          # userstats: /STATS commands that users can run (opers can run all).
           userstats="Pu">
 
 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
 #
 # An example log tag would be:
 #  <log method="file" type="OPER" level="default" target="opers.log">
-# which would log all information on /oper (failed and successful) to
+# which would log all information on /OPER (failed and successful) to
 # a file called opers.log.
 #
 # There are many different types which may be used, and modules may
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# This tag lets you define the behaviour of the /whowas command of    #
+# This tag lets you define the behaviour of the /WHOWAS command of    #
 # your server.                                                        #
 #                                                                     #
 
 <whowas
         # groupsize: Maximum entries per nick shown when performing
-        # a /whowas nick.
+        # a /WHOWAS <nick>.
         groupsize="10"
 
         # maxgroups: Maximum number of nickgroups that can be added to
-        # the list so that /whowas does not use a lot of resources on
+        # the list so that /WHOWAS does not use a lot of resources on
         # large networks.
         maxgroups="100000"
 
          # nick: Nick to disallow. Wildcards are supported.
          nick="ChanServ"
 
-         # reason: Reason to display on /nick.
+         # reason: Reason to display on /NICK.
          reason="Reserved for a network service">
 
 <badhost
 <exception
            # host: ident@hostname to exempt.
            # Wildcards and CIDR (if you specify an IP) can be used.
-           host="*@ircop.example.com"
+           host="*@serverop.example.com"
 
-           # reason: Reason for exception. Only shown in /stats e
+           # reason: Reason for exception. Only shown in /STATS e.
            reason="Oper's hostname">
 
 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#