mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-10-01 03:15:44 -04:00
Updated documentation and manual
This commit is contained in:
parent
4dfa62833c
commit
f378d09cbe
Binary file not shown.
@ -1,4 +1,4 @@
|
|||||||
# Sphinx build info version 1
|
# Sphinx build info version 1
|
||||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
config: e7106bc1351404c40787ba74340593af
|
config: 8cd01657672a2b3a4d1c8ecc92b32a11
|
||||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
|
@ -39,7 +39,6 @@ system, which should be enabled by default in almost all OSes.
|
|||||||
[[Default Interface]]
|
[[Default Interface]]
|
||||||
type = AutoInterface
|
type = AutoInterface
|
||||||
interface_enabled = True
|
interface_enabled = True
|
||||||
outgoing = True
|
|
||||||
|
|
||||||
# You can create multiple isolated Reticulum
|
# You can create multiple isolated Reticulum
|
||||||
# networks on the same physical LAN by
|
# networks on the same physical LAN by
|
||||||
@ -69,7 +68,6 @@ the discovery scope by setting it to one of ``link``, ``admin``, ``site``,
|
|||||||
[[Default Interface]]
|
[[Default Interface]]
|
||||||
type = AutoInterface
|
type = AutoInterface
|
||||||
interface_enabled = True
|
interface_enabled = True
|
||||||
outgoing = True
|
|
||||||
|
|
||||||
# Configure global discovery
|
# Configure global discovery
|
||||||
|
|
||||||
@ -81,8 +79,173 @@ the discovery scope by setting it to one of ``link``, ``admin``, ``site``,
|
|||||||
discovery_port = 48555
|
discovery_port = 48555
|
||||||
data_port = 49555
|
data_port = 49555
|
||||||
|
|
||||||
*Please Note!* If you use the Auto Interface, you will need the Python module
|
|
||||||
``netifaces`` installed on your system. You can install it with ``pip3 install netifaces``.
|
.. _interfaces-i2p:
|
||||||
|
|
||||||
|
I2P Interface
|
||||||
|
=============
|
||||||
|
|
||||||
|
The I2P interface lets you connect Reticulum instances over the
|
||||||
|
`Invisible Internet Protocol <https://i2pd.website>`_. This can be
|
||||||
|
especially useful in cases where you want to host a globally reachable
|
||||||
|
Reticulum instance, but do not have access to any public IP addresses,
|
||||||
|
have a frequently changing IP address, or have firewalls blocking
|
||||||
|
inbound traffic.
|
||||||
|
|
||||||
|
Using the I2P interface, you will get a globally reachable, portable
|
||||||
|
and persistent I2P address that your Reticulum instance can be reached
|
||||||
|
at. The I2P
|
||||||
|
|
||||||
|
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
|
||||||
|
install the `latest release <https://github.com/PurpleI2P/i2pd/releases/latest>`_
|
||||||
|
of the ``ì2pd```package. For more details about I2P, see the
|
||||||
|
`geti2p.net website <https://geti2p.net/en/about/intro>`_.`
|
||||||
|
|
||||||
|
When an I2P router is running on your system, you can simply add
|
||||||
|
an I2P interface to reticulum:
|
||||||
|
|
||||||
|
.. code::
|
||||||
|
|
||||||
|
[[I2P]]
|
||||||
|
type = I2PInterface
|
||||||
|
interface_enabled = yes
|
||||||
|
|
||||||
|
On the first start, Reticulum will generate a new I2P address for the
|
||||||
|
interface and start listening for inbound traffic on it. This can take
|
||||||
|
a while the first time, especially if your I2P router was also just
|
||||||
|
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
|
||||||
|
also inspect the status of the interface using the ``rnstatus`` utility.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
.. code::
|
||||||
|
|
||||||
|
[[I2P]]
|
||||||
|
type = I2PInterface
|
||||||
|
interface_enabled = yes
|
||||||
|
peers = 5urvjicpzi7q3ybztsef4i5ow2aq4soktfj7zedz53s47r54jnqq.b32.i2p
|
||||||
|
|
||||||
|
It can take anywhere from a few seconds to a few minutes to establish
|
||||||
|
I2P connections to the desired peers, so Reticulum handles the process
|
||||||
|
in the background, and will output relevant events to the log.
|
||||||
|
|
||||||
|
**Please Note!** While the I2P interface is the simplest way to use
|
||||||
|
Reticulum over I2P, it is also possible to tunnel the TCP server and
|
||||||
|
client interfaces over I2P manually. This can be useful in situations
|
||||||
|
where more control is needed, but requires manual tunnel setup through
|
||||||
|
the I2P daemon configuration.
|
||||||
|
|
||||||
|
It is important to note that the two methods are *interchangably compatible*.
|
||||||
|
You can use the I2PInterface to connect to a TCPServerInterface that
|
||||||
|
was manually tunneled over I2P, for example. This offers a high degree
|
||||||
|
of flexibility in network setup, while retaining ease of use in simpler
|
||||||
|
use-cases.
|
||||||
|
|
||||||
|
|
||||||
|
.. _interfaces-tcps:
|
||||||
|
|
||||||
|
TCP Server Interface
|
||||||
|
====================
|
||||||
|
|
||||||
|
The TCP Server interface is suitable for allowing other peers to connect over
|
||||||
|
the Internet or private IP networks. When a TCP server interface has been
|
||||||
|
configured, other Reticulum peers can connect to it with a TCP Client interface.
|
||||||
|
|
||||||
|
.. code::
|
||||||
|
|
||||||
|
# This example demonstrates a TCP server interface.
|
||||||
|
# It will listen for incoming connections on the
|
||||||
|
# specified IP address and port number.
|
||||||
|
|
||||||
|
[[TCP Server Interface]]
|
||||||
|
type = TCPServerInterface
|
||||||
|
interface_enabled = True
|
||||||
|
|
||||||
|
# This configuration will listen on all IP
|
||||||
|
# interfaces on port 4242
|
||||||
|
|
||||||
|
listen_ip = 0.0.0.0
|
||||||
|
listen_port = 4242
|
||||||
|
|
||||||
|
# Alternatively you can bind to a specific IP
|
||||||
|
|
||||||
|
# listen_ip = 10.0.0.88
|
||||||
|
# listen_port = 4242
|
||||||
|
|
||||||
|
# Or a specific network device
|
||||||
|
|
||||||
|
# device = eth0
|
||||||
|
# port = 4242
|
||||||
|
|
||||||
|
**Please Note!** The TCP interfaces support tunneling over I2P, but to do so reliably,
|
||||||
|
you must use the i2p_tunneled option:
|
||||||
|
|
||||||
|
.. code::
|
||||||
|
|
||||||
|
[[TCP Server on I2P]]
|
||||||
|
type = TCPServerInterface
|
||||||
|
interface_enabled = yes
|
||||||
|
listen_ip = 127.0.0.1
|
||||||
|
listen_port = 5001
|
||||||
|
i2p_tunneled = yes
|
||||||
|
|
||||||
|
.. _interfaces-tcpc:
|
||||||
|
|
||||||
|
TCP Client Interface
|
||||||
|
====================
|
||||||
|
|
||||||
|
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
|
||||||
|
same TCP Server interface at the same time.
|
||||||
|
|
||||||
|
.. code::
|
||||||
|
|
||||||
|
# Here's an example of a TCP Client interface. The
|
||||||
|
# target_host can either be an IP address or a hostname.
|
||||||
|
|
||||||
|
[[TCP Client Interface]]
|
||||||
|
type = TCPClientInterface
|
||||||
|
interface_enabled = True
|
||||||
|
target_host = 127.0.0.1
|
||||||
|
target_port = 4242
|
||||||
|
|
||||||
|
It is also possible to use this interface type to connect via other programs
|
||||||
|
or hardware devices that expose a KISS interface on a TCP port, for example
|
||||||
|
software-based soundmodems. To do this, use the ``kiss_framing`` option:
|
||||||
|
|
||||||
|
.. code::
|
||||||
|
|
||||||
|
# Here's an example of a TCP Client interface that connects
|
||||||
|
# to a software TNC soundmodem on a KISS over TCP port.
|
||||||
|
|
||||||
|
[[TCP KISS Interface]]
|
||||||
|
type = TCPClientInterface
|
||||||
|
interface_enabled = True
|
||||||
|
kiss_framing = True
|
||||||
|
target_host = 127.0.0.1
|
||||||
|
target_port = 8001
|
||||||
|
|
||||||
|
**Caution!** Only use the KISS framing option when connecting to external devices
|
||||||
|
and programs like soundmodems and similar over TCP. When using the
|
||||||
|
``TCPClientInterface`` in conjunction with the ``TCPServerInterface`` you should
|
||||||
|
never enable ``kiss_framing``, since this will disable internal reliability and
|
||||||
|
recovery mechanisms that greatly improves performance over unreliable and
|
||||||
|
intermittent TCP links.
|
||||||
|
|
||||||
|
**Please Note!** The TCP interfaces support tunneling over I2P, but to do so reliably,
|
||||||
|
you must use the i2p_tunneled option:
|
||||||
|
|
||||||
|
.. code::
|
||||||
|
|
||||||
|
[[TCP Client over I2P]]
|
||||||
|
type = TCPClientInterface
|
||||||
|
interface_enabled = yes
|
||||||
|
target_host = 127.0.0.1
|
||||||
|
target_port = 5001
|
||||||
|
i2p_tunneled = yes
|
||||||
|
|
||||||
|
|
||||||
.. _interfaces-udp:
|
.. _interfaces-udp:
|
||||||
@ -113,7 +276,7 @@ pre-existing LAN.
|
|||||||
[[Default UDP Interface]]
|
[[Default UDP Interface]]
|
||||||
type = UDPInterface
|
type = UDPInterface
|
||||||
interface_enabled = True
|
interface_enabled = True
|
||||||
outgoing = True
|
|
||||||
listen_ip = 0.0.0.0
|
listen_ip = 0.0.0.0
|
||||||
listen_port = 4242
|
listen_port = 4242
|
||||||
forward_ip = 255.255.255.255
|
forward_ip = 255.255.255.255
|
||||||
@ -149,119 +312,6 @@ pre-existing LAN.
|
|||||||
# forward_ip = 10.55.0.16
|
# forward_ip = 10.55.0.16
|
||||||
# forward_port = 4242
|
# forward_port = 4242
|
||||||
|
|
||||||
*Please Note!* If you use the ``device`` option, you will need the Python module
|
|
||||||
``netifaces`` installed on your system. You can install it with ``pip3 install netifaces``.
|
|
||||||
|
|
||||||
.. _interfaces-tcps:
|
|
||||||
|
|
||||||
TCP Server Interface
|
|
||||||
====================
|
|
||||||
|
|
||||||
The TCP Server interface is suitable for allowing other peers to connect over
|
|
||||||
the Internet or private IP networks. When a TCP server interface has been
|
|
||||||
configured, other Reticulum peers can connect to it with a TCP Client interface.
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
# This example demonstrates a TCP server interface.
|
|
||||||
# It will listen for incoming connections on the
|
|
||||||
# specified IP address and port number.
|
|
||||||
|
|
||||||
[[TCP Server Interface]]
|
|
||||||
type = TCPServerInterface
|
|
||||||
interface_enabled = True
|
|
||||||
outgoing = True
|
|
||||||
|
|
||||||
# This configuration will listen on all IP
|
|
||||||
# interfaces on port 4242
|
|
||||||
|
|
||||||
listen_ip = 0.0.0.0
|
|
||||||
listen_port = 4242
|
|
||||||
|
|
||||||
# Alternatively you can bind to a specific IP
|
|
||||||
|
|
||||||
# listen_ip = 10.0.0.88
|
|
||||||
# listen_port = 4242
|
|
||||||
|
|
||||||
# Or a specific network device
|
|
||||||
|
|
||||||
# device = eth0
|
|
||||||
# port = 4242
|
|
||||||
|
|
||||||
*Please Note!* If you use the ``device`` option, you will need the Python module
|
|
||||||
``netifaces`` installed on your system. You can install it with ``pip3 install netifaces``.
|
|
||||||
|
|
||||||
**Caution!** The TCP interfaces support tunneling over I2P, but to do so reliably,
|
|
||||||
you should use the i2p_tunneled option:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
[[TCP Server on I2P]]
|
|
||||||
type = TCPServerInterface
|
|
||||||
interface_enabled = yes
|
|
||||||
outgoing = yes
|
|
||||||
listen_ip = 127.0.0.1
|
|
||||||
listen_port = 5001
|
|
||||||
i2p_tunneled = yes
|
|
||||||
|
|
||||||
.. _interfaces-tcpc:
|
|
||||||
|
|
||||||
TCP Client Interface
|
|
||||||
====================
|
|
||||||
|
|
||||||
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
|
|
||||||
same TCP Server interface at the same time.
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
# Here's an example of a TCP Client interface. The
|
|
||||||
# target_host can either be an IP address or a hostname.
|
|
||||||
|
|
||||||
[[TCP Client Interface]]
|
|
||||||
type = TCPClientInterface
|
|
||||||
interface_enabled = True
|
|
||||||
outgoing = True
|
|
||||||
target_host = 127.0.0.1
|
|
||||||
target_port = 4242
|
|
||||||
|
|
||||||
It is also possible to use this interface type to connect via other programs
|
|
||||||
or hardware devices that expose a KISS interface on a TCP port, for example
|
|
||||||
software-based soundmodems. To do this, use the ``kiss_framing`` option:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
# Here's an example of a TCP Client interface that connects
|
|
||||||
# to a software TNC soundmodem on a KISS over TCP port.
|
|
||||||
|
|
||||||
[[TCP KISS Interface]]
|
|
||||||
type = TCPClientInterface
|
|
||||||
interface_enabled = True
|
|
||||||
outgoing = True
|
|
||||||
kiss_framing = True
|
|
||||||
target_host = 127.0.0.1
|
|
||||||
target_port = 8001
|
|
||||||
|
|
||||||
**Caution!** Only use the KISS framing option when connecting to external devices
|
|
||||||
and programs like soundmodems and similar over TCP. When using the
|
|
||||||
``TCPClientInterface`` in conjunction with the ``TCPServerInterface`` you should
|
|
||||||
never enable ``kiss_framing``, since this will disable internal reliability and
|
|
||||||
recovery mechanisms that greatly improves performance over unreliable and
|
|
||||||
intermittent TCP links.
|
|
||||||
|
|
||||||
**Caution!** The TCP interfaces support tunneling over I2P, but to do so reliably,
|
|
||||||
you should use the i2p_tunneled option:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
[[TCP Client over I2P]]
|
|
||||||
type = TCPClientInterface
|
|
||||||
interface_enabled = yes
|
|
||||||
outgoing = yes
|
|
||||||
target_host = 127.0.0.1
|
|
||||||
target_port = 5001
|
|
||||||
i2p_tunneled = yes
|
|
||||||
|
|
||||||
|
|
||||||
.. _interfaces-rnode:
|
.. _interfaces-rnode:
|
||||||
|
|
||||||
@ -282,11 +332,6 @@ can be used, and offers full control over LoRa parameters.
|
|||||||
# Enable interface if you want use it!
|
# Enable interface if you want use it!
|
||||||
interface_enabled = True
|
interface_enabled = True
|
||||||
|
|
||||||
# Allow transmit on interface. Setting
|
|
||||||
# this to false will create a listen-
|
|
||||||
# only interface.
|
|
||||||
outgoing = true
|
|
||||||
|
|
||||||
# Serial port for the device
|
# Serial port for the device
|
||||||
port = /dev/ttyUSB0
|
port = /dev/ttyUSB0
|
||||||
|
|
||||||
@ -337,7 +382,6 @@ directly over a wire-pair, or for using devices such as data radios and lasers.
|
|||||||
[[Serial Interface]]
|
[[Serial Interface]]
|
||||||
type = SerialInterface
|
type = SerialInterface
|
||||||
interface_enabled = True
|
interface_enabled = True
|
||||||
outgoing = True
|
|
||||||
|
|
||||||
# Serial port for the device
|
# Serial port for the device
|
||||||
port = /dev/ttyUSB0
|
port = /dev/ttyUSB0
|
||||||
@ -364,7 +408,6 @@ for station identification purposes.
|
|||||||
[[Packet Radio KISS Interface]]
|
[[Packet Radio KISS Interface]]
|
||||||
type = KISSInterface
|
type = KISSInterface
|
||||||
interface_enabled = True
|
interface_enabled = True
|
||||||
outgoing = true
|
|
||||||
|
|
||||||
# Serial port for the device
|
# Serial port for the device
|
||||||
port = /dev/ttyUSB1
|
port = /dev/ttyUSB1
|
||||||
@ -435,9 +478,6 @@ beaconing functionality described above.
|
|||||||
# Enable interface if you want use it!
|
# Enable interface if you want use it!
|
||||||
interface_enabled = True
|
interface_enabled = True
|
||||||
|
|
||||||
# Allow transmit on interface.
|
|
||||||
outgoing = True
|
|
||||||
|
|
||||||
# Serial port for the device
|
# Serial port for the device
|
||||||
port = /dev/ttyUSB2
|
port = /dev/ttyUSB2
|
||||||
|
|
||||||
@ -469,4 +509,39 @@ beaconing functionality described above.
|
|||||||
# Whether to use KISS flow-control.
|
# Whether to use KISS flow-control.
|
||||||
# This is useful for modems with a
|
# This is useful for modems with a
|
||||||
# small internal packet buffer.
|
# small internal packet buffer.
|
||||||
flow_control = false
|
flow_control = false
|
||||||
|
|
||||||
|
|
||||||
|
.. _interfaces-options:
|
||||||
|
|
||||||
|
Common Interface Options
|
||||||
|
========================
|
||||||
|
|
||||||
|
A number of general options can be used to control various
|
||||||
|
aspects of interface behaviour.
|
||||||
|
|
||||||
|
The ``outgoing`` option sets whether an interface is allowed
|
||||||
|
to transmit. Defaults to ``True``. If set to ``False`` the
|
||||||
|
interface will only receive data, and never transmit.
|
||||||
|
|
||||||
|
The ``interface_mode`` option allows selecting the high-level
|
||||||
|
behaviour of the interface from a number of options.
|
||||||
|
|
||||||
|
- The default value is ``full``. In this mode, all discovery,
|
||||||
|
meshing and transpor functionality is available.
|
||||||
|
|
||||||
|
- In the ``access_point`` (or shorthand ``ap``) mode, the
|
||||||
|
interface will operate as a network access point. In this
|
||||||
|
mode, announces will not be automatically broadcasted on
|
||||||
|
the interface, and paths to destinations on the interface
|
||||||
|
will have a much shorter expiry time. This mode is useful
|
||||||
|
for creating interfaces that are mostly quiet, unless when
|
||||||
|
someone is actually using them. An example of this could
|
||||||
|
be a radio interface serving a wide area, where users are
|
||||||
|
expected to connect momentarily, use the network, and then
|
||||||
|
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``.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
var DOCUMENTATION_OPTIONS = {
|
var DOCUMENTATION_OPTIONS = {
|
||||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||||
VERSION: '0.3.2 beta',
|
VERSION: '0.3.3 beta',
|
||||||
LANGUAGE: 'None',
|
LANGUAGE: 'None',
|
||||||
COLLAPSE_INDEX: false,
|
COLLAPSE_INDEX: false,
|
||||||
BUILDER: 'html',
|
BUILDER: 'html',
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Code Examples — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Code Examples — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -27,7 +27,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="reference.html" title="API Reference"
|
<a href="reference.html" title="API Reference"
|
||||||
accesskey="P">previous</a> |</li>
|
accesskey="P">previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Code Examples</a></li>
|
<li class="nav-item nav-item-this"><a href="">Code Examples</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -2366,7 +2366,7 @@ interface to efficiently pass files of any size over a Reticulum <a class="refer
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="reference.html" title="API Reference"
|
<a href="reference.html" title="API Reference"
|
||||||
>previous</a> |</li>
|
>previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Code Examples</a></li>
|
<li class="nav-item nav-item-this"><a href="">Code Examples</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Index — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Index — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -23,7 +23,7 @@
|
|||||||
<li class="right" style="margin-right: 10px">
|
<li class="right" style="margin-right: 10px">
|
||||||
<a href="#" title="General Index"
|
<a href="#" title="General Index"
|
||||||
accesskey="I">index</a></li>
|
accesskey="I">index</a></li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Index</a></li>
|
<li class="nav-item nav-item-this"><a href="">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -416,7 +416,7 @@
|
|||||||
<li class="right" style="margin-right: 10px">
|
<li class="right" style="margin-right: 10px">
|
||||||
<a href="#" title="General Index"
|
<a href="#" title="General Index"
|
||||||
>index</a></li>
|
>index</a></li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Index</a></li>
|
<li class="nav-item nav-item-this"><a href="">Index</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Getting Started Fast — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Getting Started Fast — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -31,7 +31,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="whatis.html" title="What is Reticulum?"
|
<a href="whatis.html" title="What is Reticulum?"
|
||||||
accesskey="P">previous</a> |</li>
|
accesskey="P">previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Getting Started Fast</a></li>
|
<li class="nav-item nav-item-this"><a href="">Getting Started Fast</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -268,7 +268,7 @@ here at a later point.</p>
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="whatis.html" title="What is Reticulum?"
|
<a href="whatis.html" title="What is Reticulum?"
|
||||||
>previous</a> |</li>
|
>previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Getting Started Fast</a></li>
|
<li class="nav-item nav-item-this"><a href="">Getting Started Fast</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Reticulum Network Stack Manual — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Reticulum Network Stack Manual — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -27,7 +27,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="whatis.html" title="What is Reticulum?"
|
<a href="whatis.html" title="What is Reticulum?"
|
||||||
accesskey="N">next</a> |</li>
|
accesskey="N">next</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="#">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="#">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Reticulum Network Stack Manual</a></li>
|
<li class="nav-item nav-item-this"><a href="">Reticulum Network Stack Manual</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -89,13 +89,15 @@ to participate in the development of Reticulum itself.</p>
|
|||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Supported Interfaces</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Supported Interfaces</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#auto-interface">Auto Interface</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#auto-interface">Auto Interface</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#udp-interface">UDP Interface</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#i2p-interface">I2P Interface</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-server-interface">TCP Server Interface</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-server-interface">TCP Server Interface</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-client-interface">TCP Client Interface</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-client-interface">TCP Client Interface</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#udp-interface">UDP Interface</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#rnode-lora-interface">RNode LoRa Interface</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#rnode-lora-interface">RNode LoRa Interface</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#serial-interface">Serial Interface</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#serial-interface">Serial Interface</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#kiss-interface">KISS Interface</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#kiss-interface">KISS Interface</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#ax-25-kiss-interface">AX.25 KISS Interface</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#ax-25-kiss-interface">AX.25 KISS Interface</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#common-interface-options">Common Interface Options</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a><ul>
|
||||||
@ -208,7 +210,7 @@ to participate in the development of Reticulum itself.</p>
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="whatis.html" title="What is Reticulum?"
|
<a href="whatis.html" title="What is Reticulum?"
|
||||||
>next</a> |</li>
|
>next</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="#">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="#">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Reticulum Network Stack Manual</a></li>
|
<li class="nav-item nav-item-this"><a href="">Reticulum Network Stack Manual</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Supported Interfaces — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Supported Interfaces — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -31,7 +31,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="networks.html" title="Building Networks"
|
<a href="networks.html" title="Building Networks"
|
||||||
accesskey="P">previous</a> |</li>
|
accesskey="P">previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Supported Interfaces</a></li>
|
<li class="nav-item nav-item-this"><a href="">Supported Interfaces</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -68,7 +68,6 @@ system, which should be enabled by default in almost all OSes.</p>
|
|||||||
<span class="p">[[</span><span class="n">Default</span> <span class="n">Interface</span><span class="p">]]</span>
|
<span class="p">[[</span><span class="n">Default</span> <span class="n">Interface</span><span class="p">]]</span>
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">AutoInterface</span>
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">AutoInterface</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>
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
|
|
||||||
<span class="c1"># You can create multiple isolated Reticulum</span>
|
<span class="c1"># You can create multiple isolated Reticulum</span>
|
||||||
<span class="c1"># networks on the same physical LAN by</span>
|
<span class="c1"># networks on the same physical LAN by</span>
|
||||||
@ -95,7 +94,6 @@ the discovery scope by setting it to one of <code class="docutils literal notran
|
|||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">Default</span> <span class="n">Interface</span><span class="p">]]</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">Default</span> <span class="n">Interface</span><span class="p">]]</span>
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">AutoInterface</span>
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">AutoInterface</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>
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
|
|
||||||
<span class="c1"># Configure global discovery</span>
|
<span class="c1"># Configure global discovery</span>
|
||||||
|
|
||||||
@ -108,8 +106,144 @@ the discovery scope by setting it to one of <code class="docutils literal notran
|
|||||||
<span class="n">data_port</span> <span class="o">=</span> <span class="mi">49555</span>
|
<span class="n">data_port</span> <span class="o">=</span> <span class="mi">49555</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p><em>Please Note!</em> If you use the Auto Interface, you will need the Python module
|
</div>
|
||||||
<code class="docutils literal notranslate"><span class="pre">netifaces</span></code> installed on your system. You can install it with <code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">netifaces</span></code>.</p>
|
<div class="section" id="i2p-interface">
|
||||||
|
<span id="interfaces-i2p"></span><h2>I2P Interface<a class="headerlink" href="#i2p-interface" title="Permalink to this headline">¶</a></h2>
|
||||||
|
<p>The I2P interface lets you connect Reticulum instances over the
|
||||||
|
<a class="reference external" href="https://i2pd.website">Invisible Internet Protocol</a>. This can be
|
||||||
|
especially useful in cases where you want to host a globally reachable
|
||||||
|
Reticulum instance, but do not have access to any public IP addresses,
|
||||||
|
have a frequently changing IP address, or have firewalls blocking
|
||||||
|
inbound traffic.</p>
|
||||||
|
<p>Using the I2P interface, you will get a globally reachable, portable
|
||||||
|
and persistent I2P address that your Reticulum instance can be reached
|
||||||
|
at. The I2P</p>
|
||||||
|
<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
|
||||||
|
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
|
||||||
|
<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
|
||||||
|
an I2P interface to reticulum:</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>
|
||||||
|
<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>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p>On the first start, Reticulum will generate a new I2P address for the
|
||||||
|
interface and start listening for inbound traffic on it. This can take
|
||||||
|
a while the first time, especially if your I2P router was also just
|
||||||
|
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
|
||||||
|
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
|
||||||
|
list of I2P base32 addresses to the <a href="#id3"><span class="problematic" id="id4">``</span></a>peers```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>
|
||||||
|
<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">peers</span> <span class="o">=</span> <span class="mi">5</span><span class="n">urvjicpzi7q3ybztsef4i5ow2aq4soktfj7zedz53s47r54jnqq</span><span class="o">.</span><span class="n">b32</span><span class="o">.</span><span class="n">i2p</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p>It can take anywhere from a few seconds to a few minutes to establish
|
||||||
|
I2P connections to the desired peers, so Reticulum handles the process
|
||||||
|
in the background, and will output relevant events to the log.</p>
|
||||||
|
<p><strong>Please Note!</strong> While the I2P interface is the simplest way to use
|
||||||
|
Reticulum over I2P, it is also possible to tunnel the TCP server and
|
||||||
|
client interfaces over I2P manually. This can be useful in situations
|
||||||
|
where more control is needed, but requires manual tunnel setup through
|
||||||
|
the I2P daemon configuration.</p>
|
||||||
|
<p>It is important to note that the two methods are <em>interchangably compatible</em>.
|
||||||
|
You can use the I2PInterface to connect to a TCPServerInterface that
|
||||||
|
was manually tunneled over I2P, for example. This offers a high degree
|
||||||
|
of flexibility in network setup, while retaining ease of use in simpler
|
||||||
|
use-cases.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="tcp-server-interface">
|
||||||
|
<span id="interfaces-tcps"></span><h2>TCP Server Interface<a class="headerlink" href="#tcp-server-interface" title="Permalink to this headline">¶</a></h2>
|
||||||
|
<p>The TCP Server interface is suitable for allowing other peers to connect over
|
||||||
|
the Internet or private IP networks. When a TCP server interface has been
|
||||||
|
configured, other Reticulum peers can connect to it with a TCP Client interface.</p>
|
||||||
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This example demonstrates a TCP server interface.</span>
|
||||||
|
<span class="c1"># It will listen for incoming connections on the</span>
|
||||||
|
<span class="c1"># specified IP address and port number.</span>
|
||||||
|
|
||||||
|
<span class="p">[[</span><span class="n">TCP</span> <span class="n">Server</span> <span class="n">Interface</span><span class="p">]]</span>
|
||||||
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPServerInterface</span>
|
||||||
|
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span>
|
||||||
|
|
||||||
|
<span class="c1"># This configuration will listen on all IP</span>
|
||||||
|
<span class="c1"># interfaces on port 4242</span>
|
||||||
|
|
||||||
|
<span class="n">listen_ip</span> <span class="o">=</span> <span class="mf">0.0</span><span class="o">.</span><span class="mf">0.0</span>
|
||||||
|
<span class="n">listen_port</span> <span class="o">=</span> <span class="mi">4242</span>
|
||||||
|
|
||||||
|
<span class="c1"># Alternatively you can bind to a specific IP</span>
|
||||||
|
|
||||||
|
<span class="c1"># listen_ip = 10.0.0.88</span>
|
||||||
|
<span class="c1"># listen_port = 4242</span>
|
||||||
|
|
||||||
|
<span class="c1"># Or a specific network device</span>
|
||||||
|
|
||||||
|
<span class="c1"># device = eth0</span>
|
||||||
|
<span class="c1"># port = 4242</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p><strong>Please Note!</strong> The TCP interfaces support tunneling over I2P, but to do so reliably,
|
||||||
|
you must use the i2p_tunneled option:</p>
|
||||||
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">TCP</span> <span class="n">Server</span> <span class="n">on</span> <span class="n">I2P</span><span class="p">]]</span>
|
||||||
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPServerInterface</span>
|
||||||
|
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="n">yes</span>
|
||||||
|
<span class="n">listen_ip</span> <span class="o">=</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span>
|
||||||
|
<span class="n">listen_port</span> <span class="o">=</span> <span class="mi">5001</span>
|
||||||
|
<span class="n">i2p_tunneled</span> <span class="o">=</span> <span class="n">yes</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<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>
|
||||||
|
<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
|
||||||
|
same TCP Server interface at the same time.</p>
|
||||||
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Here'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="p">[[</span><span class="n">TCP</span> <span class="n">Client</span> <span class="n">Interface</span><span class="p">]]</span>
|
||||||
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPClientInterface</span>
|
||||||
|
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span>
|
||||||
|
<span class="n">target_host</span> <span class="o">=</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span>
|
||||||
|
<span class="n">target_port</span> <span class="o">=</span> <span class="mi">4242</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p>It is also possible to use this interface type to connect via other programs
|
||||||
|
or hardware devices that expose a KISS interface on a TCP port, for example
|
||||||
|
software-based soundmodems. To do this, use the <code class="docutils literal notranslate"><span class="pre">kiss_framing</span></code> option:</p>
|
||||||
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Here's an example of a TCP Client interface that connects</span>
|
||||||
|
<span class="c1"># to a software TNC soundmodem on a KISS over TCP port.</span>
|
||||||
|
|
||||||
|
<span class="p">[[</span><span class="n">TCP</span> <span class="n">KISS</span> <span class="n">Interface</span><span class="p">]]</span>
|
||||||
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPClientInterface</span>
|
||||||
|
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span>
|
||||||
|
<span class="n">kiss_framing</span> <span class="o">=</span> <span class="kc">True</span>
|
||||||
|
<span class="n">target_host</span> <span class="o">=</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span>
|
||||||
|
<span class="n">target_port</span> <span class="o">=</span> <span class="mi">8001</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p><strong>Caution!</strong> Only use the KISS framing option when connecting to external devices
|
||||||
|
and programs like soundmodems and similar over TCP. When using the
|
||||||
|
<code class="docutils literal notranslate"><span class="pre">TCPClientInterface</span></code> in conjunction with the <code class="docutils literal notranslate"><span class="pre">TCPServerInterface</span></code> you should
|
||||||
|
never enable <code class="docutils literal notranslate"><span class="pre">kiss_framing</span></code>, since this will disable internal reliability and
|
||||||
|
recovery mechanisms that greatly improves performance over unreliable and
|
||||||
|
intermittent TCP links.</p>
|
||||||
|
<p><strong>Please Note!</strong> The TCP interfaces support tunneling over I2P, but to do so reliably,
|
||||||
|
you must use the i2p_tunneled option:</p>
|
||||||
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">TCP</span> <span class="n">Client</span> <span class="n">over</span> <span class="n">I2P</span><span class="p">]]</span>
|
||||||
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPClientInterface</span>
|
||||||
|
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="n">yes</span>
|
||||||
|
<span class="n">target_host</span> <span class="o">=</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span>
|
||||||
|
<span class="n">target_port</span> <span class="o">=</span> <span class="mi">5001</span>
|
||||||
|
<span class="n">i2p_tunneled</span> <span class="o">=</span> <span class="n">yes</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="udp-interface">
|
<div class="section" id="udp-interface">
|
||||||
<span id="interfaces-udp"></span><h2>UDP Interface<a class="headerlink" href="#udp-interface" title="Permalink to this headline">¶</a></h2>
|
<span id="interfaces-udp"></span><h2>UDP Interface<a class="headerlink" href="#udp-interface" title="Permalink to this headline">¶</a></h2>
|
||||||
@ -131,7 +265,7 @@ pre-existing LAN.</p>
|
|||||||
<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">Default</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>
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
<span class="n">listen_ip</span> <span class="o">=</span> <span class="mf">0.0</span><span class="o">.</span><span class="mf">0.0</span>
|
<span class="n">listen_ip</span> <span class="o">=</span> <span class="mf">0.0</span><span class="o">.</span><span class="mf">0.0</span>
|
||||||
<span class="n">listen_port</span> <span class="o">=</span> <span class="mi">4242</span>
|
<span class="n">listen_port</span> <span class="o">=</span> <span class="mi">4242</span>
|
||||||
<span class="n">forward_ip</span> <span class="o">=</span> <span class="mf">255.255</span><span class="o">.</span><span class="mf">255.255</span>
|
<span class="n">forward_ip</span> <span class="o">=</span> <span class="mf">255.255</span><span class="o">.</span><span class="mf">255.255</span>
|
||||||
@ -168,102 +302,6 @@ pre-existing LAN.</p>
|
|||||||
<span class="c1"># forward_port = 4242</span>
|
<span class="c1"># forward_port = 4242</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p><em>Please Note!</em> If you use the <code class="docutils literal notranslate"><span class="pre">device</span></code> option, you will need the Python module
|
|
||||||
<code class="docutils literal notranslate"><span class="pre">netifaces</span></code> installed on your system. You can install it with <code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">netifaces</span></code>.</p>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="tcp-server-interface">
|
|
||||||
<span id="interfaces-tcps"></span><h2>TCP Server Interface<a class="headerlink" href="#tcp-server-interface" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>The TCP Server interface is suitable for allowing other peers to connect over
|
|
||||||
the Internet or private IP networks. When a TCP server interface has been
|
|
||||||
configured, other Reticulum peers can connect to it with a TCP Client interface.</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This example demonstrates a TCP server interface.</span>
|
|
||||||
<span class="c1"># It will listen for incoming connections on the</span>
|
|
||||||
<span class="c1"># specified IP address and port number.</span>
|
|
||||||
|
|
||||||
<span class="p">[[</span><span class="n">TCP</span> <span class="n">Server</span> <span class="n">Interface</span><span class="p">]]</span>
|
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPServerInterface</span>
|
|
||||||
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
|
|
||||||
<span class="c1"># This configuration will listen on all IP</span>
|
|
||||||
<span class="c1"># interfaces on port 4242</span>
|
|
||||||
|
|
||||||
<span class="n">listen_ip</span> <span class="o">=</span> <span class="mf">0.0</span><span class="o">.</span><span class="mf">0.0</span>
|
|
||||||
<span class="n">listen_port</span> <span class="o">=</span> <span class="mi">4242</span>
|
|
||||||
|
|
||||||
<span class="c1"># Alternatively you can bind to a specific IP</span>
|
|
||||||
|
|
||||||
<span class="c1"># listen_ip = 10.0.0.88</span>
|
|
||||||
<span class="c1"># listen_port = 4242</span>
|
|
||||||
|
|
||||||
<span class="c1"># Or a specific network device</span>
|
|
||||||
|
|
||||||
<span class="c1"># device = eth0</span>
|
|
||||||
<span class="c1"># port = 4242</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
<p><em>Please Note!</em> If you use the <code class="docutils literal notranslate"><span class="pre">device</span></code> option, you will need the Python module
|
|
||||||
<code class="docutils literal notranslate"><span class="pre">netifaces</span></code> installed on your system. You can install it with <code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">netifaces</span></code>.</p>
|
|
||||||
<p><strong>Caution!</strong> The TCP interfaces support tunneling over I2P, but to do so reliably,
|
|
||||||
you should use the i2p_tunneled option:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">TCP</span> <span class="n">Server</span> <span class="n">on</span> <span class="n">I2P</span><span class="p">]]</span>
|
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPServerInterface</span>
|
|
||||||
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="n">yes</span>
|
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="n">yes</span>
|
|
||||||
<span class="n">listen_ip</span> <span class="o">=</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span>
|
|
||||||
<span class="n">listen_port</span> <span class="o">=</span> <span class="mi">5001</span>
|
|
||||||
<span class="n">i2p_tunneled</span> <span class="o">=</span> <span class="n">yes</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<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>
|
|
||||||
<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
|
|
||||||
same TCP Server interface at the same time.</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Here'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="p">[[</span><span class="n">TCP</span> <span class="n">Client</span> <span class="n">Interface</span><span class="p">]]</span>
|
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPClientInterface</span>
|
|
||||||
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
<span class="n">target_host</span> <span class="o">=</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span>
|
|
||||||
<span class="n">target_port</span> <span class="o">=</span> <span class="mi">4242</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
<p>It is also possible to use this interface type to connect via other programs
|
|
||||||
or hardware devices that expose a KISS interface on a TCP port, for example
|
|
||||||
software-based soundmodems. To do this, use the <code class="docutils literal notranslate"><span class="pre">kiss_framing</span></code> option:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Here's an example of a TCP Client interface that connects</span>
|
|
||||||
<span class="c1"># to a software TNC soundmodem on a KISS over TCP port.</span>
|
|
||||||
|
|
||||||
<span class="p">[[</span><span class="n">TCP</span> <span class="n">KISS</span> <span class="n">Interface</span><span class="p">]]</span>
|
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPClientInterface</span>
|
|
||||||
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
<span class="n">kiss_framing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
<span class="n">target_host</span> <span class="o">=</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span>
|
|
||||||
<span class="n">target_port</span> <span class="o">=</span> <span class="mi">8001</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
<p><strong>Caution!</strong> Only use the KISS framing option when connecting to external devices
|
|
||||||
and programs like soundmodems and similar over TCP. When using the
|
|
||||||
<code class="docutils literal notranslate"><span class="pre">TCPClientInterface</span></code> in conjunction with the <code class="docutils literal notranslate"><span class="pre">TCPServerInterface</span></code> you should
|
|
||||||
never enable <code class="docutils literal notranslate"><span class="pre">kiss_framing</span></code>, since this will disable internal reliability and
|
|
||||||
recovery mechanisms that greatly improves performance over unreliable and
|
|
||||||
intermittent TCP links.</p>
|
|
||||||
<p><strong>Caution!</strong> The TCP interfaces support tunneling over I2P, but to do so reliably,
|
|
||||||
you should use the i2p_tunneled option:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">TCP</span> <span class="n">Client</span> <span class="n">over</span> <span class="n">I2P</span><span class="p">]]</span>
|
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">TCPClientInterface</span>
|
|
||||||
<span class="n">interface_enabled</span> <span class="o">=</span> <span class="n">yes</span>
|
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="n">yes</span>
|
|
||||||
<span class="n">target_host</span> <span class="o">=</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span>
|
|
||||||
<span class="n">target_port</span> <span class="o">=</span> <span class="mi">5001</span>
|
|
||||||
<span class="n">i2p_tunneled</span> <span class="o">=</span> <span class="n">yes</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="rnode-lora-interface">
|
<div class="section" id="rnode-lora-interface">
|
||||||
<span id="interfaces-rnode"></span><h2>RNode LoRa Interface<a class="headerlink" href="#rnode-lora-interface" title="Permalink to this headline">¶</a></h2>
|
<span id="interfaces-rnode"></span><h2>RNode LoRa Interface<a class="headerlink" href="#rnode-lora-interface" title="Permalink to this headline">¶</a></h2>
|
||||||
@ -278,11 +316,6 @@ can be used, and offers full control over LoRa parameters.</p>
|
|||||||
<span class="c1"># Enable interface if you want use it!</span>
|
<span class="c1"># Enable interface if you want use it!</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>
|
||||||
|
|
||||||
<span class="c1"># Allow transmit on interface. Setting</span>
|
|
||||||
<span class="c1"># this to false will create a listen-</span>
|
|
||||||
<span class="c1"># only interface.</span>
|
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="n">true</span>
|
|
||||||
|
|
||||||
<span class="c1"># Serial port for the device</span>
|
<span class="c1"># Serial port for the device</span>
|
||||||
<span class="n">port</span> <span class="o">=</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">ttyUSB0</span>
|
<span class="n">port</span> <span class="o">=</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">ttyUSB0</span>
|
||||||
|
|
||||||
@ -329,7 +362,6 @@ directly over a wire-pair, or for using devices such as data radios and lasers.<
|
|||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">Serial</span> <span class="n">Interface</span><span class="p">]]</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">Serial</span> <span class="n">Interface</span><span class="p">]]</span>
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">SerialInterface</span>
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">SerialInterface</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>
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
|
|
||||||
<span class="c1"># Serial port for the device</span>
|
<span class="c1"># Serial port for the device</span>
|
||||||
<span class="n">port</span> <span class="o">=</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">ttyUSB0</span>
|
<span class="n">port</span> <span class="o">=</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">ttyUSB0</span>
|
||||||
@ -352,7 +384,6 @@ for station identification purposes.</p>
|
|||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">Packet</span> <span class="n">Radio</span> <span class="n">KISS</span> <span class="n">Interface</span><span class="p">]]</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">Packet</span> <span class="n">Radio</span> <span class="n">KISS</span> <span class="n">Interface</span><span class="p">]]</span>
|
||||||
<span class="nb">type</span> <span class="o">=</span> <span class="n">KISSInterface</span>
|
<span class="nb">type</span> <span class="o">=</span> <span class="n">KISSInterface</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>
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="n">true</span>
|
|
||||||
|
|
||||||
<span class="c1"># Serial port for the device</span>
|
<span class="c1"># Serial port for the device</span>
|
||||||
<span class="n">port</span> <span class="o">=</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">ttyUSB1</span>
|
<span class="n">port</span> <span class="o">=</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">ttyUSB1</span>
|
||||||
@ -417,9 +448,6 @@ beaconing functionality described above.</p>
|
|||||||
<span class="c1"># Enable interface if you want use it!</span>
|
<span class="c1"># Enable interface if you want use it!</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>
|
||||||
|
|
||||||
<span class="c1"># Allow transmit on interface.</span>
|
|
||||||
<span class="n">outgoing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
||||||
|
|
||||||
<span class="c1"># Serial port for the device</span>
|
<span class="c1"># Serial port for the device</span>
|
||||||
<span class="n">port</span> <span class="o">=</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">ttyUSB2</span>
|
<span class="n">port</span> <span class="o">=</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">ttyUSB2</span>
|
||||||
|
|
||||||
@ -455,6 +483,36 @@ beaconing functionality described above.</p>
|
|||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="section" id="common-interface-options">
|
||||||
|
<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
|
||||||
|
aspects of interface behaviour.</p>
|
||||||
|
<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
|
||||||
|
interface will only receive data, and never transmit.</p>
|
||||||
|
<p>The <code class="docutils literal notranslate"><span class="pre">interface_mode</span></code> option allows selecting the high-level
|
||||||
|
behaviour of the interface from a number of options.</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><ul class="simple">
|
||||||
|
<li><p>The default value is <code class="docutils literal notranslate"><span class="pre">full</span></code>. In this mode, all discovery,
|
||||||
|
meshing and transpor functionality is available.</p></li>
|
||||||
|
<li><p>In the <code class="docutils literal notranslate"><span class="pre">access_point</span></code> (or shorthand <code class="docutils literal notranslate"><span class="pre">ap</span></code>) mode, the
|
||||||
|
interface will operate as a network access point. In this
|
||||||
|
mode, announces will not be automatically broadcasted on
|
||||||
|
the interface, and paths to destinations on the interface
|
||||||
|
will have a much shorter expiry time. This mode is useful
|
||||||
|
for creating interfaces that are mostly quiet, unless when
|
||||||
|
someone is actually using them. An example of this could
|
||||||
|
be a radio interface serving a wide area, where users are
|
||||||
|
expected to connect momentarily, use the network, and then
|
||||||
|
disappear again.</p></li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
|
||||||
|
|
||||||
@ -468,13 +526,15 @@ beaconing functionality described above.</p>
|
|||||||
<ul>
|
<ul>
|
||||||
<li><a class="reference internal" href="#">Supported Interfaces</a><ul>
|
<li><a class="reference internal" href="#">Supported Interfaces</a><ul>
|
||||||
<li><a class="reference internal" href="#auto-interface">Auto Interface</a></li>
|
<li><a class="reference internal" href="#auto-interface">Auto Interface</a></li>
|
||||||
<li><a class="reference internal" href="#udp-interface">UDP Interface</a></li>
|
<li><a class="reference internal" href="#i2p-interface">I2P Interface</a></li>
|
||||||
<li><a class="reference internal" href="#tcp-server-interface">TCP Server Interface</a></li>
|
<li><a class="reference internal" href="#tcp-server-interface">TCP Server Interface</a></li>
|
||||||
<li><a class="reference internal" href="#tcp-client-interface">TCP Client Interface</a></li>
|
<li><a class="reference internal" href="#tcp-client-interface">TCP Client Interface</a></li>
|
||||||
|
<li><a class="reference internal" href="#udp-interface">UDP Interface</a></li>
|
||||||
<li><a class="reference internal" href="#rnode-lora-interface">RNode LoRa Interface</a></li>
|
<li><a class="reference internal" href="#rnode-lora-interface">RNode LoRa Interface</a></li>
|
||||||
<li><a class="reference internal" href="#serial-interface">Serial Interface</a></li>
|
<li><a class="reference internal" href="#serial-interface">Serial Interface</a></li>
|
||||||
<li><a class="reference internal" href="#kiss-interface">KISS Interface</a></li>
|
<li><a class="reference internal" href="#kiss-interface">KISS Interface</a></li>
|
||||||
<li><a class="reference internal" href="#ax-25-kiss-interface">AX.25 KISS Interface</a></li>
|
<li><a class="reference internal" href="#ax-25-kiss-interface">AX.25 KISS Interface</a></li>
|
||||||
|
<li><a class="reference internal" href="#common-interface-options">Common Interface Options</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -518,7 +578,7 @@ beaconing functionality described above.</p>
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="networks.html" title="Building Networks"
|
<a href="networks.html" title="Building Networks"
|
||||||
>previous</a> |</li>
|
>previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Supported Interfaces</a></li>
|
<li class="nav-item nav-item-this"><a href="">Supported Interfaces</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Building Networks — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Building Networks — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -31,7 +31,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="using.html" title="Using Reticulum on Your System"
|
<a href="using.html" title="Using Reticulum on Your System"
|
||||||
accesskey="P">previous</a> |</li>
|
accesskey="P">previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Building Networks</a></li>
|
<li class="nav-item nav-item-this"><a href="">Building Networks</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -247,7 +247,7 @@ connected outliers are now an integral part of the network.</p>
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="using.html" title="Using Reticulum on Your System"
|
<a href="using.html" title="Using Reticulum on Your System"
|
||||||
>previous</a> |</li>
|
>previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Building Networks</a></li>
|
<li class="nav-item nav-item-this"><a href="">Building Networks</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
Binary file not shown.
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>API Reference — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>API Reference — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -31,7 +31,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="understanding.html" title="Understanding Reticulum"
|
<a href="understanding.html" title="Understanding Reticulum"
|
||||||
accesskey="P">previous</a> |</li>
|
accesskey="P">previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">API Reference</a></li>
|
<li class="nav-item nav-item-this"><a href="">API Reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -1238,7 +1238,7 @@ will announce it.</p>
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="understanding.html" title="Understanding Reticulum"
|
<a href="understanding.html" title="Understanding Reticulum"
|
||||||
>previous</a> |</li>
|
>previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">API Reference</a></li>
|
<li class="nav-item nav-item-this"><a href="">API Reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Search — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Search — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -29,7 +29,7 @@
|
|||||||
<li class="right" style="margin-right: 10px">
|
<li class="right" style="margin-right: 10px">
|
||||||
<a href="genindex.html" title="General Index"
|
<a href="genindex.html" title="General Index"
|
||||||
accesskey="I">index</a></li>
|
accesskey="I">index</a></li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Search</a></li>
|
<li class="nav-item nav-item-this"><a href="">Search</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -85,7 +85,7 @@
|
|||||||
<li class="right" style="margin-right: 10px">
|
<li class="right" style="margin-right: 10px">
|
||||||
<a href="genindex.html" title="General Index"
|
<a href="genindex.html" title="General Index"
|
||||||
>index</a></li>
|
>index</a></li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Search</a></li>
|
<li class="nav-item nav-item-this"><a href="">Search</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
File diff suppressed because one or more lines are too long
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Understanding Reticulum — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Understanding Reticulum — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -31,7 +31,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="interfaces.html" title="Supported Interfaces"
|
<a href="interfaces.html" title="Supported Interfaces"
|
||||||
accesskey="P">previous</a> |</li>
|
accesskey="P">previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Understanding Reticulum</a></li>
|
<li class="nav-item nav-item-this"><a href="">Understanding Reticulum</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -856,7 +856,7 @@ proof 11
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="interfaces.html" title="Supported Interfaces"
|
<a href="interfaces.html" title="Supported Interfaces"
|
||||||
>previous</a> |</li>
|
>previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Understanding Reticulum</a></li>
|
<li class="nav-item nav-item-this"><a href="">Understanding Reticulum</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Using Reticulum on Your System — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>Using Reticulum on Your System — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -31,7 +31,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="gettingstartedfast.html" title="Getting Started Fast"
|
<a href="gettingstartedfast.html" title="Getting Started Fast"
|
||||||
accesskey="P">previous</a> |</li>
|
accesskey="P">previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Using Reticulum on Your System</a></li>
|
<li class="nav-item nav-item-this"><a href="">Using Reticulum on Your System</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -330,7 +330,7 @@ WantedBy=multi-user.target
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="gettingstartedfast.html" title="Getting Started Fast"
|
<a href="gettingstartedfast.html" title="Getting Started Fast"
|
||||||
>previous</a> |</li>
|
>previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">Using Reticulum on Your System</a></li>
|
<li class="nav-item nav-item-this"><a href="">Using Reticulum on Your System</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>What is Reticulum? — Reticulum Network Stack 0.3.2 beta documentation</title>
|
<title>What is Reticulum? — Reticulum Network Stack 0.3.3 beta documentation</title>
|
||||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||||||
|
|
||||||
@ -31,7 +31,7 @@
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="index.html" title="Reticulum Network Stack Manual"
|
<a href="index.html" title="Reticulum Network Stack Manual"
|
||||||
accesskey="P">previous</a> |</li>
|
accesskey="P">previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">What is Reticulum?</a></li>
|
<li class="nav-item nav-item-this"><a href="">What is Reticulum?</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@ -184,7 +184,7 @@ network, and vice versa.</p>
|
|||||||
<li class="right" >
|
<li class="right" >
|
||||||
<a href="index.html" title="Reticulum Network Stack Manual"
|
<a href="index.html" title="Reticulum Network Stack Manual"
|
||||||
>previous</a> |</li>
|
>previous</a> |</li>
|
||||||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.2 beta documentation</a> »</li>
|
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.3 beta documentation</a> »</li>
|
||||||
<li class="nav-item nav-item-this"><a href="">What is Reticulum?</a></li>
|
<li class="nav-item nav-item-this"><a href="">What is Reticulum?</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
Loading…
Reference in New Issue
Block a user