William/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-11-22 21:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation and manual

Browse Source
This commit is contained in:
Mark Qvist 2022-02-25 22:34:41 +01:00
parent b8105e23ff
commit 17be289f37
4 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/Reticulum Manual.pdf
View File

Binary file not shown.

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

@ -94,12 +94,12 @@ inbound traffic.
Using the I2P interface, you will get a globally reachable, portable Using the I2P interface, you will get a globally reachable, portable
and persistent I2P address that your Reticulum instance can be reached and persistent I2P address that your Reticulum instance can be reached
at. The I2P at.
To use the I2P interface, you must have an I2P router running To use the I2P interface, you must have an I2P router running
on your system. The easiest way to acheive this is to download and on your system. The easiest way to acheive this is to download and
install the `latest release <https://github.com/PurpleI2P/i2pd/releases/latest>`_ install the `latest release <https://github.com/PurpleI2P/i2pd/releases/latest>`_
of the ``ì2pd```package. For more details about I2P, see the of the ``ì2pd`` package. For more details about I2P, see the
`geti2p.net website <https://geti2p.net/en/about/intro>`_.` `geti2p.net website <https://geti2p.net/en/about/intro>`_.`
When an I2P router is running on your system, you can simply add When an I2P router is running on your system, you can simply add
@ -119,7 +119,7 @@ you should see I2P base32 address printed to your log file. You can
also inspect the status of the interface using the ``rnstatus`` utility. also inspect the status of the interface using the ``rnstatus`` utility.
To connect to other Reticulum instances over I2P, just add a comma-separated To connect to other Reticulum instances over I2P, just add a comma-separated
list of I2P base32 addresses to the ``peers```option of the interface: list of I2P base32 addresses to the ``peers`` option of the interface:
.. code:: .. code::
@ -520,6 +520,11 @@ Common Interface Options
A number of general options can be used to control various A number of general options can be used to control various
aspects of interface behaviour. aspects of interface behaviour.
The ``interface_enabled`` option tells Reticulum whether or not
to bring up the interface. Defaults to ``False``. For any
interface to be brought up, the ``interface_enabled`` option
must be set to ``True`` or ``Yes``.
The ``outgoing`` option sets whether an interface is allowed The ``outgoing`` option sets whether an interface is allowed
to transmit. Defaults to ``True``. If set to ``False`` the to transmit. Defaults to ``True``. If set to ``False`` the
interface will only receive data, and never transmit. interface will only receive data, and never transmit.
@ -540,8 +545,3 @@ behaviour of the interface from a number of options.
be a radio interface serving a wide area, where users are be a radio interface serving a wide area, where users are
expected to connect momentarily, use the network, and then expected to connect momentarily, use the network, and then
disappear again. disappear again.
The ``interface_enabled`` option tells Reticulum whether or not
to bring up the interface. Defaults to ``False``. For any
interface to be brought up, the ``interface_enabled`` option
must be set to ``True`` or ``Yes``.

14
docs/manual/interfaces.html
View File

@ -117,11 +117,11 @@ have a frequently changing IP address, or have firewalls blocking
inbound traffic.</p> inbound traffic.</p>
<p>Using the I2P interface, you will get a globally reachable, portable <p>Using the I2P interface, you will get a globally reachable, portable
and persistent I2P address that your Reticulum instance can be reached and persistent I2P address that your Reticulum instance can be reached
at. The I2P</p> at.</p>
<p>To use the I2P interface, you must have an I2P router running <p>To use the I2P interface, you must have an I2P router running
on your system. The easiest way to acheive this is to download and on your system. The easiest way to acheive this is to download and
install the <a class="reference external" href="https://github.com/PurpleI2P/i2pd/releases/latest">latest release</a> install the <a class="reference external" href="https://github.com/PurpleI2P/i2pd/releases/latest">latest release</a>
of the <a href="#id1"><span class="problematic" id="id2">``</span></a>ì2pd```package. For more details about I2P, see the of the <code class="docutils literal notranslate"><span class="pre">ì2pd</span></code> package. For more details about I2P, see the
<a class="reference external" href="https://geti2p.net/en/about/intro">geti2p.net website</a>.`</p> <a class="reference external" href="https://geti2p.net/en/about/intro">geti2p.net website</a>.`</p>
<p>When an I2P router is running on your system, you can simply add <p>When an I2P router is running on your system, you can simply add
an I2P interface to reticulum:</p> an I2P interface to reticulum:</p>
@ -137,7 +137,7 @@ started, and is not yet well-connected to the I2P network. When ready,
you should see I2P base32 address printed to your log file. You can you should see I2P base32 address printed to your log file. You can
also inspect the status of the interface using the <code class="docutils literal notranslate"><span class="pre">rnstatus</span></code> utility.</p> also inspect the status of the interface using the <code class="docutils literal notranslate"><span class="pre">rnstatus</span></code> utility.</p>
<p>To connect to other Reticulum instances over I2P, just add a comma-separated <p>To connect to other Reticulum instances over I2P, just add a comma-separated
list of I2P base32 addresses to the <a href="#id3"><span class="problematic" id="id4">``</span></a>peers```option of the interface:</p> list of I2P base32 addresses to the <code class="docutils literal notranslate"><span class="pre">peers</span></code> option of the interface:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">I2P</span><span class="p">]]</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">I2P</span><span class="p">]]</span>
<span class="nb">type</span> <span class="o">=</span> <span class="n">I2PInterface</span> <span class="nb">type</span> <span class="o">=</span> <span class="n">I2PInterface</span>
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="n">yes</span> <span class="n">interface_enabled</span> <span class="o">=</span> <span class="n">yes</span>
@ -487,6 +487,10 @@ beaconing functionality described above.</p>
<span id="interfaces-options"></span><h2>Common Interface Options<a class="headerlink" href="#common-interface-options" title="Permalink to this headline"></a></h2> <span id="interfaces-options"></span><h2>Common Interface Options<a class="headerlink" href="#common-interface-options" title="Permalink to this headline"></a></h2>
<p>A number of general options can be used to control various <p>A number of general options can be used to control various
aspects of interface behaviour.</p> aspects of interface behaviour.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">interface_enabled</span></code> option tells Reticulum whether or not
to bring up the interface. Defaults to <code class="docutils literal notranslate"><span class="pre">False</span></code>. For any
interface to be brought up, the <code class="docutils literal notranslate"><span class="pre">interface_enabled</span></code> option
must be set to <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">Yes</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">outgoing</span></code> option sets whether an interface is allowed <p>The <code class="docutils literal notranslate"><span class="pre">outgoing</span></code> option sets whether an interface is allowed
to transmit. Defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>. If set to <code class="docutils literal notranslate"><span class="pre">False</span></code> the to transmit. Defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>. If set to <code class="docutils literal notranslate"><span class="pre">False</span></code> the
interface will only receive data, and never transmit.</p> interface will only receive data, and never transmit.</p>
@ -508,10 +512,6 @@ expected to connect momentarily, use the network, and then
disappear again.</p></li> disappear again.</p></li>
</ul> </ul>
</div></blockquote> </div></blockquote>
<p>The <code class="docutils literal notranslate"><span class="pre">interface_enabled</span></code> option tells Reticulum whether or not
to bring up the interface. Defaults to <code class="docutils literal notranslate"><span class="pre">False</span></code>. For any
interface to be brought up, the <code class="docutils literal notranslate"><span class="pre">interface_enabled</span></code> option
must be set to <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">Yes</span></code>.</p>
</div> </div>
</div> </div>

16
docs/source/interfaces.rst
View File

@ -94,12 +94,12 @@ inbound traffic.
Using the I2P interface, you will get a globally reachable, portable Using the I2P interface, you will get a globally reachable, portable
and persistent I2P address that your Reticulum instance can be reached and persistent I2P address that your Reticulum instance can be reached
at. The I2P at.
To use the I2P interface, you must have an I2P router running To use the I2P interface, you must have an I2P router running
on your system. The easiest way to acheive this is to download and on your system. The easiest way to acheive this is to download and
install the `latest release <https://github.com/PurpleI2P/i2pd/releases/latest>`_ install the `latest release <https://github.com/PurpleI2P/i2pd/releases/latest>`_
of the ``ì2pd```package. For more details about I2P, see the of the ``ì2pd`` package. For more details about I2P, see the
`geti2p.net website <https://geti2p.net/en/about/intro>`_.` `geti2p.net website <https://geti2p.net/en/about/intro>`_.`
When an I2P router is running on your system, you can simply add When an I2P router is running on your system, you can simply add
@ -119,7 +119,7 @@ you should see I2P base32 address printed to your log file. You can
also inspect the status of the interface using the ``rnstatus`` utility. also inspect the status of the interface using the ``rnstatus`` utility.
To connect to other Reticulum instances over I2P, just add a comma-separated To connect to other Reticulum instances over I2P, just add a comma-separated
list of I2P base32 addresses to the ``peers```option of the interface: list of I2P base32 addresses to the ``peers`` option of the interface:
.. code:: .. code::
@ -520,6 +520,11 @@ Common Interface Options
A number of general options can be used to control various A number of general options can be used to control various
aspects of interface behaviour. aspects of interface behaviour.
The ``interface_enabled`` option tells Reticulum whether or not
to bring up the interface. Defaults to ``False``. For any
interface to be brought up, the ``interface_enabled`` option
must be set to ``True`` or ``Yes``.
The ``outgoing`` option sets whether an interface is allowed The ``outgoing`` option sets whether an interface is allowed
to transmit. Defaults to ``True``. If set to ``False`` the to transmit. Defaults to ``True``. If set to ``False`` the
interface will only receive data, and never transmit. interface will only receive data, and never transmit.
@ -540,8 +545,3 @@ behaviour of the interface from a number of options.
be a radio interface serving a wide area, where users are be a radio interface serving a wide area, where users are
expected to connect momentarily, use the network, and then expected to connect momentarily, use the network, and then
disappear again. disappear again.
The ``interface_enabled`` option tells Reticulum whether or not
to bring up the interface. Defaults to ``False``. For any
interface to be brought up, the ``interface_enabled`` option
must be set to ``True`` or ``Yes``.