docs/conf/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 #  spanningtree 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.example.org"
  21
  22       # ipaddr: The IP address of the remote server.
  23       # Can also be a hostname, but hostname must resolve.
  24       ipaddr="penguin.example.org"
  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="203.0.113.0/24 127.0.0.0/8 2001:db8::/32"
  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="5m"
  38
  39       # ssl: If defined, this states the SSL profile that will be used when
  40       # making an outbound connection to the server. Options are the name of an
  41       # <sslprofile> tag that you have defined or one of "openssl", "gnutls",
  42       # "mbedtls" if you have not defined any. See the wiki page for the SSL
  43       # module you are using for more details.
  44       #
  45       # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
  46       # for GnuTLS and ssl_mbedtls for mbedTLS. The server port that you
  47       # connect to must be capable of accepting this type of connection.
  48       ssl="gnutls"
  49
  50       # fingerprint: If defined, this option will force servers to be
  51       # authenticated using SSL certificate fingerprints. See
  52       # https://wiki.inspircd.org/SSL for more information. This will
  53       # require an SSL link for both inbound and outbound connections.
  54       #fingerprint=""
  55
  56       # bind: Local IP address to bind to.
  57       bind="1.2.3.4"
  58
  59       # statshidden: Defines if IP is shown to opers when
  60       # /STATS c is invoked.
  61       statshidden="no"
  62
  63       # hidden: If this is set to yes, this server and its "child"
  64       # servers will not be shown when users do a /MAP or /LINKS.
  65       hidden="no"
  66
  67       # passwords: the passwords we send and receive.
  68       # The remote server will have these passwords reversed.
  69       # Passwords that contain a space character or begin with
  70       # a colon (:) are invalid and may not be used.
  71       sendpass="outgoing!password"
  72       recvpass="incoming!password">
  73
  74 # A duplicate of the first link block without comments
  75 # if you like copying & pasting.
  76 <link name="hub.example.org"
  77       ipaddr="penguin.example.org"
  78       port="7000"
  79       allowmask="203.0.113.0/24"
  80       timeout="5m"
  81       ssl="gnutls"
  82       bind="1.2.3.4"
  83       statshidden="no"
  84       hidden="no"
  85       sendpass="outgoing!password"
  86       recvpass="incoming!password">
  87
  88 # Link block for services. Options are the same as for the first
  89 # link block (depending on what your services package supports).
  90 <link name="services.example.com"
  91       ipaddr="localhost"
  92       port="7000"
  93       allowmask="127.0.0.0/8"
  94       sendpass="penguins"
  95       recvpass="polarbears">
  96
  97 # Simple autoconnect block. This enables automatic connection of a server
  98 # Recommended setup is to have leaves connect to the hub, and have no
  99 # automatic connections started by the hub.
 100 <autoconnect period="10m" server="hub.example.org">
 101
 102 # Failover autoconnect block. If you have multiple hubs, or want your network
 103 # to automatically link even if the hub is down, you can specify multiple
 104 # space separated servers to autoconnect; they will be tried in a round
 105 # robin fashion until one succeeds. Period defines the time for restarting
 106 # a single loop.
 107 <autoconnect period="2m"
 108         server="hub.us.example.org hub.eu.example.org leaf.eu.example.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.example.com" silent="yes">