Merge tag 'v2.0.27' into master.

[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 7f27affb92a8b1690bdcca98f76c322806eab0ef..ad2efa9f7f5bd6db03e24982ffef3819ce602a35 100644 (file)
--- a/docs/conf/links.conf.example
+++ b/docs/conf/links.conf.example
@@ -10,18 +10,18 @@
 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 #                                                                     #
 #  If you want to link servers to InspIRCd you must load the          #
-#  m_spanningtree.so module!                                          #
+#  spanningtree module!                                               #
 #                                                                     #
 #                                                                     #
 
 <link
       # name: The name of the remote server. This must match
       # the <server:name> value of the remote server.
-      name="hub.penguin.org"
+      name="hub.example.org"
 
       # ipaddr: The IP address of the remote server.
       # Can also be a hostname, but hostname must resolve.
-      ipaddr="penguin.box.com"
+      ipaddr="penguin.example.org"
 
       # port: The port to connect to the server on.
       # It must be bound as a server port on the other server.
@@ -34,20 +34,22 @@
       # 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 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 wiki page for the SSL
+      # module you are using for more details.
       #
-      # 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.
+      # 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"
 
       # 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
+      # https://wiki.inspircd.org/SSL for more information. This will
       # require an SSL link for both inbound and outbound connections.
       #fingerprint=""
 
@@ -55,11 +57,11 @@
       bind="1.2.3.4"
 
       # statshidden: Defines if IP is shown to opers when
-      # /stats c is invoked.
+      # /STATS c is invoked.
       statshidden="no"
 
       # hidden: If this is set to yes, this server and its "child"
-      # servers will not be shown when users do a /map or /links
+      # servers will not be shown when users do a /MAP or /LINKS.
       hidden="no"
 
       # passwords: the passwords we send and receive.
@@ -71,11 +73,11 @@
 
 # A duplicate of the first link block without comments
 # if you like copying & pasting.
-<link name="hub.penguin.org"
-      ipaddr="penguin.box.com"
+<link name="hub.example.org"
+      ipaddr="penguin.example.org"
       port="7000"
       allowmask="203.0.113.0/24"
-      timeout="300"
+      timeout="5m"
       ssl="gnutls"
       bind="1.2.3.4"
       statshidden="no"
@@ -85,7 +87,7 @@
 
 # Link block for services. Options are the same as for the first
 # link block (depending on what your services package supports).
-<link name="services.antarctic.com"
+<link name="services.example.com"
       ipaddr="localhost"
       port="7000"
       allowmask="127.0.0.0/8"
@@ -95,15 +97,15 @@
 # Simple autoconnect block. This enables automatic connection of 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.penguin.org">
+<autoconnect period="10m" server="hub.example.org">
 
 # Failover autoconnect block. If you have multiple hubs, or want your network
 # to automatically link even if the hub is down, you can specify multiple
 # 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"
-       server="hub.us.penguin.org hub.eu.penguin.org leaf.eu.penguin.org">
+<autoconnect period="2m"
+       server="hub.us.example.org hub.eu.example.org leaf.eu.example.org">
 
 
 #-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
@@ -115,4 +117,8 @@
 # not generate quit and connect notices, which can cut down on noise  #
 # to opers on the network.                                            #
 #                                                                     #
-<uline server="services.antarctic.com" silent="yes">
+<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">