Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-10-01 03:15:44 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation updates

Browse Source
This commit is contained in:
Mark Qvist 2022-05-14 16:45:16 +02:00
parent 8636259886
commit f2c0dac217
7 changed files with 38 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/manual/_sources/interfaces.rst.txt
View File

@ -89,7 +89,7 @@ These can be used to control various aspects of interface behaviour.
Interface Modes Interface Modes
=============== ===============
The optional ``mode`` option is available on all interfaces, and allows The optional ``mode`` setting is available on all interfaces, and allows
selecting the high-level behaviour of the interface from a number of modes. selecting the high-level behaviour of the interface from a number of modes.
These modes affect how Reticulum selects paths in the network, how announces These modes affect how Reticulum selects paths in the network, how announces
are propagated and how long paths are valid. are propagated and how long paths are valid.
@ -314,6 +314,9 @@ you must use the i2p_tunneled option:
listen_port = 5001 listen_port = 5001
i2p_tunneled = yes i2p_tunneled = yes
In almost all cases, it is easier to use the dedicated ``I2PInterface``, but for complete
control, and using I2P routers running on external systems, this option also exists.
.. _interfaces-tcpc: .. _interfaces-tcpc:
TCP Client Interface TCP Client Interface
@ -323,6 +326,10 @@ To connect to a TCP server interface, you would naturally use the TCP client
interface. Many TCP Client interfaces from different peers can connect to the interface. Many TCP Client interfaces from different peers can connect to the
same TCP Server interface at the same time. same TCP Server interface at the same time.
The TCP interface types can also tolerate intermittency in the IP link layer.
This means that Reticulum will gracefully handle IP links that go up and down,
and restore connectivity after a failure, once the other end of a TCP interface reappears.
.. code:: .. code::
# Here's an example of a TCP Client interface. The # Here's an example of a TCP Client interface. The
@ -383,8 +390,8 @@ with all other peers on a local area network.
*Please Note!* Using broadcast UDP traffic has performance implications, *Please Note!* Using broadcast UDP traffic has performance implications,
especially on WiFi. If your goal is simply to enable easy communication especially on WiFi. If your goal is simply to enable easy communication
with all peers in your local ethernet broadcast domain, the with all peers in your local ethernet broadcast domain, the
:ref:`Auto Interface<interfaces-auto>` performs better, and is just as :ref:`Auto Interface<interfaces-auto>` performs better, and is even
easy to use. easier to use.
The below example is enabled by default on new Reticulum installations, The below example is enabled by default on new Reticulum installations,
as it provides an easy way to get started and to test Reticulum on a as it provides an easy way to get started and to test Reticulum on a
@ -395,7 +402,7 @@ pre-existing LAN.
# This example enables communication with other # This example enables communication with other
# local Reticulum peers over UDP. # local Reticulum peers over UDP.
[[Default UDP Interface]] [[UDP Interface]]
type = UDPInterface type = UDPInterface
interface_enabled = True interface_enabled = True

5
docs/manual/_sources/understanding.rst.txt
View File

@ -51,9 +51,8 @@ connected to any kind of computer or mobile device that Reticulum can run on.
The ultimate aim of Reticulum is to allow anyone to be their own network operator, and to make it The ultimate aim of Reticulum is to allow anyone to be their own network operator, and to make it
cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks. cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks.
Reticulum **is not** *one network*, it **is a tool** to build *thousands of networks*. Reticulum **is not** *one network*, it **is a tool** to build *thousands of networks*. Networks without
kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate
Networks without kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate
with each other, and require no central oversight. Networks for human beings. *Networks for the people*. with each other, and require no central oversight. Networks for human beings. *Networks for the people*.
.. _understanding-goals: .. _understanding-goals:

13
docs/manual/interfaces.html
View File

