575 lines
		
	
	
		
			29 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			575 lines
		
	
	
		
			29 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| 
 | ||
| <!DOCTYPE html>
 | ||
| 
 | ||
| <html>
 | ||
|   <head>
 | ||
|     <meta charset="utf-8" />
 | ||
|     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 | ||
|     <title>Using Reticulum on Your System — Reticulum Network Stack 0.3.8 beta documentation</title>
 | ||
|     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
 | ||
|     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 | ||
|     
 | ||
|     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
 | ||
|     <script src="_static/jquery.js"></script>
 | ||
|     <script src="_static/underscore.js"></script>
 | ||
|     <script src="_static/doctools.js"></script>
 | ||
|     
 | ||
|     <link rel="index" title="Index" href="genindex.html" />
 | ||
|     <link rel="search" title="Search" href="search.html" />
 | ||
|     <link rel="next" title="Building Networks" href="networks.html" />
 | ||
|     <link rel="prev" title="Getting Started Fast" href="gettingstartedfast.html" /> 
 | ||
|   </head><body>
 | ||
|     <div class="related" role="navigation" aria-label="related navigation">
 | ||
|       <h3>Navigation</h3>
 | ||
|       <ul>
 | ||
|         <li class="right" style="margin-right: 10px">
 | ||
|           <a href="genindex.html" title="General Index"
 | ||
|              accesskey="I">index</a></li>
 | ||
|         <li class="right" >
 | ||
|           <a href="networks.html" title="Building Networks"
 | ||
|              accesskey="N">next</a> |</li>
 | ||
|         <li class="right" >
 | ||
|           <a href="gettingstartedfast.html" title="Getting Started Fast"
 | ||
|              accesskey="P">previous</a> |</li>
 | ||
|         <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.8 beta documentation</a> »</li>
 | ||
|         <li class="nav-item nav-item-this"><a href="">Using Reticulum on Your System</a></li> 
 | ||
|       </ul>
 | ||
|     </div>  
 | ||
| 
 | ||
|     <div class="document">
 | ||
|       <div class="documentwrapper">
 | ||
|         <div class="bodywrapper">
 | ||
|           <div class="body" role="main">
 | ||
|             
 | ||
|   <div class="section" id="using-reticulum-on-your-system">
 | ||
| <span id="using-main"></span><h1>Using Reticulum on Your System<a class="headerlink" href="#using-reticulum-on-your-system" title="Permalink to this headline">¶</a></h1>
 | ||
| <p>Reticulum is not installed as a driver or kernel module, as one might expect
 | ||
| of a networking stack. Instead, Reticulum is distributed as a Python module.
 | ||
| This means that no special privileges are required to install or use it. It
 | ||
| is also very light-weight, and easy to transfer to and install on new systems.
 | ||
| Any program or application that uses Reticulum will automatically load and
 | ||
| initialise Reticulum when it starts.</p>
 | ||
| <p>In many cases, this approach is sufficient. When any program needs to use
 | ||
| Reticulum, it is loaded, initialised, interfaces are brought up, and the
 | ||
| program can now communicate over any Reticulum networks available. If another
 | ||
| program starts up and also wants access to the same Reticulum network, the
 | ||
| instance is simply shared. This works for any number of programs running
 | ||
| concurrently, and is very easy to use, but depending on your use case, there
 | ||
| are other options.</p>
 | ||
| <div class="section" id="configuration-data">
 | ||
| <h2>Configuration & Data<a class="headerlink" href="#configuration-data" title="Permalink to this headline">¶</a></h2>
 | ||
| <p>A Reticulum stores all information that it needs to function in a single file-
 | ||
| system directory. By default, this directory is <code class="docutils literal notranslate"><span class="pre">~/.reticulum</span></code>, but you can
 | ||
| use any directory you wish. You can also run multiple separate Reticulum
 | ||
| instances on the same physical system, in complete isolation from each other,
 | ||
| or connected together.</p>
 | ||
| <p>In most cases, a single physical system will only need to run one Reticulum
 | ||
| instance. This can either be launched at boot, as a system service, or simply
 | ||
