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