mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-07-25 09:18:09 -07:00
Updated documentation
This commit is contained in:
@@ -1274,6 +1274,11 @@ These can be used to control various aspects of interface behaviour.
|
||||
``internal`` mode interfaces may still be resolvable by means
|
||||
of path requests.
|
||||
|
||||
|
||||
* | To allow an interface that would *otherwise not* propagate
|
||||
announces to ``internal`` mode interfaces to do so, you can
|
||||
configure the ``announces_to_internal`` option to ``True``.
|
||||
|
||||
.. _interfaces-modes:
|
||||
|
||||
Interface Modes
|
||||
|
||||
@@ -759,6 +759,8 @@ Or, represented in table form:
|
||||
✓ Will rebroadcast announce
|
||||
✕ Will not rebroadcast announce
|
||||
|
||||
For a visually intuitive overview of how announce propagation rules function in practice, you can take a look at the `Announce Propagation Simulator <https://rns.moscow/announce-sim.html>`_ hosted by `rns.moscow <https://rns.moscow/>`_.
|
||||
|
||||
|
||||
.. _understanding-primitives:
|
||||
|
||||
|
||||
@@ -1220,6 +1220,12 @@ The configuration snippet below contains an example of setting these additional
|
||||
network_identity = ~/.reticulum/storage/identities/my_network
|
||||
...
|
||||
|
||||
For more fine-grained control over how discovered interfaces are auto-connected, additional options are provided for configuraiton. These are not necessary to set in most cases, but can be useful in certain situations.
|
||||
|
||||
* The ``autoconnect_discovered_mode`` options specifies which mode discovered interfaces should be created with when auto-connecting.
|
||||
|
||||
* The ``autoconnect_announces_to_internal`` option allows you to specify that auto-connected interfaces should propagate announces to ``internal`` mode interfaces, even if the auto-connected interface's mode would normally not allow for this.
|
||||
|
||||
Remote Management
|
||||
-----------------
|
||||
|
||||
|
||||
@@ -1426,6 +1426,12 @@ do not propagate out when received, paths to destinations on
|
||||
of path requests.</div>
|
||||
</div>
|
||||
</li>
|
||||
<li><div class="line-block">
|
||||
<div class="line">To allow an interface that would <em>otherwise not</em> propagate
|
||||
announces to <code class="docutils literal notranslate"><span class="pre">internal</span></code> mode interfaces to do so, you can
|
||||
configure the <code class="docutils literal notranslate"><span class="pre">announces_to_internal</span></code> option to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -973,6 +973,7 @@ but excluding any interface access codes.
|
||||
<img alt="_images/if_mode_graph_b.png" src="_images/if_mode_graph_b.png" />
|
||||
<p>Or, represented in table form:</p>
|
||||
<img alt="_images/if_mode_graph_c.png" src="_images/if_mode_graph_c.png" />
|
||||
<p>For a visually intuitive overview of how announce propagation rules function in practice, you can take a look at the <a class="reference external" href="https://rns.moscow/announce-sim.html">Announce Propagation Simulator</a> hosted by <a class="reference external" href="https://rns.moscow/">rns.moscow</a>.</p>
|
||||
</section>
|
||||
<section id="cryptographic-primitives">
|
||||
<span id="understanding-primitives"></span><h3>Cryptographic Primitives<a class="headerlink" href="#cryptographic-primitives" title="Link to this heading">¶</a></h3>
|
||||
|
||||
@@ -1303,6 +1303,11 @@ network_identity = ~/.reticulum/storage/identities/my_network
|
||||
...
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>For more fine-grained control over how discovered interfaces are auto-connected, additional options are provided for configuraiton. These are not necessary to set in most cases, but can be useful in certain situations.</p>
|
||||
<ul class="simple">
|
||||
<li><p>The <code class="docutils literal notranslate"><span class="pre">autoconnect_discovered_mode</span></code> options specifies which mode discovered interfaces should be created with when auto-connecting.</p></li>
|
||||
<li><p>The <code class="docutils literal notranslate"><span class="pre">autoconnect_announces_to_internal</span></code> option allows you to specify that auto-connected interfaces should propagate announces to <code class="docutils literal notranslate"><span class="pre">internal</span></code> mode interfaces, even if the auto-connected interface’s mode would normally not allow for this.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="remote-management">
|
||||
<h2>Remote Management<a class="headerlink" href="#remote-management" title="Link to this heading">¶</a></h2>
|
||||
|
||||
@@ -1201,6 +1201,10 @@ These can be used to control various aspects of interface behaviour.
|
||||
> `internal` mode interfaces may still be resolvable by means
|
||||
> of path requests.
|
||||
>
|
||||
> * To allow an interface that would *otherwise not* propagate
|
||||
> announces to `internal` mode interfaces to do so, you can
|
||||
> configure the `announces_to_internal` option to `True`.
|
||||
>
|
||||
|
||||
## Interface Modes
|
||||
|
||||
|
||||
@@ -682,6 +682,8 @@ Roaming ✓ ✕ ✕ ✕ ✓ ✓
|
||||
✓ Will rebroadcast announce
|
||||
✕ Will not rebroadcast announce -->
|
||||
|
||||
For a visually intuitive overview of how announce propagation rules function in practice, you can take a look at the [Announce Propagation Simulator](https://rns.moscow/announce-sim.html) hosted by [rns.moscow](https://rns.moscow/).
|
||||
|
||||
### Cryptographic Primitives
|
||||
|
||||
Reticulum uses a simple suite of efficient, strong and well-tested cryptographic primitives, with widely available implementations that can be used both on general-purpose CPUs and on microcontrollers.
|
||||
|
||||
@@ -1175,6 +1175,11 @@ network_identity = ~/.reticulum/storage/identities/my_network
|
||||
...
|
||||
```
|
||||
|
||||
For more fine-grained control over how discovered interfaces are auto-connected, additional options are provided for configuraiton. These are not necessary to set in most cases, but can be useful in certain situations.
|
||||
|
||||
* The `autoconnect_discovered_mode` options specifies which mode discovered interfaces should be created with when auto-connecting.
|
||||
* The `autoconnect_announces_to_internal` option allows you to specify that auto-connected interfaces should propagate announces to `internal` mode interfaces, even if the auto-connected interface’s mode would normally not allow for this.
|
||||
|
||||
## Remote Management
|
||||
|
||||
It is possible to allow remote management of Reticulum
|
||||
|
||||
@@ -759,6 +759,8 @@ Or, represented in table form:
|
||||
✓ Will rebroadcast announce
|
||||
✕ Will not rebroadcast announce
|
||||
|
||||
For a visually intuitive overview of how announce propagation rules function in practice, you can take a look at the `Announce Propagation Simulator <https://rns.moscow/announce-sim.html>`_ hosted by `rns.moscow <https://rns.moscow/>`_.
|
||||
|
||||
|
||||
.. _understanding-primitives:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user