| be brought up when a program needs it. In either case, any number of programs
 | ||
| running on the same system will automatically share the same Reticulum instance,
 | ||
| if the configuration allows for it, which it does by default.</p>
 | ||
| <p>The entire configuration of Reticulum is found in the <code class="docutils literal notranslate"><span class="pre">~/.reticulum/config</span></code>
 | ||
| file. When Reticulum is first started on a new system, a basic, functional
 | ||
| configuration file is created. The default configuration looks like this:</p>
 | ||
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This is the default Reticulum config file.</span>
 | ||
| <span class="c1"># You should probably edit it to include any additional,</span>
 | ||
| <span class="c1"># interfaces and settings you might need.</span>
 | ||
| 
 | ||
| <span class="c1"># Only the most basic options are included in this default</span>
 | ||
| <span class="c1"># configuration. To see a more verbose, and much longer,</span>
 | ||
| <span class="c1"># configuration example, you can run the command:</span>
 | ||
| <span class="c1"># rnsd --exampleconfig</span>
 | ||
| 
 | ||
| 
 | ||
| <span class="p">[</span><span class="n">reticulum</span><span class="p">]</span>
 | ||
| 
 | ||
| <span class="c1"># If you enable Transport, your system will route traffic</span>
 | ||
| <span class="c1"># for other peers, pass announces and serve path requests.</span>
 | ||
| <span class="c1"># This should only be done for systems that are suited to</span>
 | ||
| <span class="c1"># act as transport nodes, ie. if they are stationary and</span>
 | ||
| <span class="c1"># always-on. This directive is optional and can be removed</span>
 | ||
| <span class="c1"># for brevity.</span>
 | ||
| 
 | ||
| <span class="n">enable_transport</span> <span class="o">=</span> <span class="kc">False</span>
 | ||
| 
 | ||
| 
 | ||
| <span class="c1"># By default, the first program to launch the Reticulum</span>
 | ||
| <span class="c1"># Network Stack will create a shared instance, that other</span>
 | ||
| <span class="c1"># programs can communicate with. Only the shared instance</span>
 | ||
| <span class="c1"># opens all the configured interfaces directly, and other</span>
 | ||
| <span class="c1"># local programs communicate with the shared instance over</span>
 | ||
| <span class="c1"># a local socket. This is completely transparent to the</span>
 | ||
| <span class="c1"># user, and should generally be turned on. This directive</span>
 | ||
| <span class="c1"># is optional and can be removed for brevity.</span>
 | ||
| 
 | ||
| <span class="n">share_instance</span> <span class="o">=</span> <span class="n">Yes</span>
 | ||
| 
 | ||
| 
 | ||
| <span class="c1"># If you want to run multiple *different* shared instances</span>
 | ||
| <span class="c1"># on the same system, you will need to specify different</span>
 | ||
| <span class="c1"># shared instance ports for each. The defaults are given</span>
 | ||
| <span class="c1"># below, and again, these options can be left out if you</span>
 | ||
| <span class="c1"># don't need them.</span>
 | ||
| 
 | ||
| <span class="n">shared_instance_port</span> <span class="o">=</span> <span class="mi">37428</span>
 | ||
| <span class="n">instance_control_port</span> <span class="o">=</span> <span class="mi">37429</span>
 | ||
| 
 | ||
| 
 | ||
| <span class="c1"># You can configure Reticulum to panic and forcibly close</span>
 | ||
| <span class="c1"># if an unrecoverable interface error occurs, such as the</span>
 | ||
| <span class="c1"># hardware device for an interface disappearing. This is</span>
 | ||
| <span class="c1"># an optional directive, and can be left out for brevity.</span>
 | ||
| <span class="c1"># This behaviour is disabled by default.</span>
 | ||
| 
 | ||
| <span class="n">panic_on_interface_error</span> <span class="o">=</span> <span class="n">No</span>
 | ||
| 
 | ||
| 
 | ||
| <span class="p">[</span><span class="n">logging</span><span class="p">]</span>
 | ||
| <span class="c1"># Valid log levels are 0 through 7:</span>
 | ||
| <span class="c1">#   0: Log only critical information</span>
 | ||
| <span class="c1">#   1: Log errors and lower log levels</span>
 | ||
| <span class="c1">#   2: Log warnings and lower log levels</span>
 | ||
| <span class="c1">#   3: Log notices and lower log levels</span>
 | ||
| <span class="c1">#   4: Log info and lower (this is the default)</span>
 | ||
| <span class="c1">#   5: Verbose logging</span>
 | ||
| <span class="c1">#   6: Debug logging</span>
 | ||
| <span class="c1">#   7: Extreme logging</span>
 | ||
| 
 | ||
| <span class="n">loglevel</span> <span class="o">=</span> <span class="mi">4</span>
 | ||
| 
 | ||
| 
 | ||
| <span class="c1"># The interfaces section defines the physical and virtual</span>
 | ||
| <span class="c1"># interfaces Reticulum will use to communicate on. This</span>
 | ||
| <span class="c1"># section will contain examples for a variety of interface</span>
 | ||
| <span class="c1"># types. You can modify these or use them as a basis for</span>
 | ||
| <span class="c1"># your own config, or simply remove the unused ones.</span>
 | ||
| 
 | ||
| <span class="p">[</span><span class="n">interfaces</span><span class="p">]</span>
 | ||
| 
 | ||
|   <span class="c1"># This interface enables communication with other</span>
 | ||
|   <span class="c1"># link-local Reticulum nodes over UDP. It does not</span>
 | ||
|   <span class="c1"># need any functional IP infrastructure like routers</span>
 | ||
|   <span class="c1"># or DHCP servers, but will require that at least link-</span>
 | ||
|   <span class="c1"># local IPv6 is enabled in your operating system, which</span>
 | ||
|   <span class="c1"># should be enabled by default in almost any OS. See</span>
 | ||
|   <span class="c1"># the Reticulum Manual for more configuration options.</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="n">interface_enabled</span> <span class="o">=</span> <span class="kc">True</span>
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <p>If Reticulum infrastructure already exists locally, you probably don’t need to
 | ||
| change anything, and you may already be connected to a wider network. If not,
 | ||
| you will probably need to add relevant <em>interfaces</em> to the configuration, in
 | ||
| order to communicate with other systems. It is a good idea to read the comments
 | ||
| and explanations in the above default config. It will teach you the basic
 | ||
| concepts you need to understand to configure your network. Once you have done that,
 | ||
| take a look at the <a class="reference internal" href="interfaces.html#interfaces-main"><span class="std std-ref">Interfaces</span></a> chapter of this manual.</p>
 | ||
| </div>
 | ||
| <div class="section" id="included-utility-programs">
 | ||
| <h2>Included Utility Programs<a class="headerlink" href="#included-utility-programs" title="Permalink to this headline">¶</a></h2>
 | ||
| <p>Reticulum includes a range of useful utilities, both for managing your Reticulum
 | ||
| networks, and for carrying out common tasks over Reticulum networks, such as
 | ||
| transferring files to remote systems, and executing commands and programs remotely.</p>
 | ||
| <p>If you often use Reticulum from several different programs, or simply want
 | ||
| Reticulum to stay available all the time, for example if you are hosting
 | ||
| a transport node, you might want to run Reticulum as a separate service that
 | ||
| other programs, applications and services can utilise.</p>
 | ||
| <div class="section" id="the-rnsd-utility">
 | ||
| <h3>The rnsd Utility<a class="headerlink" href="#the-rnsd-utility" title="Permalink to this headline">¶</a></h3>
 | ||
| <p>It is very easy to run Reticulum as a service. Simply run the included <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> command.
 | ||
| When <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> is running, it will keep all configured interfaces open, handle transport if
 | ||
| it is enabled, and allow any other programs to immediately utilise the
 | ||
| Reticulum network it is configured for.</p>
 | ||
| <p>You can even run multiple instances of rnsd with different configurations on
 | ||
| the same system.</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span># Install Reticulum
 | ||
| pip3 install rns
 | ||
| 
 | ||
| # Run rnsd
 | ||
| rnsd
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage: rnsd [-h] [--config CONFIG] [-v] [-q] [--version]
 | ||
| 
 | ||
| Reticulum Network Stack Daemon
 | ||
| 
 | ||
| optional arguments:
 | ||
|   -h, --help       show this help message and exit
 | ||
|   --config CONFIG  path to alternative Reticulum config directory
 | ||
|   -v, --verbose
 | ||
|   -q, --quiet
 | ||
|   --version        show program's version number and exit
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <p>You can easily add <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> as an always-on service by <a class="reference internal" href="#using-systemd"><span class="std std-ref">configuring a service</span></a>.</p>
 | ||
| </div>
 | ||
| <div class="section" id="the-rnstatus-utility">
 | ||
| <h3>The rnstatus Utility<a class="headerlink" href="#the-rnstatus-utility" title="Permalink to this headline">¶</a></h3>
 | ||
| <p>Using the <code class="docutils literal notranslate"><span class="pre">rnstatus</span></code> utility, you can view the status of configured Reticulum
 | ||
| interfaces, similar to the <code class="docutils literal notranslate"><span class="pre">ifconfig</span></code> program.</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span># Run rnstatus
 | ||
| rnstatus
 | ||
| 
 | ||
| # Example output
 | ||
| Shared Instance[37428]
 | ||
|    Status  : Up
 | ||
|    Serving : 1 program
 | ||
|    Rate    : 1.00 Gbps
 | ||
|    Traffic : 83.13 KB↑
 | ||
|              86.10 KB↓
 | ||
| 
 | ||
| AutoInterface[Local]
 | ||
|    Status  : Up
 | ||
|    Mode    : Full
 | ||
|    Rate    : 10.00 Mbps
 | ||
|    Peers   : 1 reachable
 | ||
|    Traffic : 63.23 KB↑
 | ||
|              80.17 KB↓
 | ||
| 
 | ||
| TCPInterface[RNS Testnet Frankfurt/frankfurt.rns.unsigned.io:4965]
 | ||
|    Status  : Up
 | ||
|    Mode    : Full
 | ||
|    Rate    : 10.00 Mbps
 | ||
|    Traffic : 187.27 KB↑
 | ||
|              74.17 KB↓
 | ||
| 
 | ||
| RNodeInterface[RNode UHF]
 | ||
|    Status  : Up
 | ||
|    Mode    : Access Point
 | ||
|    Rate    : 1.30 kbps
 | ||
|    Access  : 64-bit IFAC by <…e702c42ba8>
 | ||
|    Traffic : 8.49 KB↑
 | ||
|              9.23 KB↓
 | ||
| 
 | ||
| Reticulum Transport Instance <5245a8efe1788c6a70e1> running
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage: rnstatus [-h] [--config CONFIG] [--version] [-a] [-v]
 | ||
| 
 | ||
| Reticulum Network Stack Status
 | ||
| 
 | ||
| optional arguments:
 | ||
|   -h, --help       show this help message and exit
 | ||
|   --config CONFIG  path to alternative Reticulum config directory
 | ||
|   --version        show program's version number and exit
 | ||
|   -a, --all        show all interfaces
 | ||
|   -v, --verbose
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| </div>
 | ||
| <div class="section" id="the-rnpath-utility">
 | ||
| <h3>The rnpath Utility<a class="headerlink" href="#the-rnpath-utility" title="Permalink to this headline">¶</a></h3>
 | ||
| <p>With the <code class="docutils literal notranslate"><span class="pre">rnpath</span></code> utility, you can look up and view paths for
 | ||
| destinations on the Reticulum network.</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span># Run rnpath
 | ||
| rnpath eca6f4e4dc26ae329e61
 | ||
| 
 | ||
| # Example output
 | ||
| Path found, destination <eca6f4e4dc26ae329e61> is 4 hops away via <56b115c30cd386cad69c> on TCPInterface[Testnet/frankfurt.rns.unsigned.io:4965]
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage: rnpath [-h] [--config CONFIG] [--version] [-t] [-r] [-d] [-D] [-w seconds] [-v] [destination]
 | ||
| 
 | ||
| Reticulum Path Discovery Utility
 | ||
| 
 | ||
| positional arguments:
 | ||
|   destination           hexadecimal hash of the destination
 | ||
| 
 | ||
| optional arguments:
 | ||
|   -h, --help            show this help message and exit
 | ||
|   --config CONFIG       path to alternative Reticulum config directory
 | ||
|   --version             show program's version number and exit
 | ||
|   -t, --table           show all known paths
 | ||
|   -r, --rates           show announce rate info
 | ||
|   -d, --drop            remove the path to a destination
 | ||
|   -D, --drop-announces  drop all queued announces
 | ||
|   -w seconds            timeout before giving up
 | ||
|   -v, --verbose
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| </div>
 | ||
| <div class="section" id="the-rnprobe-utility">
 | ||
| <h3>The rnprobe Utility<a class="headerlink" href="#the-rnprobe-utility" title="Permalink to this headline">¶</a></h3>
 | ||
| <p>The <code class="docutils literal notranslate"><span class="pre">rnprobe</span></code> utility lets you probe a destination for connectivity, similar
 | ||
| to the <code class="docutils literal notranslate"><span class="pre">ping</span></code> program. Please note that probes will only be answered if the
 | ||
| specified destination is configured to send proofs for received packets. Many
 | ||
| destinations will not have this option enabled, and will not be probable.</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span># Run rnprobe
 | ||
| rnprobe example_utilities.echo.request 9382f334de63217a4278
 | ||
| 
 | ||
| # Example output
 | ||
| Sent 16 byte probe to <9382f334de63217a4278>
 | ||
| Valid reply received from <9382f334de63217a4278>
 | ||
| Round-trip time is 38.469 milliseconds over 2 hops
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage: rnprobe [-h] [--config CONFIG] [--version] [-v] [full_name] [destination_hash]
 | ||
| 
 | ||
| Reticulum Probe Utility
 | ||
| 
 | ||
| positional arguments:
 | ||
|   full_name         full destination name in dotted notation
 | ||
|   destination_hash  hexadecimal hash of the destination
 | ||
| 
 | ||
| optional arguments:
 | ||
|   -h, --help        show this help message and exit
 | ||
|   --config CONFIG   path to alternative Reticulum config directory
 | ||
|   --version         show program's version number and exit
 | ||
|   -v, --verbose
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| </div>
 | ||
| <div class="section" id="the-rncp-utility">
 | ||
| <h3>The rncp Utility<a class="headerlink" href="#the-rncp-utility" title="Permalink to this headline">¶</a></h3>
 | ||
| <p>The <code class="docutils literal notranslate"><span class="pre">rncp</span></code> utility is a simple file transfer tool. Using it, you can transfer
 | ||
| files through Reticulum.</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span># Run rncp on the receiving system, specifying which identities
 | ||
| # are allowed to send files
 | ||
| rncp --receive -a 940ea3f9e1037d38758f -a e28d5aee4317c24a9041
 | ||
| 
 | ||
| # From another system, copy a file to the receiving system
 | ||
| rncp ~/path/to/file.tgz 256320d405d6d525d1e9
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <p>You can specify as many allowed senders as needed, or complete disable authentication.</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage: rncp [-h] [--config path] [-v] [-q] [-p] [-r] [-b] [-a allowed_hash] [-n] [-w seconds] [--version] [file] [destination]
 | ||
| 
 | ||
| Reticulum File Transfer Utility
 | ||
| 
 | ||
| positional arguments:
 | ||
|   file                  file to be transferred
 | ||
|   destination           hexadecimal hash of the receiver
 | ||
| 
 | ||
| optional arguments:
 | ||
|   -h, --help            show this help message and exit
 | ||
|   --config path         path to alternative Reticulum config directory
 | ||
|   -v, --verbose         increase verbosity
 | ||
|   -q, --quiet           decrease verbosity
 | ||
|   -p, --print-identity  print identity and destination info and exit
 | ||
|   -r, --receive         wait for incoming files
 | ||
|   -b, --no-announce     don't announce at program start
 | ||
