1 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
3 # Configure the port and address bindings for linking here. #
5 # Refer to the port configuration section in inspircd.conf.example #
6 # for more information about the available options. #
9 # TLS (SSL) listener that binds on a TCP/IP endpoint:
10 <bind address="1.2.3.4"
15 # Plaintext listener that binds on a TCP/IP endpoint:
21 #-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-#
23 # Defines which servers can link to this one, and which servers this #
24 # server may create outbound links to. #
26 # ____ _ _____ _ _ ____ _ _ _ #
27 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
28 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
29 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
30 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
32 # If you want to link servers to InspIRCd you must load the #
33 # spanningtree module! If you do not load this module, server ports #
38 # name: The name of the remote server. This must match
39 # the <server:name> value of the remote server.
40 name="hub.example.org"
42 # ipaddr: The IP address of the remote server.
43 # Can also be a hostname, but hostname must resolve.
44 ipaddr="penguin.example.org"
46 # port: The port to connect to the server on.
47 # It must be bound as a server port on the other server.
50 # allowmask: Range of IP addresses to allow for this link.
51 # Can be a CIDR (see example).
52 allowmask="203.0.113.0/24 127.0.0.0/8 2001:db8::/32"
54 # timeout: If defined, this option defines how long the server
55 # will wait to consider the connect attempt failed and try the
56 # failover (see above).
59 # ssl: If defined, this states the TLS (SSL) profile that will be used when
60 # making an outbound connection to the server. Options are the name of an
61 # <sslprofile> tag that you have defined or one of "openssl", "gnutls",
62 # "mbedtls" if you have not defined any. See the docs page for the TLS (SSL)
63 # module you are using for more details.
65 # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
66 # for GnuTLS and ssl_mbedtls for mbedTLS. The server port that you
67 # connect to must be capable of accepting this type of connection.
70 # fingerprint: If defined, this option will force servers to be
71 # authenticated using TLS (SSL) certificate fingerprints. See
72 # https://docs.inspircd.org/3/modules/spanningtree for more information.
73 # This will require a TLS (SSL) link for both inbound and outbound connections.
76 # bind: Local IP address to bind to.
79 # statshidden: Defines if IP is shown to opers when
80 # /STATS c is invoked.
83 # hidden: If this is set to yes, this server and its "child"
84 # servers will not be shown when users do a /MAP or /LINKS.
87 # passwords: The passwords we send and receive.
88 # The remote server will have these passwords reversed.
89 # Passwords that contain a space character or begin with
90 # a colon (:) are invalid and may not be used.
91 sendpass="outgoing!password"
92 recvpass="incoming!password">
94 # A duplicate of the first link block without comments,
95 # if you like copying & pasting.
96 <link name="hub.example.org"
97 ipaddr="penguin.example.org"
99 allowmask="203.0.113.0/24 127.0.0.0/8 2001:db8::/32"
105 sendpass="outgoing!password"
106 recvpass="incoming!password">
108 # Link block for services. Options are the same as for the first
109 # link block (depending on what your services package supports).
110 <link name="services.example.com"
113 allowmask="127.0.0.0/8"
115 recvpass="polarbears">
117 # Simple autoconnect block. This enables automatic connections to a server.
118 # Recommended setup is to have leaves connect to the hub, and have no
119 # automatic connections started by the hub.
120 <autoconnect period="10m" server="hub.example.org">
122 # Failover autoconnect block. If you have multiple hubs, or want your network
123 # to automatically link even if the hub is down, you can specify multiple
124 # space separated servers to autoconnect; they will be tried in a round
125 # robin fashion until one succeeds. Period defines the time for restarting
127 <autoconnect period="2m"
128 server="hub.us.example.org hub.eu.example.org leaf.eu.example.org">
131 #-#-#-#-#-#-#-#-#-#-#-#-# U-LINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
132 # This tag defines a U-lined server. A U-lined server has special #
133 # permissions, and should be used with caution. Services servers are #
134 # usually U-lined in this manner. #
136 # The 'silent' value, if set to yes, indicates that this server should #
137 # not generate quit and connect notices, which can cut down on noise #
138 # to opers on the network. #
140 <uline server="services.example.com" silent="yes">
142 # Once you have edited this file you can remove this line. This is just to
143 # ensure that you don't hastily include the file without reading it.
144 <die reason="Using links.conf.example without editing it is a security risk">