inspircd/docs/conf/links.conf.example
Peter Powell a5d110282a Update wiki links to use HTTPS and point to the correct pages.
When we release 3.0 these links will break as they will point to
the pages for 3.0 rather than 2.0.
2017-10-15 12:23:10 +01:00

119 lines
5.1 KiB
Plaintext

#-#-#-#-#-#-#-#-#-#-#- 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! #
# #
# #
<link
# name: The name of the remote server. This must match
# the <server:name> value of the remote server.
name="hub.example.org"
# ipaddr: The IP address of the remote server.
# Can also be a hostname, but hostname must resolve.
ipaddr="penguin.example.org"
# 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="203.0.113.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 the SSL module that will be used when
# making an outbound connection to the server. Options are: "openssl"
# and "gnutls" (they are compatible with each other).
#
# You will need to load the m_ssl_openssl.so module for OpenSSL,
# m_ssl_gnutls.so for GnuTLS. 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 https://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.
# 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
# if you like copying & pasting.
<link name="hub.example.org"
ipaddr="penguin.example.org"
port="7000"
allowmask="203.0.113.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.example.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.example.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
# 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"
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. #
# #
<uline server="services.example.com" silent="yes">