@ -137,7 +137,7 @@ option, to set the interface speed in <em>bits per second</em>.</div>
</div> </div>
<div class="section" id="interface-modes"> <div class="section" id="interface-modes">
<span id="interfaces-modes"></span><h2>Interface Modes<a class="headerlink" href="#interface-modes" title="Permalink to this headline"></a></h2> <span id="interfaces-modes"></span><h2>Interface Modes<a class="headerlink" href="#interface-modes" title="Permalink to this headline"></a></h2>
<p>The optional <code class="docutils literal notranslate"><span class="pre">mode</span></code> option is available on all interfaces, and allows <p>The optional <code class="docutils literal notranslate"><span class="pre">mode</span></code> setting is available on all interfaces, and allows
selecting the high-level behaviour of the interface from a number of modes. selecting the high-level behaviour of the interface from a number of modes.
These modes affect how Reticulum selects paths in the network, how announces These modes affect how Reticulum selects paths in the network, how announces
are propagated and how long paths are valid.</p> are propagated and how long paths are valid.</p>
@ -343,12 +343,17 @@ you must use the i2p_tunneled option:</p>
<span class="n">i2p_tunneled</span> <span class="o">=</span> <span class="n">yes</span> <span class="n">i2p_tunneled</span> <span class="o">=</span> <span class="n">yes</span>
</pre></div> </pre></div>
</div> </div>
<p>In almost all cases, it is easier to use the dedicated <code class="docutils literal notranslate"><span class="pre">I2PInterface</span></code>, but for complete
control, and using I2P routers running on external systems, this option also exists.</p>
</div> </div>
<div class="section" id="tcp-client-interface"> <div class="section" id="tcp-client-interface">
<span id="interfaces-tcpc"></span><h2>TCP Client Interface<a class="headerlink" href="#tcp-client-interface" title="Permalink to this headline"></a></h2> <span id="interfaces-tcpc"></span><h2>TCP Client Interface<a class="headerlink" href="#tcp-client-interface" title="Permalink to this headline"></a></h2>
<p>To connect to a TCP server interface, you would naturally use the TCP client <p>To connect to a TCP server interface, you would naturally use the TCP client
interface. Many TCP Client interfaces from different peers can connect to the interface. Many TCP Client interfaces from different peers can connect to the
same TCP Server interface at the same time.</p> same TCP Server interface at the same time.</p>
<p>The TCP interface types can also tolerate intermittency in the IP link layer.
This means that Reticulum will gracefully handle IP links that go up and down,
and restore connectivity after a failure, once the other end of a TCP interface reappears.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Here&#39;s an example of a TCP Client interface. The</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Here&#39;s an example of a TCP Client interface. The</span>
<span class="c1"># target_host can either be an IP address or a hostname.</span> <span class="c1"># target_host can either be an IP address or a hostname.</span>
@ -399,15 +404,15 @@ with all other peers on a local area network.</p>
<p><em>Please Note!</em> Using broadcast UDP traffic has performance implications, <p><em>Please Note!</em> Using broadcast UDP traffic has performance implications,
especially on WiFi. If your goal is simply to enable easy communication especially on WiFi. If your goal is simply to enable easy communication
with all peers in your local ethernet broadcast domain, the with all peers in your local ethernet broadcast domain, the
<a class="reference internal" href="#interfaces-auto"><span class="std std-ref">Auto Interface</span></a> performs better, and is just as <a class="reference internal" href="#interfaces-auto"><span class="std std-ref">Auto Interface</span></a> performs better, and is even
easy to use.</p> easier to use.</p>
<p>The below example is enabled by default on new Reticulum installations, <p>The below example is enabled by default on new Reticulum installations,
as it provides an easy way to get started and to test Reticulum on a as it provides an easy way to get started and to test Reticulum on a
pre-existing LAN.</p> pre-existing LAN.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This example enables communication with other</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This example enables communication with other</span>
<span class="c1"># local Reticulum peers over UDP.</span> <span class="c1"># local Reticulum peers over UDP.</span>
<span class="p">[[</span><span class="n">Default</span> <span class="n">UDP</span> <span class="n">Interface</span><span class="p">]]</span> <span class="p">[[</span><span class="n">UDP</span> <span class="n">Interface</span><span class="p">]]</span>
<span class="nb">type</span> <span class="o">=</span> <span class="n">UDPInterface</span> <span class="nb">type</span> <span class="o">=</span> <span class="n">UDPInterface</span>
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span> <span class="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span>

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long

4
docs/manual/understanding.html
View File

