mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-10-26 10:51:49 -04:00
604 lines
No EOL
42 KiB
HTML
604 lines
No EOL
42 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en" data-content_root="./">
|
||
<head><meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Using Reticulum on Your System" href="using.html"><link rel="prev" title="Zen of Reticulum" href="zen.html">
|
||
<link rel="prefetch" href="_static/rns_logo_512.png" as="image">
|
||
|
||
<!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25.dev1 -->
|
||
<title>Programs Using Reticulum - Reticulum Network Stack 1.5.5 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=580074bf" />
|
||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=e1715074" />
|
||
|
||
|
||
|
||
|
||
<style>
|
||
body {
|
||
--color-code-background: #f2f2f2;
|
||
--color-code-foreground: #1e1e1e;
|
||
|
||
}
|
||
@media not print {
|
||
body[data-theme="dark"] {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
--color-background-primary: #202b38;
|
||
--color-background-secondary: #161f27;
|
||
--color-foreground-primary: #dbdbdb;
|
||
--color-foreground-secondary: #a9b1ba;
|
||
--color-brand-primary: #41adff;
|
||
--color-background-hover: #161f27;
|
||
--color-api-name: #ffbe85;
|
||
--color-api-pre-name: #efae75;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
body:not([data-theme="light"]) {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
--color-background-primary: #202b38;
|
||
--color-background-secondary: #161f27;
|
||
--color-foreground-primary: #dbdbdb;
|
||
--color-foreground-secondary: #a9b1ba;
|
||
--color-brand-primary: #41adff;
|
||
--color-background-hover: #161f27;
|
||
--color-api-name: #ffbe85;
|
||
--color-api-pre-name: #efae75;
|
||
|
||
}
|
||
}
|
||
}
|
||
</style></head>
|
||
<body>
|
||
|
||
<script>
|
||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||
</script>
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
<title>Light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
<circle cx="12" cy="12" r="5"></circle>
|
||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
<title>Dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||
<title>Auto light/dark, in light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||
<title>Auto light/dark, in dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||
<path d="M13.5 6.5l4 4" />
|
||
<path d="M20 21l2 -2l-2 -2" />
|
||
<path d="M17 17l-2 2l2 2" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||
<path
|
||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||
<path d="M20 21l2 -2l-2 -2" />
|
||
<path d="M17 17l-2 2l2 2" />
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||
<label class="overlay toc-overlay" for="__toc"></label>
|
||
|
||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="index.html"><div class="brand">Reticulum Network Stack 1.5.5 documentation</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<div class="theme-toggle-container theme-toggle-header">
|
||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||
</label>
|
||
</div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||
<div class="sidebar-logo-container">
|
||
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
|
||
</div>
|
||
|
||
<span class="sidebar-brand-text">Reticulum Network Stack 1.5.5 documentation</span>
|
||
|
||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form>
|
||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="whatis.html">What is Reticulum?</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="gettingstartedfast.html">Getting Started Fast</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="zen.html">Zen of Reticulum</a></li>
|
||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Programs Using Reticulum</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="using.html">Using Reticulum on Your System</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Configuring Interfaces</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="distributed.html">Distributed Development</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="git.html">Git Over Reticulum</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="support.html">Support Reticulum</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Code Examples</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="license.html">Reticulum License</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="brandolinis.html">Brandolini’s Reference</a></li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<div class="main">
|
||
<div class="content">
|
||
<div class="article-container">
|
||
<a href="#" class="back-to-top muted-link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||
</svg>
|
||
<span>Back to top</span>
|
||
</a>
|
||
<div class="content-icon-container">
|
||
<div class="theme-toggle-container theme-toggle-content">
|
||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||
</label>
|
||
</div>
|
||
<article role="main" id="furo-main-content">
|
||
<section id="programs-using-reticulum">
|
||
<span id="software-main"></span><h1>Programs Using Reticulum<a class="headerlink" href="#programs-using-reticulum" title="Link to this heading">¶</a></h1>
|
||
<p>This chapter provides a non-exhaustive list of notable programs, systems and application-layer protocols that have been built using Reticulum.</p>
|
||
<p>Many different applications using Reticulum already exist, serving a wide variety of purposes from day-to-day communication and information sharing to systems administration and tackling advanced networking and communications challenges.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>For ease of discovery while reading this manual over the web or as an e-book, links provided in this chapter primarily point to repositories and pages located on internet servers. In many cases, these are public web mirrors, with the upstream repositories residing on Reticulum nodes. For the latest source, updates and information regarding any project, be sure to check their Nomad Network or <code class="docutils literal notranslate"><span class="pre">rngit</span></code> nodes.</p>
|
||
</div>
|
||
<p>These programs will let you get a feel for how Reticulum works. Most of them have been designed to run well even over slow networks based on LoRa or packet radio, but all can also be used over fast links, such as local WiFi, wired Ethernet, the Internet, or any combination.</p>
|
||
<p>As such, it is easy to get started experimenting, without having to set up any radio transceivers or infrastructure just to try it out. Launching the programs on separate devices connected to the same WiFi network is enough to get started, and physical radio interfaces can then be added later.</p>
|
||
<p>Development of Reticulum-based applications and systems is ongoing, so consider this list a non-exhaustive starting point of <em>some</em> of the options available. With a bit of searching, primarily over Reticulum itself, you will find many more interesting things.</p>
|
||
<section id="browsing-publishing">
|
||
<h2>Browsing & Publishing<a class="headerlink" href="#browsing-publishing" title="Link to this heading">¶</a></h2>
|
||
<p>In addition to the programs listed in this section, other Nomad Network clients include:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://meshchatx.com/">MeshChatX</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/torlando-tech/columba/">Columba</a></p></li>
|
||
</ul>
|
||
<section id="nomad-network">
|
||
<h3>Nomad Network<a class="headerlink" href="#nomad-network" title="Link to this heading">¶</a></h3>
|
||
<p>The terminal-based program <a class="reference external" href="https://github.com/markqvist/nomadnet">Nomad Network</a> provides a complete encrypted communications suite built with Reticulum.</p>
|
||
<a class="reference external image-reference" href="https://github.com/markqvist/nomadnet"><img alt="_images/nomadnet_6.webp" class="align-center" src="_images/nomadnet_6.webp" />
|
||
</a>
|
||
<p>It features encrypted LXMF messaging (both direct and delayed-delivery for offline users), file sharing, and has a built-in text-browser and page server with support for dynamically rendered pages, user authentication and more. It also includes an RRC client and a suite of network utilities.</p>
|
||
</section>
|
||
<section id="ren-browser">
|
||
<h3>Ren Browser<a class="headerlink" href="#ren-browser" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/Quad4-Software/Ren-Browser">Ren Browser</a> is a modern, standalone browser for Nomad Network using the <a class="reference external" href="https://github.com/Quad4-Software/Reticulum-Go">Reticulum-Go</a> implementation. The project is actively being developed, and should be considered alpha level software, but much of the functionality is already working. If you want to help expanding the ecosystem, this is an excellent project to take a look at.</p>
|
||
<a class="reference external image-reference" href="https://github.com/fr33n0w/rBrowser"><img alt="_images/ren_browser.webp" class="align-center" src="_images/ren_browser.webp" />
|
||
</a>
|
||
<p>Ren Browser is great example of an application aiming for true, seamless interoperability with the existing software ecosystem. It can operate fully standalone using it’s own embedded <a class="reference external" href="https://github.com/Quad4-Software/Reticulum-Go">Go implementation</a> of Reticulum, or seamlessly utilise a shared RNS instance already running on the system.</p>
|
||
</section>
|
||
<section id="rns-page-node">
|
||
<h3>RNS Page Node<a class="headerlink" href="#rns-page-node" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/Quad4-Software/rns-page-node">RNS Page Node</a> is a simple way to serve pages and files to any other Nomad Network compatible client. Drop-in replacement for NomadNet nodes that primarily serve pages and files.</p>
|
||
</section>
|
||
<section id="retipedia">
|
||
<h3>Retipedia<a class="headerlink" href="#retipedia" title="Link to this heading">¶</a></h3>
|
||
<p>You can host the entirity of Wikipedia, StackExchange or any other <code class="docutils literal notranslate"><span class="pre">.zim</span></code> file, to Nomad Network clients using <a class="reference external" href="https://github.com/RFnexus/Retipedia">Retipedia</a>.</p>
|
||
<a class="reference external image-reference" href="https://github.com/RFnexus/Retipedia"><img alt="_images/retipedia.webp" class="align-center" src="_images/retipedia.webp" />
|
||
</a>
|
||
</section>
|
||
<section id="git-over-reticulum">
|
||
<h3>Git Over Reticulum<a class="headerlink" href="#git-over-reticulum" title="Link to this heading">¶</a></h3>
|
||
<p>The included <a class="reference internal" href="git.html#git-main"><span class="std std-ref">rngit</span></a> system provides a fully distributed solution for managing, hosting, collaborating on and interacting with Git repositories over Reticulum.</p>
|
||
<img alt="_images/rngit.webp" class="align-center" src="_images/rngit.webp" />
|
||
</section>
|
||
</section>
|
||
<section id="messaging-voice">
|
||
<h2>Messaging & Voice<a class="headerlink" href="#messaging-voice" title="Link to this heading">¶</a></h2>
|
||
<section id="sideband">
|
||
<h3>Sideband<a class="headerlink" href="#sideband" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/markqvist/Sideband">Sideband</a> is a technical LXMF and LXST client, for Android, Linux, macOS and Windows. It also serves as a multi-purpose Reticulum utility, with features and functionality targeted at advanced users.</p>
|
||
<a class="reference external image-reference" href="https://github.com/markqvist/Sideband"><img alt="_images/sideband_devices.webp" class="align-center" src="_images/sideband_devices.webp" />
|
||
</a>
|
||
<p>Sideband allows you to communicate with other people or LXMF-compatible systems over Reticulum networks using LoRa, Packet Radio, WiFi, I2P, Encrypted QR Paper Messages, or anything else Reticulum supports.</p>
|
||
<p>It interoperates with all other LXMF clients, and provides advanced features such as PTT and voice messaging, real-time voice calls, file attachments, private telemetry sharing, and a full plugin system for expandability.</p>
|
||
</section>
|
||
<section id="id6">
|
||
<h3>MeshChatX<a class="headerlink" href="#id6" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://meshchatx.com/">MeshChatX</a> is an all-in-one Reticulum client with messaging, calling, and a NomadNet browser, providing everything you need for Reticulum, LXMF, and LXST in one beautiful and feature-rich application.</p>
|
||
<a class="reference external image-reference" href="https://meshchatx.com/"><img alt="_images/meshchatx.webp" class="align-center" src="_images/meshchatx.webp" />
|
||
</a>
|
||
<p>Features include full LXST support, custom voicemail, phonebook, contact sharing, ringtone support, multi-identity handling, modern UI/UX, offline documentation, expanded tools, page archiving, integrated maps, telemetry and improved application security.</p>
|
||
</section>
|
||
<section id="id8">
|
||
<h3>Columba<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/torlando-tech/columba/">Columba</a> is a simple and familiar LXMF messaging app Android, built with a native Android interface and Material Design 3. It also includes LXST voice call functionality, and a mobile Nomad Network page browser.</p>
|
||
<a class="reference external image-reference" href="https://github.com/torlando-tech/columba/"><img alt="_images/columba.webp" class="align-center" src="_images/columba.webp" />
|
||
</a>
|
||
</section>
|
||
<section id="ren-tui">
|
||
<h3>Ren TUI<a class="headerlink" href="#ren-tui" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/Quad4-Software/Ren-TUI">Ren TUI</a> is an early prototype terminal LXMF client for Reticulum built with Odin on librns (Reticulum-Go). It aims for NomadNet-like messaging/browsing without urwid or ncurses.</p>
|
||
<a class="reference external image-reference" href="https://github.com/Quad4-Software/Ren-TUI"><img alt="_images/rentui.webp" class="align-center" src="_images/rentui.webp" />
|
||
</a>
|
||
</section>
|
||
</section>
|
||
<section id="chat">
|
||
<h2>Chat<a class="headerlink" href="#chat" title="Link to this heading">¶</a></h2>
|
||
<section id="reticulum-relay-chat">
|
||
<h3>Reticulum Relay Chat<a class="headerlink" href="#reticulum-relay-chat" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://rrc.kc1awv.net/">Reticulum Relay Chat</a> is a live chat system built on top of the Reticulum Network Stack. It exists to let people talk to each other in real time over Reticulum without dragging in message databases, synchronization engines, or architectural commitments they did not ask for.</p>
|
||
<img alt="_images/rrc.webp" class="align-center" src="_images/rrc.webp" />
|
||
<p>RRC is closer in spirit to IRC than to modern “everything platforms.” You connect, you join a room, you talk, and then you leave. If you were present, you saw the conversation. If you were not, the conversation did not wait for you. This is not an accident. This is the entire design.</p>
|
||
<p>The <a class="reference external" href="https://github.com/kc1awv/rrcd">rrcd</a> program provides a functional, reference RRC hub-server daemon implementation. RRC user clients include:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://github.com/markqvist/NomadNet/">Nomad Network</a></p></li>
|
||
<li><p><a class="reference external" href="https://meshchatx.com/">MeshChatX</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/torlando-tech/eridanus">Eridanus</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/kc1awv/rrc-gui">rrc-gui</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/kc1awv/rrc-web">rrc-web</a></p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="retibbs">
|
||
<h3>RetiBBS<a class="headerlink" href="#retibbs" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/kc1awv/RetiBBS">RetiBBS</a> is an old-school bulletin board system implementation for Reticulum networks.</p>
|
||
<a class="reference external image-reference" href="https://github.com/kc1awv/RetiBBS"><img alt="_images/retibbs.webp" class="align-center" src="_images/retibbs.webp" />
|
||
</a>
|
||
<p>RetiBBS allows users to communicate through message boards in a secure manner.</p>
|
||
</section>
|
||
</section>
|
||
<section id="voice-telephony">
|
||
<h2>Voice & Telephony<a class="headerlink" href="#voice-telephony" title="Link to this heading">¶</a></h2>
|
||
<p>In addition to the programs listed in this section, other LXST voice clients include:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://github.com/markqvist/Sideband">Sideband</a></p></li>
|
||
<li><p><a class="reference external" href="https://meshchatx.com/">MeshChatX</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/torlando-tech/columba/">Columba</a></p></li>
|
||
</ul>
|
||
<section id="reticulum-network-telephone">
|
||
<h3>Reticulum Network Telephone<a class="headerlink" href="#reticulum-network-telephone" title="Link to this heading">¶</a></h3>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">rnphone</span></code> program, included as part of the <a class="reference external" href="https://github.com/markqvist/LXST">LXST</a> package is a command-line Reticulum telephone utility and daemon, that allows building physical, hardware telephones for LXST and Reticulum, as well as simply performing calls via the command line.</p>
|
||
<a class="reference external image-reference" href="https://github.com/markqvist/LXST"><img alt="_images/rnphone.webp" class="align-center" src="_images/rnphone.webp" />
|
||
</a>
|
||
<p>It supports interfacing directly with hardware peripherals such as GPIO keypads and LCD displays, providing a modular system for building secure hardware telephones.</p>
|
||
</section>
|
||
<section id="partyline">
|
||
<h3>Partyline<a class="headerlink" href="#partyline" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/RFnexus/partyline">Partyline</a> is a group voice application for Reticulum, built on <a class="reference external" href="https://github.com/markqvist/LXST">LXST</a>, inspired by <a class="reference external" href="https://github.com/mumble-voip/mumble">Mumble</a>.</p>
|
||
<a class="reference external image-reference" href="https://github.com/markqvist/LXST"><img alt="_images/partyline.webp" class="align-center" src="_images/partyline.webp" />
|
||
</a>
|
||
<p>It provides both realtime group voice over any Reticulum transport capable of >6 kilobits per second, LXST dial-in support, listen-only music/broadcasting rooms, and many other useful functions.</p>
|
||
</section>
|
||
<section id="lxst-phone">
|
||
<h3>LXST Phone<a class="headerlink" href="#lxst-phone" title="Link to this heading">¶</a></h3>
|
||
<p>The <a class="reference external" href="https://github.com/kc1awv/lxst_phone">LXST Phone</a> program is a cross-platform desktop application for performing LXST voice calls over Reticulum. It supports various advanced features such as SAS verification, peer blocking, rate limiting, encrypted call history storage and contact management.</p>
|
||
<a class="reference external image-reference" href="https://github.com/kc1awv/lxst_phone"><img alt="_images/lxst_phone.webp" class="align-center" src="_images/lxst_phone.webp" />
|
||
</a>
|
||
</section>
|
||
</section>
|
||
<section id="system-administration">
|
||
<h2>System Administration<a class="headerlink" href="#system-administration" title="Link to this heading">¶</a></h2>
|
||
<section id="remote-shell">
|
||
<h3>Remote Shell<a class="headerlink" href="#remote-shell" title="Link to this heading">¶</a></h3>
|
||
<p>The included <a class="reference internal" href="using.html#using-rnsh"><span class="std std-ref">rnsh</span></a> program lets you establish fully interactive
|
||
remote shell sessions over Reticulum. It also allows you to pipe any program to or from a
|
||
remote system, and is similar to how <code class="docutils literal notranslate"><span class="pre">ssh</span></code> works. The <code class="docutils literal notranslate"><span class="pre">rnsh</span></code> program is very efficient, and
|
||
can facilitate fully interactive shell sessions, even over extremely low-bandwidth links,
|
||
such as LoRa or packet radio.</p>
|
||
<p>In addition to the default, fully interactive terminal mode, for extremely limited links,
|
||
<code class="docutils literal notranslate"><span class="pre">rnsh</span></code> offers line-interactive mode, allowing you to interact with remote systems, even
|
||
when link throughput is counted in a few hundreds of bits per second.</p>
|
||
</section>
|
||
<section id="rns-filesync">
|
||
<h3>RNS FileSync<a class="headerlink" href="#rns-filesync" title="Link to this heading">¶</a></h3>
|
||
<p>The <a class="reference external" href="https://github.com/Quad4-Software/RNS-Filesync">RNS FileSync</a> program enables automatic file synchronization between devices without requiring central servers, internet connectivity, or cloud services. It works over any network medium supported by Reticulum, including radio, LoRa, WiFi, or the internet, making it ideal for off-grid, privacy-focused, and resilient file sharing.</p>
|
||
</section>
|
||
</section>
|
||
<section id="utilities-components">
|
||
<h2>Utilities & Components<a class="headerlink" href="#utilities-components" title="Link to this heading">¶</a></h2>
|
||
<section id="modem73">
|
||
<h3>Modem73<a class="headerlink" href="#modem73" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/RFnexus/modem73">MODEM73</a> and its companion <a class="reference external" href="https://github.com/RFnexus/modem73interface">Modem73Interface</a> is an open source software modem that works with any HF, VHF, or UHF radio capable of 2400 Hz of bandwidth. All you need is a sound card and audio cable for your radio.</p>
|
||
<a class="reference external image-reference" href="https://github.com/RFnexus/modem73"><img alt="_images/modem73.webp" class="align-center" src="_images/modem73.webp" />
|
||
</a>
|
||
</section>
|
||
<section id="lxmfy">
|
||
<h3>LXMFy<a class="headerlink" href="#lxmfy" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://lxmfy.quad4.io/">LXMFy</a> is a comprehensive and advanced bot creation framework for LXMF, that allows building any kind of automation or bot system running over LXMF and Reticulum. <a class="reference external" href="https://lxmfy.quad4.io/latest/creating-bots/">Bot implementations exist</a> for Home Assistant control, LLM integrations, and various other purposes.</p>
|
||
</section>
|
||
<section id="micron-parser-js">
|
||
<h3>Micron Parser JS<a class="headerlink" href="#micron-parser-js" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/RFnexus/micron-parser-js">Micron Parser JS</a> is the JavaScript-based parser for the Micron markup language, that most web-based Nomad Network browsers use. If you want to make utilities or tools that display Micron pages, this library is essential.</p>
|
||
</section>
|
||
<section id="reticulated">
|
||
<h3>Reticulated<a class="headerlink" href="#reticulated" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/RFnexus/Reticulated">Reticulated</a> is a Reticulum Network simulator that spawns live, interactive Reticulum instances controllable from a node-based Web UI.</p>
|
||
<a class="reference external image-reference" href="https://github.com/RFnexus/Reticulated"><img alt="_images/reticulated.webp" class="align-center" src="_images/reticulated.webp" />
|
||
</a>
|
||
<p>You can create networks of any topology and set bitrate, MTU, and configure path loss and propagation behavior. It provides a top-down view to a live network. You can connect any Reticulum application to the simulated network. It also has built in utilities like a basic LXMF chat function and Resource transfer included.</p>
|
||
</section>
|
||
<section id="rnmon">
|
||
<h3>RNMon<a class="headerlink" href="#rnmon" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/lbatalha/rnmon">RNMon</a> is a monitoring daemon designed to monitor the status of multiple RNS applications and push the metrics to an InfluxDB instance over the influx line protocol.</p>
|
||
</section>
|
||
</section>
|
||
<section id="device-flashers">
|
||
<h2>Device Flashers<a class="headerlink" href="#device-flashers" title="Link to this heading">¶</a></h2>
|
||
<p>In addition to the included command-line <code class="docutils literal notranslate"><span class="pre">rnodeconf</span></code> flasher, several community-provided RNode device flashers exist:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://flasher.rns.moscow/">RNS Moscow</a></p></li>
|
||
<li><p><a class="reference external" href="https://flasher.aetherlab.org/">Aetherlab</a></p></li>
|
||
</ul>
|
||
<p>Several programs, such as <a class="reference external" href="https://github.com/markqvist/Sideband">Sideband</a> and <a class="reference external" href="https://meshchatx.com/">MeshChatX</a> also include built-in device flashers that can be used fully offline.</p>
|
||
</section>
|
||
<section id="protocols">
|
||
<h2>Protocols<a class="headerlink" href="#protocols" title="Link to this heading">¶</a></h2>
|
||
<p>A number of standard protocols have emerged through real-world usage and testing in the Reticulum community. While you may sometimes want to use completely custom protocols and implementations when writing Reticulum-based software, using these protocols provides application developers with an easy way to implement advanced functionality quickly and effortlessly. Using them also ensures compatibility and interoperability between many different client applications, creating an open communications ecosystem where users are free to choose the applications that suit their needs, while remaining connected to everyone else.</p>
|
||
<section id="lxmf">
|
||
<h3>LXMF<a class="headerlink" href="#lxmf" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/markqvist/lxmf">LXMF</a> is a simple and flexible messaging format and delivery protocol that allows a wide variety of applications, while using as little bandwidth as possible. It offers zero-conf message routing, end-to-end encryption and Forward Secrecy, and can be transported over any kind of medium that Reticulum supports.</p>
|
||
<p>LXMF is efficient enough that it can deliver messages over extremely low-bandwidth systems such as packet radio or LoRa. Encrypted LXMF messages can also be encoded as QR-codes or text-based URIs, allowing completely analog paper message transport.</p>
|
||
<p>Using Propagation Nodes, LXMF also offer a way to store and forward messages to users or endpoints that are not directly reachable at the time of message emission.</p>
|
||
</section>
|
||
<section id="id30">
|
||
<h3>LXST<a class="headerlink" href="#id30" title="Link to this heading">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/markqvist/lxst">LXST</a> is a simple and flexible real-time streaming format and delivery protocol that allows a wide variety of applications, while using as little bandwidth as possible. It is built on top of Reticulum and offers zero-conf stream routing, end-to-end encryption and Forward Secrecy, and can be transported over any kind of medium that Reticulum supports. It currently powers real-time voice and telephony applications over Reticulum.</p>
|
||
</section>
|
||
<section id="rrc">
|
||
<h3>RRC<a class="headerlink" href="#rrc" title="Link to this heading">¶</a></h3>
|
||
<p>The <a class="reference external" href="https://rrc.kc1awv.net/">Reticulum Relay Chat</a> protocol, is a live chat system built on top of the Reticulum Network Stack. It exists to provide near real-time group communication without dragging in message history databases, federation machinery, or architectural guilt.</p>
|
||
<p>RRC is intentionally simple. It does not pretend to be email, a mailbox, or a distributed archive. It behaves more like a conversation in a room. If you were there, you heard it. If you were not, you did not. That is not a bug, that is the point.</p>
|
||
</section>
|
||
</section>
|
||
<section id="interface-modules-connectivity-resources">
|
||
<h2>Interface Modules & Connectivity Resources<a class="headerlink" href="#interface-modules-connectivity-resources" title="Link to this heading">¶</a></h2>
|
||
<p>This section provides a list of various community-provided interface modules, guides and resources for creating Reticulum networks over special or challenging mediums.</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://github.com/RFnexus/modem73">Modem73</a> is an efficient software modem that can be used with Reticulum</p></li>
|
||
<li><p>Custom interface module for running <a class="reference external" href="https://github.com/Quad4-Software/RNS-over-HTTP">RNS over HTTP</a></p></li>
|
||
<li><p>Guide for running <a class="reference external" href="https://github.com/matvik22000/rns-over-icmp">Reticulum over ICMP</a> using <code class="docutils literal notranslate"><span class="pre">PipeInterface</span></code></p></li>
|
||
<li><p>Guide for running <a class="reference external" href="https://github.com/markqvist/Reticulum/discussions/1002">Reticulum over DNS</a> with Iodine</p></li>
|
||
<li><p>Guide for running <a class="reference external" href="https://github.com/RFnexus/reticulum-over-hf">Reticulum over HF radio</a></p></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
|
||
</article>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="using.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">Using Reticulum on Your System</div>
|
||
</div>
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
<a class="prev-page" href="zen.html">
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Previous</span>
|
||
</div>
|
||
|
||
<div class="title">Zen of Reticulum</div>
|
||
|
||
</div>
|
||
</a>
|
||
</div>
|
||
<div class="bottom-of-page">
|
||
<div class="left-details">
|
||
<div class="copyright">
|
||
Copyright © 2025, Mark Qvist
|
||
</div>
|
||
Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
|
||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||
|
||
</div>
|
||
<div class="right-details">
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer">
|
||
|
||
|
||
<div class="toc-sticky toc-scroll">
|
||
<div class="toc-title-container">
|
||
<span class="toc-title">
|
||
On this page
|
||
</span>
|
||
</div>
|
||
<div class="toc-tree-container">
|
||
<div class="toc-tree">
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Programs Using Reticulum</a><ul>
|
||
<li><a class="reference internal" href="#browsing-publishing">Browsing & Publishing</a><ul>
|
||
<li><a class="reference internal" href="#nomad-network">Nomad Network</a></li>
|
||
<li><a class="reference internal" href="#ren-browser">Ren Browser</a></li>
|
||
<li><a class="reference internal" href="#rns-page-node">RNS Page Node</a></li>
|
||
<li><a class="reference internal" href="#retipedia">Retipedia</a></li>
|
||
<li><a class="reference internal" href="#git-over-reticulum">Git Over Reticulum</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#messaging-voice">Messaging & Voice</a><ul>
|
||
<li><a class="reference internal" href="#sideband">Sideband</a></li>
|
||
<li><a class="reference internal" href="#id6">MeshChatX</a></li>
|
||
<li><a class="reference internal" href="#id8">Columba</a></li>
|
||
<li><a class="reference internal" href="#ren-tui">Ren TUI</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#chat">Chat</a><ul>
|
||
<li><a class="reference internal" href="#reticulum-relay-chat">Reticulum Relay Chat</a></li>
|
||
<li><a class="reference internal" href="#retibbs">RetiBBS</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#voice-telephony">Voice & Telephony</a><ul>
|
||
<li><a class="reference internal" href="#reticulum-network-telephone">Reticulum Network Telephone</a></li>
|
||
<li><a class="reference internal" href="#partyline">Partyline</a></li>
|
||
<li><a class="reference internal" href="#lxst-phone">LXST Phone</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#system-administration">System Administration</a><ul>
|
||
<li><a class="reference internal" href="#remote-shell">Remote Shell</a></li>
|
||
<li><a class="reference internal" href="#rns-filesync">RNS FileSync</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#utilities-components">Utilities & Components</a><ul>
|
||
<li><a class="reference internal" href="#modem73">Modem73</a></li>
|
||
<li><a class="reference internal" href="#lxmfy">LXMFy</a></li>
|
||
<li><a class="reference internal" href="#micron-parser-js">Micron Parser JS</a></li>
|
||
<li><a class="reference internal" href="#reticulated">Reticulated</a></li>
|
||
<li><a class="reference internal" href="#rnmon">RNMon</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#device-flashers">Device Flashers</a></li>
|
||
<li><a class="reference internal" href="#protocols">Protocols</a><ul>
|
||
<li><a class="reference internal" href="#lxmf">LXMF</a></li>
|
||
<li><a class="reference internal" href="#id30">LXST</a></li>
|
||
<li><a class="reference internal" href="#rrc">RRC</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#interface-modules-connectivity-resources">Interface Modules & Connectivity Resources</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</aside>
|
||
</div>
|
||
</div><script src="_static/documentation_options.js?v=b8aeccfa"></script>
|
||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
|
||
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
|
||
<script src="_static/copybutton.js?v=f281be69"></script>
|
||
</body>
|
||
</html> |