|   -a allowed_hash       accept from this identity
 | ||
|   -n, --no-auth         accept files from anyone
 | ||
|   -w seconds            sender timeout before giving up
 | ||
|   --version             show program's version number and exit
 | ||
|   -v, --verbose
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| </div>
 | ||
| <div class="section" id="the-rnx-utility">
 | ||
| <h3>The rnx Utility<a class="headerlink" href="#the-rnx-utility" title="Permalink to this headline">¶</a></h3>
 | ||
| <p>The <code class="docutils literal notranslate"><span class="pre">rnx</span></code> utility is a basic remote command execution program. It allows you to
 | ||
| execute commands on remote systems over Reticulum, and to view returned command
 | ||
| output.</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span># Run rnx on the listening system, specifying which identities
 | ||
| # are allowed to execute commands
 | ||
| rncp --listen -a 8111c4ff2968ab0c1286 -a 590256654482b4ba4038
 | ||
| 
 | ||
| # From another system, run a command
 | ||
| rnx ad9a4c9da60089d41c29 "cat /proc/cpuinfo"
 | ||
| 
 | ||
| # Or enter the interactive mode pseudo-shell
 | ||
| rnx ad9a4c9da60089d41c29 -x
 | ||
| 
 | ||
| # The default identity file is stored in
 | ||
| # ~/.reticulum/identities/rnx, but you can use
 | ||
| # another one, which will be created if it does
 | ||
| # not already exist
 | ||
| rnx ad9a4c9da60089d41c29 -i /path/to/identity
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <p>You can specify as many allowed senders as needed, or complete disable authentication.</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage: rnx [-h] [--config path] [-v] [-q] [-p] [-l] [-i identity] [-x] [-b] [-a allowed_hash] [-n] [-N] [-d] [-m] [-w seconds] [-W seconds] [--stdin STDIN] [--stdout STDOUT] [--stderr STDERR] [--version]
 | ||
|            [destination] [command]
 | ||
| 
 | ||
| Reticulum Remote Execution Utility
 | ||
| 
 | ||
| positional arguments:
 | ||
|   destination           hexadecimal hash of the listener
 | ||
|   command               command to be execute
 | ||
| 
 | ||
| optional arguments:
 | ||
|   -h, --help            show this help message and exit
 | ||
|   --config path         path to alternative Reticulum config directory
 | ||
|   -v, --verbose         increase verbosity
 | ||
|   -q, --quiet           decrease verbosity
 | ||
|   -p, --print-identity  print identity and destination info and exit
 | ||
|   -l, --listen          listen for incoming commands
 | ||
|   -i identity           path to identity to use
 | ||
|   -x, --interactive     enter interactive mode
 | ||
|   -b, --no-announce     don't announce at program start
 | ||
|   -a allowed_hash       accept from this identity
 | ||
|   -n, --noauth          accept files from anyone
 | ||
|   -N, --noid            don't identify to listener
 | ||
|   -d, --detailed        show detailed result output
 | ||
|   -m                    mirror exit code of remote command
 | ||
|   -w seconds            connect and request timeout before giving up
 | ||
|   -W seconds            max result download time
 | ||
|   --stdin STDIN         pass input to stdin
 | ||
|   --stdout STDOUT       max size in bytes of returned stdout
 | ||
|   --stderr STDERR       max size in bytes of returned stderr
 | ||
|   --version             show program's version number and exit
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| </div>
 | ||
| </div>
 | ||
| <div class="section" id="improving-system-configuration">
 | ||
| <h2>Improving System Configuration<a class="headerlink" href="#improving-system-configuration" title="Permalink to this headline">¶</a></h2>
 | ||
| <p>If you are setting up a system for permanent use with Reticulum, there is a
 | ||
| few system configuration changes that can make this easier to administrate.
 | ||
| These changes will be detailed here.</p>
 | ||
| <div class="section" id="fixed-serial-port-names">
 | ||
| <h3>Fixed Serial Port Names<a class="headerlink" href="#fixed-serial-port-names" title="Permalink to this headline">¶</a></h3>
 | ||
