Skip to content

Commit 1b1b9d3

Browse files
committed
Even more color coded overlay/underlay ip addresses
1 parent cab6c7e commit 1b1b9d3

File tree

4 files changed

+12
-10
lines changed

4 files changed

+12
-10
lines changed

docs/config/relay.mdx

+7-5
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ relay:
2626
2727
In order to act as a relay for other hosts, `am_relay` must be set to true (default false.) In order to use relays, a
2828
host 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

3232
Hosts specify which other hosts may act as a relay when connecting to them via the `relays` option in the config. This
3333
allows 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
4749
relays:
@@ -50,7 +52,7 @@ relays:
5052
```
5153

5254
This 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

docs/config/sshd.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ See also the [Debugging with Nebula SSH commands](/docs/guides/debug-ssh-command
3838

3939
<Pill className="mb-24">Reloadable</Pill>
4040

41-
`listen` is used to specify the host ip and port number for the nebula debug console to listen on, port 22 is not
42-
allowed for your safety.
41+
`listen` is used to specify the <UnderlayIP>host ip</UnderlayIP> and port number for the nebula debug console to listen
42+
on, port 22 is not allowed for your safety.
4343

4444
## sshd.host_key
4545

docs/config/tun.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ Default MTU for every packet, safe setting is (and the default) 1300 for interne
6666

6767
<Pill className="mb-24">Reloadable</Pill>
6868

69-
Route based MTU overrides. If you have known VPN IP paths that can support larger MTUs you can increase/decrease them
70-
here.
69+
Route based MTU overrides. If you have known VPN <UnderlayIP>IP paths</UnderlayIP> that can support larger MTUs you can
70+
increase/decrease them here.
7171

7272
```yml
7373
tun:

src/components/UnderlayIP.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export function UnderlayIP({ children }) {
66
style={{
77
textDecorationColor: 'green',
88
textDecorationLine: 'underline',
9-
textDecorationStyle: 'dotted',
9+
textDecorationStyle: 'solid',
1010
textDecorationThickness: '2px',
1111
}}
1212
>

0 commit comments

Comments
 (0)