Added markdown manual build

This commit is contained in:
Mark Qvist
2026-05-06 21:18:01 +02:00
parent 4d6e164d62
commit ec27d8bfde
18 changed files with 1025 additions and 166 deletions
+1 -39
View File
@@ -1,5 +1,3 @@
<a id="interfaces-main"></a>
# Configuring Interfaces
Reticulum supports using many kinds of devices as networking interfaces, and
@@ -15,8 +13,6 @@ For a high-level overview of how networks can be formed over different interface
types, have a look at the [Building Networks](networks.md#networks-main) chapter of this
manual.
<a id="interfaces-custom"></a>
## Custom Interfaces
In addition to the built-in interface types, Reticulum is **fully extensible** with
@@ -24,8 +20,6 @@ custom, user- or community-supplied interfaces, and creating custom interface
modules is straightforward. Please see the [custom interface](examples.md#example-custominterface)
example for basic interface code to build upon.
<a id="interfaces-auto"></a>
## Auto Interface
The `AutoInterface` enables communication with other discoverable Reticulum
@@ -113,8 +107,6 @@ the discovery scope by setting it to one of `link`, `admin`, `site`,
data_port = 49555
```
<a id="interfaces-backbone"></a>
## Backbone Interface
The Backbone interface is a very fast and resource efficient interface type, primarily
@@ -220,8 +212,6 @@ specify the target Yggdrasil IPv6 address and port, like so:
target_port = 4343
```
<a id="interfaces-tcps"></a>
## TCP Server Interface
The TCP Server interface is suitable for allowing other peers to connect over
@@ -296,8 +286,6 @@ you must use the i2p_tunneled option:
In almost all cases, it is easier to use the dedicated `I2PInterface`, but for complete
control, and using I2P routers running on external systems, this option also exists.
<a id="interfaces-tcpc"></a>
## TCP Client Interface
To connect to a TCP server interface, you can use the TCP client
@@ -369,8 +357,6 @@ you must use the i2p_tunneled option:
i2p_tunneled = yes
```
<a id="interfaces-udp"></a>
## UDP Interface
A UDP interface can be useful for communicating over IP networks, both
@@ -429,8 +415,6 @@ easier to use.
# forward_port = 4242
```
<a id="interfaces-i2p"></a>
## I2P Interface
The I2P interface lets you connect Reticulum instances over the
@@ -495,8 +479,6 @@ 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.
<a id="interfaces-rnode"></a>
## RNode LoRa Interface
To use Reticulum over LoRa, the [RNode](https://unsigned.io/rnode/) interface
@@ -594,8 +576,6 @@ relevant regulation for your location, and to make decisions accordingly.
# airtime_limit_short = 33
```
<a id="interfaces-rnode-multi"></a>
## RNode Multi Interface
For RNodes that support multiple LoRa transceivers, the RNode
@@ -713,8 +693,6 @@ port = /dev/ttyACM0
# airtime_limit_short = 100
```
<a id="interfaces-serial"></a>
## Serial Interface
Reticulum can be used over serial ports directly, or over any device with a
@@ -737,8 +715,6 @@ directly over a wire-pair, or for using devices such as data radios and lasers.
stopbits = 1
```
<a id="interfaces-pipe"></a>
## Pipe Interface
Using this interface, Reticulum can use any program as an interface via stdin and
@@ -761,8 +737,6 @@ Reticulum will write all packets to stdin of the `command` option, and will
continuously read and scan its stdout for Reticulum packets. If `EOF` is reached,
Reticulum will try to respawn the program after waiting for `respawn_interval` seconds.
<a id="interfaces-kiss"></a>
## KISS Interface
With the KISS interface, you can use Reticulum over a variety of packet
@@ -821,8 +795,6 @@ relevant regulation for your location, and to make decisions accordingly.
flow_control = false
```
<a id="interfaces-ax25"></a>
## AX.25 KISS Interface
If youre using Reticulum on amateur radio spectrum, you might want to
@@ -887,8 +859,6 @@ relevant regulation for your location, and to make decisions accordingly.
flow_control = false
```
<a id="interfaces-discoverable"></a>
## Discoverable Interfaces
Reticulum includes a powerful system for publishing your local interfaces to the wider network, allowing other peers to [discover, validate, and automatically connect to them](using.md#using-interface-discovery). This feature is particularly useful for creating decentralized networks where peers can dynamically find entrypoints, such as public Internet gateways or local radio access points, without relying on static configuration files or centralized directories.
@@ -1085,8 +1055,6 @@ With these configuration options applied, your Reticulum instance will actively
For information on how to use these discovered interfaces and configure your system to auto-connect to them, refer to the [Discovering Interfaces](using.md#using-interface-discovery) chapter.
<a id="interfaces-options"></a>
## Common Interface Options
A number of general configuration options are available on most interfaces.
@@ -1169,8 +1137,6 @@ These can be used to control various aspects of interface behaviour.
> infrastructure, which then supersedes the bootstrap interface.
> <br/>
<a id="interfaces-modes"></a>
## Interface Modes
The optional `mode` setting is available on all interfaces, and allows
@@ -1249,8 +1215,6 @@ the default mode.
For a table describing the impact of all modes on announce propagation,
please see the [Announce Propagation Rules](understanding.md#understanding-announcepropagation) section.
<a id="interfaces-announcerates"></a>
## Announce Rate Control
The built-in announce control mechanisms and the default `announce_cap`
@@ -1313,8 +1277,6 @@ conserve bandwidth, while very fast networks can support applications that
need more frequent announces. Reticulum implements these mechanisms to ensure
that a large span of network types can seamlessly *co-exist* and interconnect.
<a id="interfaces-ingress-control"></a>
## New Destination Rate Limiting
On public interfaces, where anyone may connect and announce new destinations,
@@ -1381,4 +1343,4 @@ but all the parameters are exposed for configuration if needed.
> * The `ic_held_release_interval` option sets how much time (in seconds)
> must pass between releasing each held announce from the queue. Defaults
> to `30` seconds.
> <br/>
> <br/>