| <p>On a Reticulum instance with several serial port based interfaces, it can be
 | ||
| beneficial to use the fixed device names for the serial ports, instead
 | ||
| of the dynamically allocated shorthands such as <code class="docutils literal notranslate"><span class="pre">/dev/ttyUSB0</span></code>. Under most
 | ||
| Debian-based distributions, including Ubuntu and Raspberry Pi OS, these nodes
 | ||
| can be found under <code class="docutils literal notranslate"><span class="pre">/dev/serial/by-id</span></code>.</p>
 | ||
| <p>You can use such a device path directly in place of the numbered shorthands.
 | ||
| Here is an example of a packet radio TNC configured as such:</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>[[Packet Radio KISS Interface]]
 | ||
|   type = KISSInterface
 | ||
|   interface_enabled = True
 | ||
|   outgoing = true
 | ||
|   port = /dev/serial/by-id/usb-FTDI_FT230X_Basic_UART_43891CKM-if00-port0
 | ||
|   speed = 115200
 | ||
|   databits = 8
 | ||
|   parity = none
 | ||
|   stopbits = 1
 | ||
|   preamble = 150
 | ||
|   txtail = 10
 | ||
|   persistence = 200
 | ||
|   slottime = 20
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <p>Using this methodology avoids potential naming mix-ups where physical devices
 | ||
| might be plugged and unplugged in different orders, or when device name
 | ||
| assignment varies from one boot to another.</p>
 | ||
| </div>
 | ||
| <div class="section" id="reticulum-as-a-system-service">
 | ||
| <span id="using-systemd"></span><h3>Reticulum as a System Service<a class="headerlink" href="#reticulum-as-a-system-service" title="Permalink to this headline">¶</a></h3>
 | ||
| <p>Instead of starting Reticulum manually, you can install <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> as a system
 | ||
| service and have it start automatically at boot.</p>
 | ||
| <p>If you installed Reticulum with <code class="docutils literal notranslate"><span class="pre">pip</span></code>, the <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> program will most likely
 | ||
| be located in a user-local installation path only, which means <code class="docutils literal notranslate"><span class="pre">systemd</span></code> will not
 | ||
| be able to execute it. In this case, you can simply symlink the <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> program
 | ||
| into a directory that is in systemd’s path:</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>sudo ln -s $(which rnsd) /usr/local/bin/
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <p>You can then create the service file <code class="docutils literal notranslate"><span class="pre">/etc/systemd/system/rnsd.service</span></code> with the
 | ||
| following content:</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>[Unit]
 | ||
| Description=Reticulum Network Stack Daemon
 | ||
| After=multi-user.target
 | ||
| 
 | ||
| [Service]
 | ||
| # If you run Reticulum on WiFi devices,
 | ||
| # or other devices that need some extra
 | ||
| # time to initialise, you might want to
 | ||
| # add a short delay before Reticulum is
 | ||
| # started by systemd:
 | ||
| # ExecStartPre=/bin/sleep 10
 | ||
| Type=simple
 | ||
| Restart=always
 | ||
| RestartSec=3
 | ||
| User=USERNAMEHERE
 | ||
| ExecStart=rnsd --service
 | ||
| 
 | ||
| [Install]
 | ||
| WantedBy=multi-user.target
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <p>Be sure to replace <code class="docutils literal notranslate"><span class="pre">USERNAMEHERE</span></code> with the user you want to run <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> as.</p>
 | ||
| <p>To manually start <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> run:</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>sudo systemctl start rnsd
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| <p>If you want to automatically start <code class="docutils literal notranslate"><span class="pre">rnsd</span></code> at boot, run:</p>
 | ||
| <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>sudo systemctl enable rnsd
 | ||
| </pre></div>
 | ||
| </div>
 | ||
| </div>
 | ||
| </div>
 | ||
| </div>
 | ||
| 
 | ||
| 
 | ||
|             <div class="clearer"></div>
 | ||
|           </div>
 | ||
|         </div>
 | ||
|       </div>
 | ||
|       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 | ||
|         <div class="sphinxsidebarwrapper">
 | ||
