Move configuration examples to docs, remove automatic overwrite on make install

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@12383 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 120 insertions, 0 deletions

diff --git a/docs/links.conf.example b/docs/links.conf.example
new file mode 100644
index 000000000..2357220f9
--- /dev/null
+++ b/docs/links.conf.example
@@ -0,0 +1,120 @@
+#-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# Defines which servers can link to this one, and which servers this  #
+# server may create outbound links to.                                #
+#                                                                     #
+#    ____                _   _____ _     _       ____  _ _   _        #
+#   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
+#   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
+#   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
+#   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
+#                                                                     #
+#  If you want to link servers to InspIRCd you must load the          #
+#  m_spanningtree.so module! Please see the modules list below for    #
+#  information on how to load this module! If you do not load this    #
+#  module, server links will NOT work!                                #
+#                                                                     #
+#                                                                     #
+
+<link
+      # name: The name of the remote server. This must match
+      # the <server:name> value of the remote server.
+      name="hub.penguin.org"
+
+      # ipaddr: The IP address of the remote server.
+      # Can also be a hostname, but hostname must resolve.
+      ipaddr="penguin.box.com"
+
+      # port: The port to connect to the server on.
+      # It must be bound as a server port on the other server.
+      port="7000"
+
+      # allowmask: Range of IP addresses to allow for this link.
+      # Can be a CIDR (see example).
+      allowmask="69.58.44.0/24"
+
+      # 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"
+
+      # ssl: If defined, this states extra modules that will be used when
+      # making an outbound connection to the server. Options are: "openssl"
+      # and "gnutls" for encryption (they are compatible with each other) and
+      # "ziplinks" for compression. You must use the same (or a compatible)
+      # transport on both sides of the link.
+      #
+      # You will need to load the m_ssl_openssl.so module for openssl,
+      # m_ssl_gnutls.so for gnutls or m_ziplinks.so for ziplinks. 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 Fingerprints. See http://wiki.inspircd.org/SSL
+      # for more information. This will require an SSL link for both inbound
+      # and outbound connections.
+      #fingerprint=""
+
+      # bind: Local IP address to bind to.
+      bind="1.2.3.4"
+
+      # statshidden: defines if IP is shown to opers when
+      # /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
+      hidden="no"
+
+      # passwords: the passwords we send and receive.
+      # The remote server will have these passwords reversed.
+      sendpass="outgoing!password"
+      recvpass="incoming!password">
+
+# A duplicate of the first link block without comments
+# if you like copying & pasting.
+<link name="hub.penguin.org"
+      ipaddr="penguin.box.com"
+      port="7000"
+      allowmask="69.58.44.0/24"
+      timeout="300"
+      ssl="gnutls"
+      bind="1.2.3.4"
+      statshidden="no"
+      hidden="no"
+      sendpass="outgoing!password"
+      recvpass="incoming!password">
+
+# 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"
+      ipaddr="localhost"
+      port="7000"
+      allowmask="127.0.0.0/8"
+      sendpass="penguins"
+      recvpass="polarbears">
+
+# 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="300" server="hub.penguin.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
+# 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">
+
+
+#-#-#-#-#-#-#-#-#-#-#-#- 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.                                            #
+#                                                                     #
+<uline server="services.antarctic.com" silent="yes">