]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/conf/inspircd.conf.example
Clarify the documentation of <connect:allow>.
[user/henk/code/inspircd.git] / docs / conf / inspircd.conf.example
index 551797f7b485da58d9676498eed5a92fc932a913..164f8130d3eb46e60cc818692db99dab460455fa 100644 (file)
@@ -53,7 +53,7 @@
 #<include executable="/path/to/executable parameters">                #
 #                                                                     #
 # Executable include example:                                         #
-#<include executable="/usr/bin/wget -q -O - http://mynet.net/inspircd.conf">
+#<include executable="/usr/bin/wget -q -O - http://example.com/inspircd.conf">
 #                                                                     #
 
 
@@ -81,7 +81,7 @@
 <server
         # name: Hostname of your server. Does not need to resolve, but
         # does need to be correct syntax (something.somethingelse.tld).
-        name="penguin.omega.org.za"
+        name="penguin.omega.example.org"
 
         # description: Server description. Spaces are allowed.
         description="Waddle World"
 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
 #                                                                     #
 #   You can configure the passwords here which you wish to use for    #
-#   the /DIE and /RESTART commands. Only trusted IRCop's who will     #
+#   the /DIE and /RESTART commands. Only trusted ircops who will      #
 #   need this ability should know the die and restart password.       #
 #                                                                     #
 
 
        # diepass: Password for opers to use if they need to shutdown (die)
        # a server.
+       #
+       # IMPORTANT: leaving this field empty does not disable the use of
+       # the DIE command. In order to prevent the use of this command you
+       # should remove it from the command privileges of your opers.
        diepass=""
 
        # restartpass: Password for opers to use if they need to restart
        # a server.
+       #
+       # IMPORTANT: leaving this field empty does not disable the use of
+       # the RESTART command. In order to prevent the use of this command
+       # you should remove it from the command privileges of your opers.
        restartpass="">
 
 
          # you only want to adjust sendq and a password
          parent="main"
 
-         # allow: What IP addresses/hosts to allow for this block.
+         # allow: The IP address or hostname of clients that can use this
+         # class. You can specify either an exact match, a glob match, or
+         # a CIDR range here.
          allow="203.0.113.*"
 
          # hash: what hash this password is hashed with. requires the module
          # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
          globalmax="3"
 
-         # maxconnwarn: Enable warnings when localmax or globalmax is hit (defaults to on)
+         # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
          maxconnwarn="off"
 
          # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
          # connect class inheriting.
          name="main"
 
-         # allow: What IP addresses/hosts to allow for this block.
+         # allow: The IP address or hostname of clients that can use this
+         # class. You can specify either an exact match, a glob match, or
+         # a CIDR range here.
          allow="*"
 
          # maxchans: Maximum number of channels a user in this class
 # represented as 192.168.1.0/24). This means that abuse across an ISP #
 # is detected and curtailed much easier. Here is a good chart that    #
 # shows how many IPs the different CIDRs correspond to:               #
-# http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation                #
+# https://en.wikipedia.org/wiki/IPv4_subnetting_reference             #
+# https://en.wikipedia.org/wiki/IPv6_subnetting_reference             #
 #                                                                     #
 
 <cidr
 # matched, the banlist size defaults to 64 entries.                   #
 #                                                                     #
 
-<banlist chan="#morons" limit="128">
+<banlist chan="#largechan" limit="128">
 <banlist chan="*" limit="69">
 
 #-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 
          # allowmismatch: Setting this option to yes will allow servers to link even
          # if they don't have the same "optionally common" modules loaded. Setting this to
-         # yes may introduce some desyncs and weirdness.
+         # yes may introduce some desyncs and unwanted behaviour.
          allowmismatch="no"
 
          # defaultbind: Sets the default for <bind> tags without an address. Choices are
           # hidekills: If defined, replaces who set a /kill with a custom string.
           hidekills=""
 
+          # hideulinekills: Hide kills from clients of ulined servers from server notices.
+          hideulinekills="yes"
+
           # hidesplits: If enabled, non-opers will not be able to see which
           # servers split in a netsplit, they will only be able to see that one
           # occurred (If their client has netsplit detection).
 # Logging is covered with the <log> tag, which you may use to change
 # the behaviour of the logging of the IRCd.
 #
-# In InspIRCd as of 1.2, logging is pluggable and very extensible.
-# Different files can log the same thing, different 'types' of log can
-# go to different places, and modules can even extend the log tag
-# to do what they want.
-#
 # An example log tag would be:
 #  <log method="file" type="OPER" level="default" target="logs/opers.log">
 # which would log all information on /oper (failed and successful) to
 <badhost
          # host: ident@hostname to ban.
          # Wildcards and CIDR (if you specify an IP) can be used.
-         host="*@hundredz.n.hundredz.o.1337.kiddies.example.net"
+         host="*@banneduser.example.net"
 
          # reason: Reason to display when user is disconnected
-         reason="Too many 1337 kiddiots">
+         reason="Evading Bans">
 
 <badhost host="root@*" reason="Don't IRC as root!">
 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
 #                                                                     #
 #   You should already know what to do here :)                        #
 
-<die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
+<die value="User error. You didn't edit your config properly. Go back and try again.">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #    ____                _   _____ _     _       ____  _ _   _        #
 #########################################################################
 #                                                                       #
 #                     - InspIRCd Development Team -                     #
-#                        http://www.inspircd.org                        #
+#                        https://www.inspircd.org                       #
 #                                                                       #
 #########################################################################