X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Finspircd.conf.example;h=77b7db62289b4f4f6113438e6bd74aa62b8e341b;hb=b04cc4a74eec93f16eb0370eed47d96bde582d15;hp=c9691b8571062baf10691730a53c74366978653c;hpb=25052ccef3c47cc43af9b900a658e5c09e8bec2e;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example
index c9691b857..77b7db622 100644
--- a/docs/conf/inspircd.conf.example
+++ b/docs/conf/inspircd.conf.example
@@ -50,8 +50,7 @@
 # file you include will be treated as part of the configuration file  #
 # which includes it, in simple terms the inclusion is transparent.    #
 #                                                                     #
-# All paths to config files are relative to the directory that the    #
-# process runs in.                                                    #
+# All paths to config files are relative to the config directory.     #
 #                                                                     #
 # You may also include an executable file, in which case if you do so #
 # the output of the executable on the standard output will be added   #
@@ -122,21 +121,10 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 #                                                                     #
-#   Enter the port and address bindings here.                         #
+#   Configure the port and address bindings here.                     #
 #                                                                     #
-#                                                                     #
-#    ____                _   _____ _     _       ____  _ _   _        #
-#   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
-#   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
-#   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
-#   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
-#                                                                     #
-#  If you want to link servers to InspIRCd you must load the          #
-#  spanningtree module! Please see the modules list for               #
-#  information on how to load this module! If you do not load this    #
-#  module, server ports will NOT work!                                #
 
-# Listener that binds on a TCP/IP endpoint:
+# TLS (SSL) listener that binds on a TCP/IP endpoint:
 <bind
       # address: IP address to bind to if the box that you are hosting
       # on has more than one IP, else the ircd will try to bind to all
@@ -153,10 +141,10 @@
       # to this bind section.
       type="clients"
 
-      # ssl: If you want the port(s) in this bind tag to use SSL, set this to
+      # ssl: If you want the port(s) in this bind tag to use TLS (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
-      # docs page for the SSL module you are using for more details.
+      # docs page for the TLS (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.
@@ -179,6 +167,10 @@
       # not have brought the network interfaces up yet.
       free="no">
 
+# Plaintext listener that binds on a TCP/IP endpoint:
+<bind address="" port="6667" type="clients">
+
+
 # Listener that binds on a UNIX endpoint (not supported on Windows):
 #<bind
 
@@ -193,6 +185,9 @@
     # permissions: The octal permissions to set on the UNIX socket after it has
     # been created. If you are not familiar with octal permissions you should
     # not define this or refer to http://permissions-calculator.org for help.
+    # Note: This does not take effect on rehash.
+    # To change it on a running bind, you'll have to comment it out,
+    # rehash, comment it in and rehash again.
     #permissions=""
 
     # replace: if the UNIX socket path already exists then remove it before
@@ -201,18 +196,18 @@
     # shut down cleanly and left a zombie socket behind.
     #replace="yes">
 
-<bind address="" port="6660-6669" type="clients">
 
 # Listener accepting HTML5 WebSocket connections.
 # Requires the websocket module and SHA-1 hashing support (provided by the sha1
 # module).
 #<bind address="" port="7002" type="clients" hook="websocket">
 
-# You can define a custom <sslprofile> tag which defines the SSL configuration
-# for this listener. See the docs page for the SSL module you are using for
+
+# You can define a custom <sslprofile> tag which defines the TLS (SSL) configuration
+# for these listeners. See the docs page for the TLS (SSL) module you are using for
 # more details.
 #
-# Alternatively, you can use one of the default SSL profiles which are created
+# Alternatively, you can use one of the default TLS (SSL) profiles which are created
 # when you have not defined any:
 #   "openssl" (requires the ssl_openssl module)
 #   "gnutls" (requires the ssl_gnutls module)
@@ -222,9 +217,6 @@
 # completely link-compatible and can be used alongside each other on each end
 # of the link without any significant issues.
 
-<bind address="" port="7000,7001" type="servers">
-<bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
-
 
 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
@@ -241,17 +233,14 @@
 # Connect blocks are searched twice for each user - once when the TCP #
 # connection is accepted, and once when the user completes their      #
 # registration. Most of the information (hostname, ident response,    #
-# password, SSL when using STARTTLS, etc) is only available during    #
-# the second search, so if you are trying to make a closed server,    #
+# password, TLS (SSL) when using STARTTLS, etc) is only available     #
+# during the second search. If you are trying to make a closed server #
 # you will probably need a connect block just for user registration.  #
 # This can be done by using <connect registered="no">                 #
 
 # To enable IRCCloud on your network uncomment this:
 #<include file="examples/providers/irccloud.conf.example">
 
