X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Flinks.conf.example;h=3b25e86f4cedfe953315547c41e7bf0ccc63a339;hb=5a19ff00aca5d979bf9ca45a2b0d6e85acdc9fc3;hp=0b8b234383a8f7162e101e81d3d020d5adffca0e;hpb=6fe1f4e1136f2ab95a88e68af1894bf6002d03f4;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/docs/conf/links.conf.example b/docs/conf/links.conf.example
index 0b8b23438..3b25e86f4 100644
--- 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"
+      ssl="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          #
-#  m_spanningtree.so module!                                          #
-#                                                                     #
+#  spanningtree module! If you do not load this module, server ports  #
+#  will NOT work!                                                     #
 #                                                                     #
 
 <link
@@ -34,21 +54,25 @@
       # timeout: If defined, this option defines how long the server
       # will wait to consider the connect attempt failed and try the
       # failover (see above).
-      timeout="300"
+      timeout="5m"
 
-      # ssl: If defined, this states the SSL module that will be used when
-      # making an outbound connection to the server. Options are: "openssl"
-      # and "gnutls" (they are compatible with each other).
+      # ssl: 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 m_ssl_openssl.so module for OpenSSL,
-      # m_ssl_gnutls.so for GnuTLS. The server port that you connect to
-      # must be capable of accepting this type of connection.
-      ssl="gnutls"
+      # 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="Servers"
 
       # fingerprint: If defined, this option will force servers to be
-      # authenticated using SSL certificate fingerprints. See
-      # http://wiki.inspircd.org/SSL for more information. This will
-      # require an SSL link for both inbound and outbound connections.
+      # authenticated using TLS (SSL) certificate fingerprints. See
+      # https://docs.inspircd.org/3/modules/spanningtree for more information.
+      # This will require a TLS (SSL) link for both inbound and outbound connections.
       #fingerprint=""
 
       # bind: Local IP address to bind to.
@@ -62,21 +86,21 @@
       # servers will not be shown when users do a /MAP or /LINKS.
       hidden="no"
 
-      # passwords: the passwords we send and receive.
+      # passwords: The passwords we send and receive.
       # The remote server will have these passwords reversed.
       # Passwords that contain a space character or begin with
       # a colon (:) are invalid and may not be used.
       sendpass="outgoing!password"
       recvpass="incoming!password">
 
-# A duplicate of the first link block without comments
+# A duplicate of the first link block without comments,
 # if you like copying & pasting.
 <link name="hub.example.org"
       ipaddr="penguin.example.org"
       port="7000"
-      allowmask="203.0.113.0/24"
-      timeout="300"
-      ssl="gnutls"
+      allowmask="203.0.113.0/24 127.0.0.0/8 2001:db8::/32"
+      timeout="5m"
+      ssl="Servers"
       bind="1.2.3.4"
       statshidden="no"
       hidden="no"
@@ -92,7 +116,7 @@
       sendpass="penguins"
       recvpass="polarbears">
 
-# Simple autoconnect block. This enables automatic connection of a server
+# Simple autoconnect block. This enables automatic connections to a server.
 # Recommended setup is to have leaves connect to the hub, and have no
 # automatic connections started by the hub.
 <autoconnect period="10m" server="hub.example.org">
@@ -102,17 +126,21 @@
 # space separated servers to autoconnect; they will be tried in a round
 # robin fashion until one succeeds. Period defines the time for restarting
 # a single loop.
-<autoconnect period="120"
+<autoconnect period="2m"
 	server="hub.us.example.org hub.eu.example.org leaf.eu.example.org">
 
 
-#-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
-# This tag defines a ulined server. A U-Lined server has special      #
-# permissions, and should be used with caution. Services servers are  #
-# usually u-lined in this manner.                                     #
-#                                                                     #
-# The 'silent' value, if set to yes, indicates that this server should#
-# not generate quit and connect notices, which can cut down on noise  #
-# to opers on the network.                                            #
-#                                                                     #
+#-#-#-#-#-#-#-#-#-#-#-#-# U-LINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
+# This tag defines a U-lined server. A U-lined server has special       #
+# permissions, and should be used with caution. Services servers are    #
+# usually U-lined in this manner.                                       #
+#                                                                       #
+# The 'silent' value, if set to yes, indicates that this server should  #
+# not generate quit and connect notices, which can cut down on noise    #
+# to opers on the network.                                              #
+#                                                                       #
 <uline server="services.example.com" silent="yes">
+
+# Once you have edited this file you can remove this line. This is just to
+# ensure that you don't hastily include the file without reading it.
+<die reason="Using links.conf.example without editing it is a security risk">