docs/links.conf.example

   1 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
   2 #                                                                     #
   3 # Defines which servers can link to this one, and which servers this  #
   4 # server may create outbound links to.                                #
   5 #                                                                     #
   6 #    ____                _   _____ _     _       ____  _ _   _        #
   7 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
   8 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
   9 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
  10 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
  11 #                                                                     #
  12 #  If you want to link servers to InspIRCd you must load the          #
  13 #  m_spanningtree.so module! Please see the modules list below for    #
  14 #  information on how to load this module! If you do not load this    #
  15 #  module, server links will NOT work!                                #
  16 #                                                                     #
  17 #                                                                     #
  18
  19 <link
  20       # name: The name of the remote server. This must match
  21       # the <server:name> value of the remote server.
  22       name="hub.penguin.org"
  23
  24       # ipaddr: The IP address of the remote server.
  25       # Can also be a hostname, but hostname must resolve.
  26       ipaddr="penguin.box.com"
  27
  28       # port: The port to connect to the server on.
  29       # It must be bound as a server port on the other server.
  30       port="7000"
  31
  32       # allowmask: Range of IP addresses to allow for this link.
  33       # Can be a CIDR (see example).
  34       allowmask="69.58.44.0/24"
  35
  36       # timeout: If defined, this option defines how long the server
  37       # will wait to consider the connect attempt failed and try the
  38       # failover (see above).
  39       timeout="300"
  40
  41       # ssl: If defined, this states extra modules that will be used when
  42       # making an outbound connection to the server. Options are: "openssl"
  43       # and "gnutls" for encryption (they are compatible with each other) and
  44       # "ziplinks" for compression. You must use the same (or a compatible)
  45       # transport on both sides of the link.
  46       #
  47       # You will need to load the m_ssl_openssl.so module for openssl,
  48       # m_ssl_gnutls.so for gnutls or m_ziplinks.so for ziplinks. The server
  49       # port that you connect to must be capable of accepting this type of
  50       # connection.
  51       ssl="gnutls"
  52
  53       # fingerprint: If defined, this option will force servers to be
  54       # authenticated using SSL Fingerprints. See http://wiki.inspircd.org/SSL
  55       # for more information. This will require an SSL link for both inbound
  56       # and outbound connections.
  57       #fingerprint=""
  58
  59       # bind: Local IP address to bind to.
  60       bind="1.2.3.4"
  61
  62       # statshidden: defines if IP is shown to opers when
  63       # /stats c is invoked.
  64       statshidden="no"
  65
  66       # hidden: If this is set to yes, this server and its "child"
  67       # servers will not be shown when users do a /map or /links
  68       hidden="no"
  69
  70       # passwords: the passwords we send and receive.
  71       # The remote server will have these passwords reversed.
  72       sendpass="outgoing!password"
  73       recvpass="incoming!password">
  74
  75 # A duplicate of the first link block without comments
  76 # if you like copying & pasting.
  77 <link name="hub.penguin.org"
  78       ipaddr="penguin.box.com"
  79       port="7000"
  80       allowmask="69.58.44.0/24"
  81       timeout="300"
  82       ssl="gnutls"
  83       bind="1.2.3.4"
  84       statshidden="no"
  85       hidden="no"
  86       sendpass="outgoing!password"
  87       recvpass="incoming!password">
  88
  89 # Link block for services. Options are the same as for the first
  90 # link block (depending on what your services package supports).
  91 <link name="services.antarctic.com"
  92       ipaddr="localhost"
  93       port="7000"
  94       allowmask="127.0.0.0/8"
  95       sendpass="penguins"
  96       recvpass="polarbears">
  97
  98 # Simple autoconnect block. This enables automatic connection of a server
  99 # Recommended setup is to have leaves connect to the hub, and have no
 100 # automatic connections started by the hub.
 101 <autoconnect period="300" server="hub.penguin.org">
 102
 103 # Failover autoconnect block. If you have multiple hubs, or want your network
 104 # to automatically link even if the hub is down, you can specify multiple
 105 # servers to autoconnect; they will be tried in a round robin fashion until
 106 # one succeeds. Period defines the time for restarting a single loop.
 107 <autoconnect period="120"
 108         server="hub.us.penguin.org hub.eu.penguin.org leaf.eu.penguin.org">
 109
 110
 111 #-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
 112 # This tag defines a ulined server. A U-Lined server has special      #
 113 # permissions, and should be used with caution. Services servers are  #
 114 # usually u-lined in this manner.                                     #
 115 #                                                                     #
 116 # The 'silent' value, if set to yes, indicates that this server should#
 117 # not generate quit and connect notices, which can cut down on noise  #
 118 # to opers on the network.                                            #
 119 #                                                                     #
 120 <uline server="services.antarctic.com" silent="yes">