mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-07-23 00:08:16 -07:00
Updated documentation
This commit is contained in:
@@ -1207,6 +1207,13 @@ 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.
|
||||
|
||||
.. _interfaces-modes:
|
||||
|
||||
Interface Modes
|
||||
@@ -1284,6 +1291,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 :ref:`Announce Propagation Rules<understanding-announcepropagation>` section.
|
||||
|
||||
|
||||
@@ -707,32 +707,58 @@ Announce Propagation Rules
|
||||
|
||||
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 :ref:`Interface Modes<interfaces-modes>` section for a conceptual overview of the different interface modes, and how they are configured.
|
||||
|
||||
.. image:: graphics/if_mode_graph_b.png
|
||||
|
||||
See the :ref:`Interface Modes<interfaces-modes>` section for a conceptual overview of the different interface modes, and how they are configured.
|
||||
Or, represented in table form:
|
||||
|
||||
.. image:: graphics/if_mode_graph_c.png
|
||||
|
||||
..
|
||||
(.. 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
|
||||
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
|
||||
|
||||
|
||||
.. _understanding-primitives:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user