mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-07-10 18:48:11 -07:00
Updated documentation
This commit is contained in:
@@ -1136,6 +1136,12 @@ These can be used to control various aspects of interface behaviour.
|
||||
> link or a remote TCP tunnel) solely to discover better local
|
||||
> infrastructure, which then supersedes the bootstrap interface.
|
||||
>
|
||||
> * The `recursive_prs` option allows you to enable recursive path
|
||||
> discovery on an interface regardless of its configured interface
|
||||
> mode. When this option is enabled, Reticulum will attempt to
|
||||
> recursively discover paths for path requests received on this
|
||||
> interface.
|
||||
>
|
||||
|
||||
## Interface Modes
|
||||
|
||||
@@ -1211,6 +1217,15 @@ the default mode.
|
||||
> public Transport Node available on the Internet, the interface
|
||||
> connecting over the Internet should be set to `boundary` mode.
|
||||
>
|
||||
> * The `internal` mode designates interfaces that belong to an
|
||||
> network different from any marked as `boundary`. Announces from
|
||||
> a `boundary` interface will not propagate to interfaces set as
|
||||
> `internal`, but announces *will* propagate from `internal` *to*
|
||||
> `boundary`. Devices on the `internal` side of the network will
|
||||
> still be able to resolve paths to destinations across the boundary
|
||||
> when needed, since recursive path requests are enabled for `internal`
|
||||
> mode interfaces by default.
|
||||
>
|
||||
|
||||
For a table describing the impact of all modes on announce propagation,
|
||||
please see the [Announce Propagation Rules](understanding.md#understanding-announcepropagation) section.
|
||||
|
||||
@@ -632,30 +632,55 @@ but excluding any interface access codes.
|
||||
|
||||
The following table illustrates the rules for automatically propagating announces from one interface type to another, for all possible combinations. For the purpose of announce propagation, the *Full* and *Gateway* modes are identical.
|
||||
|
||||

|
||||
|
||||
See the [Interface Modes](interfaces.md#interfaces-modes) section for a conceptual overview of the different interface modes, and how they are configured.
|
||||
|
||||

|
||||
|
||||
Or, represented in table form:
|
||||
|
||||

|
||||
<!-- (.. code-block:: text)
|
||||
Full ────── ✓ ──┐ ┌── ✓ ── Full
|
||||
AP ──────── ✓ ──┼───> Full >───┼── ✕ ── AP
|
||||
Boundary ── ✓ ──┤ ├── ✓ ── Boundary
|
||||
AP ──────── ✓ ──┤ ├── ✕ ── AP
|
||||
Boundary ── ✓ ──┼───> Full >───┼── ✓ ── Boundary
|
||||
Internal ── ✓ ──┤ ├── ✓ ── Internal
|
||||
Roaming ─── ✓ ──┘ └── ✓ ── Roaming
|
||||
|
||||
Full ────── ✕ ──┐ ┌── ✓ ── Full
|
||||
AP ──────── ✕ ──┼────> AP >────┼── ✕ ── AP
|
||||
Boundary ── ✕ ──┤ ├── ✓ ── Boundary
|
||||
AP ──────── ✕ ──┤ ├── ✕ ── AP
|
||||
Boundary ── ✕ ──┼────> AP >────┼── ✓ ── Boundary
|
||||
Internal ── ✕ ──┤ ├── ✓ ── Internal
|
||||
Roaming ─── ✕ ──┘ └── ✓ ── Roaming
|
||||
|
||||
Full ────── ✓ ──┐ ┌── ✓ ── Full
|
||||
AP ──────── ✓ ──┼─> Roaming >──┼── ✕ ── AP
|
||||
Boundary ── ✕ ──┤ ├── ✕ ── Boundary
|
||||
AP ──────── ✓ ──┤ ├── ✕ ── AP
|
||||
Boundary ── ✕ ──┼─> Roaming >──┼── ✕ ── Boundary
|
||||
Internal ── ✕ ──┤ ├── ✕ ── Internal
|
||||
Roaming ─── ✕ ──┘ └── ✕ ── Roaming
|
||||
|
||||
Full ────── ✓ ──┐ ┌── ✓ ── Full
|
||||
AP ──────── ✓ ──┼─> Boundary >─┼── ✕ ── AP
|
||||
Boundary ── ✓ ──┤ ├── ✓ ── Boundary
|
||||
Roaming ─── ✕ ──┘ └── ✕ ── Roaming -->
|
||||
AP ──────── ✓ ──┤ ├── ✕ ── AP
|
||||
Boundary ── ✓ ──┼─> Boundary >─┼── ✓ ── Boundary
|
||||
Internal ── ✓ ──┤ ├── ✕ ── Internal
|
||||
Roaming ─── ✕ ──┘ └── ✕ ── Roaming
|
||||
|
||||
Full ────── ✓ ──┐ ┌── ✓ ── Full
|
||||
AP ──────── ✓ ──┤ ├── ✕ ── AP
|
||||
Boundary ── ✕ ──┼─> Internal >─┼── ✓ ── Boundary
|
||||
Internal ── ✓ ──┤ ├── ✓ ── Internal
|
||||
Roaming ─── ✕ ──┘ └── ✕ ── Roaming
|
||||
|
||||
dest → Full AP Boundary Roaming Gateway Internal
|
||||
source ↓
|
||||
Full ✓ ✕ ✓ ✓ ✓ ✓
|
||||
Gateway ✓ ✕ ✓ ✓ ✓ ✓
|
||||
AP ✓ ✕ ✓ ✓ ✓ ✓
|
||||
Boundary ✓ ✕ ✓ ✕ ✓ ✕
|
||||
Internal ✓ ✕ ✓ ✕ ✓ ✓
|
||||
Roaming ✓ ✕ ✕ ✕ ✓ ✕
|
||||
|
||||
✓ Will rebroadcast announce
|
||||
✕ Will not rebroadcast announce -->
|
||||
|
||||
### Cryptographic Primitives
|
||||
|
||||
|
||||
Reference in New Issue
Block a user