-# To enable KiwiIRC.com on your network uncomment this:
-#<include file="examples/providers/kiwiirc-com.conf.example">
-
 # A connect class with <connect:deny> set denies connections from the specified host/IP range.
 <connect
          # deny: Will not let people connect if they have specified host/IP.
@@ -305,8 +294,8 @@
          # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
          globalmax="3"
 
-         # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
-         maxconnwarn="off"
+         # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to yes)
+         maxconnwarn="no"
 
          # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
          # in this class. This can save a lot of resources on very busy servers.
@@ -341,10 +330,10 @@
          # Requires the ident module to be loaded.
          #requireident="yes"
 
-         # requiressl: Require that users of this block use an SSL connection.
-         # This can also be set to "trusted", as to only accept certificates
+         # requiressl: Require that users of this block use a TLS (SSL) connection.
+         # This can also be set to "trusted", as to only accept client certificates
          # issued by a certificate authority that you can configure in the
-         # settings of the SSL module that you're using.
+         # settings of the TLS (SSL) module that you're using.
          # Requires the sslinfo module to be loaded.
          #requiressl="yes"
 
@@ -436,7 +425,7 @@
          # immediately killing them; their commands are held in the recvq and processed later
          # as the user's command penalty drops. Note that if this is enabled, flooders will
          # quit with "RecvQ exceeded" rather than "Excess Flood".
-         fakelag="on"
+         fakelag="yes"
 
          # localmax: Maximum local connections per IP.
          localmax="3"
@@ -696,8 +685,9 @@
          #  - stripcolor      Channel mode +S - strips formatting codes from
          #                    messages (requires the stripcolor module).
          #  - topiclock       Channel mode +t - limits changing the topic to (half)ops
-         # You can also configure this on a per-channel basis with a channel mode.
-         # See m_exemptchanops in modules.conf.example for more details.
+         # You can also configure this on a per-channel basis with a channel mode and
+         # even negate the configured exemptions below.
+         # See 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.
@@ -729,13 +719,13 @@
              # connections. If defined, it sets a soft max connections value.
              softlimit="12800"
 
-             # clonesonconnect: If this is set to false, we won't check for clones
+             # clonesonconnect: If this is set to no, we won't check for clones
              # on initial connection, but only after the DNS check is done.
              # This can be useful where your main class is more restrictive
              # than some other class a user can be assigned after DNS lookup is complete.
              # Turning this option off will make the server spend more time on users we may
-             # potentially not want. Normally this should be neglible, though.
-             # Default value is true
+             # potentially not want. Normally this should be negligible, though.
+             # Default value is yes
              clonesonconnect="yes"
 
              # timeskipwarn: The time period that a server clock can jump by before
@@ -837,13 +827,8 @@
 #                                                                     #
 # This configuration tag defines the maximum sizes of various types   #
 # on IRC, such as the maximum length of a channel name, and the       #
-# maximum length of a channel. Note that with the exception of the    #
-# identmax value all values given here are the exact values you would #
-# expect to see on IRC. This contrasts with the older InspIRCd        #
-# releases where these values would be one character shorter than     #
-# defined to account for a null terminator on the end of the text.    #
-#                                                                     #
-# These values should match network-wide otherwise issues will occur. #
+# maximum length of a channel. These values should match network-wide #
+# otherwise issues will occur.                                        #
 #                                                                     #
 # The highest safe value you can set any of these options to is 500,  #
 # but it is recommended that you keep them somewhat                   #
@@ -904,7 +889,7 @@
 # There are many different types which may be used, and modules may
 # generate their own. A list of useful types:
 #  - USERS - information relating to user connection and disconnection
-#  - OPER - succesful and failed oper attempts
+#  - OPER - successful and failed oper attempts
 #  - KILL - kill related messages
 #  - FILTER - messages related to filter matches (filter module)
 #  - CONFIG - configuration related messages
@@ -978,10 +963,10 @@
 
 <badnick
          # nick: Nick to disallow. Wildcards are supported.
-         nick="ChanServ"
+         nick="Tr0ll123"
 
          # reason: Reason to display on /NICK.
-         reason="Reserved for a network service">
+         reason="Don't use this nick.">
 
 <badhost
          # host: ident@hostname to ban.