Various text improvements: consistency, syntax, help and doc updates/fixes.

[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 f3e07f7ed4e55021f87bf67d03273a76456ba8dd..735cac30444c07b209d94f68535407c1cf4c9253 100644 (file)
--- a/docs/conf/links.conf.example
+++ b/docs/conf/links.conf.example
@@ -34,7 +34,7 @@
       # 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 profile that will be used when
       # making an outbound connection to the server. Options are the name of an
@@ -49,7 +49,7 @@
 
       # 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=""
 
@@ -64,20 +64,20 @@
       # 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"
+      allowmask="203.0.113.0/24 127.0.0.0/8 2001:db8::/32"
+      timeout="5m"
       ssl="gnutls"
       bind="1.2.3.4"
       statshidden="no"
@@ -94,7 +94,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">
@@ -104,17 +104,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">