|   <h3><a href="index.html">Table of Contents</a></h3>
 | ||
|   <ul>
 | ||
| <li><a class="reference internal" href="#">Using Reticulum on Your System</a><ul>
 | ||
| <li><a class="reference internal" href="#configuration-data">Configuration & Data</a></li>
 | ||
| <li><a class="reference internal" href="#included-utility-programs">Included Utility Programs</a><ul>
 | ||
| <li><a class="reference internal" href="#the-rnsd-utility">The rnsd Utility</a></li>
 | ||
| <li><a class="reference internal" href="#the-rnstatus-utility">The rnstatus Utility</a></li>
 | ||
| <li><a class="reference internal" href="#the-rnpath-utility">The rnpath Utility</a></li>
 | ||
| <li><a class="reference internal" href="#the-rnprobe-utility">The rnprobe Utility</a></li>
 | ||
| <li><a class="reference internal" href="#the-rncp-utility">The rncp Utility</a></li>
 | ||
| <li><a class="reference internal" href="#the-rnx-utility">The rnx Utility</a></li>
 | ||
| </ul>
 | ||
| </li>
 | ||
| <li><a class="reference internal" href="#improving-system-configuration">Improving System Configuration</a><ul>
 | ||
| <li><a class="reference internal" href="#fixed-serial-port-names">Fixed Serial Port Names</a></li>
 | ||
| <li><a class="reference internal" href="#reticulum-as-a-system-service">Reticulum as a System Service</a></li>
 | ||
| </ul>
 | ||
| </li>
 | ||
| </ul>
 | ||
| </li>
 | ||
| </ul>
 | ||
| 
 | ||
|   <h4>Previous topic</h4>
 | ||
|   <p class="topless"><a href="gettingstartedfast.html"
 | ||
|                         title="previous chapter">Getting Started Fast</a></p>
 | ||
|   <h4>Next topic</h4>
 | ||
|   <p class="topless"><a href="networks.html"
 | ||
|                         title="next chapter">Building Networks</a></p>
 | ||
|   <div role="note" aria-label="source link">
 | ||
|     <h3>This Page</h3>
 | ||
|     <ul class="this-page-menu">
 | ||
|       <li><a href="_sources/using.rst.txt"
 | ||
|             rel="nofollow">Show Source</a></li>
 | ||
|     </ul>
 | ||
|    </div>
 | ||
| <div id="searchbox" style="display: none" role="search">
 | ||
|   <h3 id="searchlabel">Quick search</h3>
 | ||
|     <div class="searchformwrapper">
 | ||
|     <form class="search" action="search.html" method="get">
 | ||
|       <input type="text" name="q" aria-labelledby="searchlabel" />
 | ||
|       <input type="submit" value="Go" />
 | ||
|     </form>
 | ||
|     </div>
 | ||
| </div>
 | ||
| <script>$('#searchbox').show(0);</script>
 | ||
|         </div>
 | ||
|       </div>
 | ||
|       <div class="clearer"></div>
 | ||
|     </div>
 | ||
|     <div class="related" role="navigation" aria-label="related navigation">
 | ||
|       <h3>Navigation</h3>
 | ||
|       <ul>
 | ||
|         <li class="right" style="margin-right: 10px">
 | ||
|           <a href="genindex.html" title="General Index"
 | ||
|              >index</a></li>
 | ||
|         <li class="right" >
 | ||
|           <a href="networks.html" title="Building Networks"
 | ||
|              >next</a> |</li>
 | ||
|         <li class="right" >
 | ||
|           <a href="gettingstartedfast.html" title="Getting Started Fast"
 | ||
|              >previous</a> |</li>
 | ||
|         <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.8 beta documentation</a> »</li>
 | ||
|         <li class="nav-item nav-item-this"><a href="">Using Reticulum on Your System</a></li> 
 | ||
|       </ul>
 | ||
|     </div>
 | ||
|     <div class="footer" role="contentinfo">
 | ||
|         © Copyright 2022, Mark Qvist.
 | ||
|       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.0.1.
 | ||
|     </div>
 | ||
|   </body>
 | ||
| </html> |