Rename `<bind:ssl>` to `<bind:sslprofile>`.

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

diff --git a/docs/conf/links.conf.example b/docs/conf/links.conf.example
index 256ac10f9e6f9e0c41521dd3ab4f25d8f5777bbf..19d770d3530a3368fb64f7db3fd681657f6b9003 100644 (file)
--- a/docs/conf/links.conf.example
+++ b/docs/conf/links.conf.example
@@ -1,3 +1,23 @@
+#-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
+#                                                                     #
+#   Configure the port and address bindings for linking here.         #
+#                                                                     #
+#   Refer to the port configuration section in inspircd.conf.example  #
+#   for more information about the available options.                 #
+#                                                                     #
+
+# TLS (SSL) listener that binds on a TCP/IP endpoint:
+<bind address="1.2.3.4"
+      port="7005"
+      type="servers"
+      sslprofile="Servers">
+
+# Plaintext listener that binds on a TCP/IP endpoint:
+<bind address=""
+      port="7000,7001"
+      type="servers">
+
+
 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # Defines which servers can link to this one, and which servers this  #
@@ -10,8 +30,8 @@
 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 #                                                                     #
 #  If you want to link servers to InspIRCd you must load the          #
-#  spanningtree module!                                               #
-#                                                                     #
+#  spanningtree module! If you do not load this module, server ports  #
+#  will NOT work!                                                     #
 #                                                                     #
 
 <link
@@ -36,16 +56,18 @@
       # failover (see above).
       timeout="5m"
 
-      # ssl: If defined, this states the TLS (SSL) profile that will be used when
-      # making an outbound connection to the server. Options are the name of an
-      # <sslprofile> tag that you have defined or one of "openssl", "gnutls",
-      # "mbedtls" if you have not defined any. See the docs page for the TLS (SSL)
-      # module you are using for more details.
+      # sslprofile: If defined, this states the TLS (SSL) profile that will be used
+      # when making an outbound connection to the server. See the docs page for
+      # the TLS (SSL) module you are using for more details:
+      #
+      # GnuTLS:  https://docs.inspircd.org/3/modules/ssl_gnutls#sslprofile
+      # mbedTLS: https://docs.inspircd.org/3/modules/ssl_mbedtls#sslprofile
+      # OpenSSL: https://docs.inspircd.org/3/modules/ssl_openssl#sslprofile
       #
       # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
       # for GnuTLS and ssl_mbedtls for mbedTLS. The server port that you
       # connect to must be capable of accepting this type of connection.
-      ssl="gnutls"
+      sslprofile="Servers"
 
       # fingerprint: If defined, this option will force servers to be
       # authenticated using TLS (SSL) certificate fingerprints. See
@@ -78,7 +100,7 @@
       port="7000"
       allowmask="203.0.113.0/24 127.0.0.0/8 2001:db8::/32"
       timeout="5m"
-      ssl="gnutls"
+      sslprofile="Servers"
       bind="1.2.3.4"
       statshidden="no"
       hidden="no"