Update user-facing text and comments of SSL to TLS.

[user/henk/code/inspircd.git] / docs / conf / inspircd.conf.example

diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example
index 832c30b39d25ea0a641efba56d1880ac2cb70a08..1544666a9c914a1784dc859c7f736fd1e8c4fe68 100644 (file)
--- a/docs/conf/inspircd.conf.example
+++ b/docs/conf/inspircd.conf.example
@@ -153,10 +153,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.
@@ -193,6 +193,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
@@ -208,11 +211,11 @@
 # 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 this listener. 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)
@@ -241,11 +244,17 @@
 # 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.
@@ -254,7 +263,7 @@
          # reason: The message that users will see if they match a deny block.
          reason="The 6bone address space is deprecated">
 
-# A connect class with <connect:allow> set allows connections from the specified host/IP range.
+# A connect class with <connect:allow> set allows c from the specified host/IP range.
 <connect
          # name: Name to use for this connect block. Mainly used for
          # connect class inheriting.
@@ -284,7 +293,7 @@
          password="secret"
 
          # maxchans: Maximum number of channels a user in this class
-         # be in at one time.
+         # can be in at one time.
          maxchans="20"
 
          # timeout: How long the server will wait before disconnecting
@@ -335,10 +344,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"
 
@@ -382,7 +391,7 @@
          allow="*"
 
          # maxchans: Maximum number of channels a user in this class
-         # be in at one time.
+         # can be in at one time.
          maxchans="20"
 
          # timeout: How long the server will wait before disconnecting
@@ -655,6 +664,10 @@
          # link with servers running 2.0. Defaults to yes.
          allowzerolimit="no"
 
+         # modesinlist: If enabled then the current channel modes will be shown
+         # in the /LIST response. Defaults to yes.
+         modesinlist="no"
+
          # exemptchanops: Allows users with with a status mode to be exempt
          # from various channel restrictions. Possible restrictions are:
          #  - anticaps        Channel mode +B - blocks messages with too many capital
@@ -726,7 +739,7 @@
              # 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
-             clonesonconnect="true"
+             clonesonconnect="yes"
 
              # timeskipwarn: The time period that a server clock can jump by before
              # operators will be warned that the server is having performance issues.