2626
2727In order to act as a relay for other hosts, ` am_relay` must be set to true (default false.) In order to use relays, a
2828host must have `use_relays` set to true (default true.) Any host can be a relay; it does not need to be a lighthouse.
29- However, like lighthouses, relay nodes should be deployed with a public internet IP and firewall rules that permit
30- Nebula's UDP traffic inbound.
29+ However, like lighthouses, relay nodes should be deployed with a <UnderlayIP> public internet IP</UnderlayIP> and
30+ firewall rules that permit Nebula's UDP traffic inbound.
3131
3232Hosts specify which other hosts may act as a relay when connecting to them via the `relays` option in the config. This
3333allows hosts to specify relays that are "close" to them. For example, if you have some Nebula hosts in a private AWS
@@ -40,8 +40,10 @@ their own config.
4040
4141<Pill className="mb-24">Reloadable</Pill>
4242
43- ` relays` is a list of Nebula IPs that peers can use to relay packets to this host. IPs in this list must have `am_relay`
44- set to `true` in their configs, otherwise they will reject relay requests.
43+ ` relays` is a list of <OverlayIP>Nebula IPs</OverlayIP> that peers can use to relay packets to this host.
44+
45+ <OverlayIP>IPs</OverlayIP> in this list must have `am_relay` set to `true` in their configs, otherwise they will reject relay
46+ requests.
4547
4648` ` ` yml
4749relays:
@@ -50,7 +52,7 @@ relays:
5052` ` `
5153
5254This list of relays is reported to the Lighthouse. When other nodes attempt to handshake with this host, the Lighthouse
53- will indicate its supported relays in addition to its known IP addresses.
55+ will indicate its supported relays in addition to its <UnderlayIP> known IP addresses</UnderlayIP> .
5456
5557# # relay.am_relay
5658
0 commit comments