@ -80,8 +80,8 @@ LoRa radio modules with an open source firmware (see the section <a class="refer
connected to any kind of computer or mobile device that Reticulum can run on.</p> connected to any kind of computer or mobile device that Reticulum can run on.</p>
<p>The ultimate aim of Reticulum is to allow anyone to be their own network operator, and to make it <p>The ultimate aim of Reticulum is to allow anyone to be their own network operator, and to make it
cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks. cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks.
Reticulum <strong>is not</strong> <em>one network</em>, it <strong>is a tool</strong> to build <em>thousands of networks</em>.</p> Reticulum <strong>is not</strong> <em>one network</em>, it <strong>is a tool</strong> to build <em>thousands of networks</em>. Networks without
<p>Networks without kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate
with each other, and require no central oversight. Networks for human beings. <em>Networks for the people</em>.</p> with each other, and require no central oversight. Networks for human beings. <em>Networks for the people</em>.</p>
</div> </div>
<div class="section" id="goals"> <div class="section" id="goals">

15
docs/source/interfaces.rst
View File

@ -89,7 +89,7 @@ These can be used to control various aspects of interface behaviour.
Interface Modes Interface Modes
=============== ===============
The optional ``mode`` option is available on all interfaces, and allows The optional ``mode`` setting is available on all interfaces, and allows
selecting the high-level behaviour of the interface from a number of modes. selecting the high-level behaviour of the interface from a number of modes.
These modes affect how Reticulum selects paths in the network, how announces These modes affect how Reticulum selects paths in the network, how announces
are propagated and how long paths are valid. are propagated and how long paths are valid.
@ -314,6 +314,9 @@ you must use the i2p_tunneled option:
listen_port = 5001 listen_port = 5001
i2p_tunneled = yes i2p_tunneled = yes
In almost all cases, it is easier to use the dedicated ``I2PInterface``, but for complete
control, and using I2P routers running on external systems, this option also exists.
.. _interfaces-tcpc: .. _interfaces-tcpc:
TCP Client Interface TCP Client Interface
@ -323,6 +326,10 @@ To connect to a TCP server interface, you would naturally use the TCP client
interface. Many TCP Client interfaces from different peers can connect to the interface. Many TCP Client interfaces from different peers can connect to the
same TCP Server interface at the same time. same TCP Server interface at the same time.
The TCP interface types can also tolerate intermittency in the IP link layer.
This means that Reticulum will gracefully handle IP links that go up and down,
and restore connectivity after a failure, once the other end of a TCP interface reappears.
.. code:: .. code::
# Here's an example of a TCP Client interface. The # Here's an example of a TCP Client interface. The
@ -383,8 +390,8 @@ with all other peers on a local area network.
*Please Note!* Using broadcast UDP traffic has performance implications, *Please Note!* Using broadcast UDP traffic has performance implications,
especially on WiFi. If your goal is simply to enable easy communication especially on WiFi. If your goal is simply to enable easy communication
with all peers in your local ethernet broadcast domain, the with all peers in your local ethernet broadcast domain, the
:ref:`Auto Interface<interfaces-auto>` performs better, and is just as :ref:`Auto Interface<interfaces-auto>` performs better, and is even
easy to use. easier to use.
The below example is enabled by default on new Reticulum installations, The below example is enabled by default on new Reticulum installations,
as it provides an easy way to get started and to test Reticulum on a as it provides an easy way to get started and to test Reticulum on a
@ -395,7 +402,7 @@ pre-existing LAN.
# This example enables communication with other # This example enables communication with other
# local Reticulum peers over UDP. # local Reticulum peers over UDP.
[[Default UDP Interface]] [[UDP Interface]]
type = UDPInterface type = UDPInterface
interface_enabled = True interface_enabled = True

5
docs/source/understanding.rst
View File

@ -51,9 +51,8 @@ connected to any kind of computer or mobile device that Reticulum can run on.
The ultimate aim of Reticulum is to allow anyone to be their own network operator, and to make it The ultimate aim of Reticulum is to allow anyone to be their own network operator, and to make it
cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks. cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks.
Reticulum **is not** *one network*, it **is a tool** to build *thousands of networks*. Reticulum **is not** *one network*, it **is a tool** to build *thousands of networks*. Networks without
kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate
Networks without kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate
with each other, and require no central oversight. Networks for human beings. *Networks for the people*. with each other, and require no central oversight. Networks for human beings. *Networks for the people*.
.. _understanding-goals: .. _understanding-goals: