2021-05-16 17:40:49 -04:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2021-10-08 12:30:17 -04:00
< title > Getting Started Fast — Reticulum Network Stack 0.2.7 beta documentation< / title >
2021-05-16 17:40:49 -04:00
< 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" / >
2021-09-25 17:22:33 -04:00
< link rel = "next" title = "Using Reticulum on Your System" href = "using.html" / >
2021-05-16 17:40:49 -04:00
< link rel = "prev" title = "What is Reticulum?" href = "whatis.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" >
2021-09-25 17:22:33 -04:00
< a href = "using.html" title = "Using Reticulum on Your System"
2021-05-16 17:40:49 -04:00
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "whatis.html" title = "What is Reticulum?"
accesskey="P">previous< / a > |< / li >
2021-10-08 12:30:17 -04:00
< li class = "nav-item nav-item-0" > < a href = "index.html" > Reticulum Network Stack 0.2.7 beta documentation< / a > » < / li >
2021-05-16 17:40:49 -04:00
< li class = "nav-item nav-item-this" > < a href = "" > Getting Started Fast< / a > < / li >
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< div class = "section" id = "getting-started-fast" >
< h1 > Getting Started Fast< a class = "headerlink" href = "#getting-started-fast" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > The best way to get started with the Reticulum Network Stack depends on what
you want to do. This guide will outline sensible starting paths for different
scenarios.< / p >
< div class = "section" id = "try-using-a-reticulum-based-program" >
< h2 > Try Using a Reticulum-based Program< a class = "headerlink" href = "#try-using-a-reticulum-based-program" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > If you simply want to try using a program built with Reticulum, you can take
a look at < a class = "reference external" href = "https://github.com/markqvist/nomadnet" > Nomad Network< / a > , which
2021-10-08 12:30:17 -04:00
provides a complete encrypted communications suite built with Reticulum.< / p >
2021-09-18 10:29:47 -04:00
< a class = "reference external image-reference" href = "_images/nomadnet_3.png" > < img alt = "_images/nomadnet_3.png" src = "_images/nomadnet_3.png" / > < / a >
2021-05-17 14:01:53 -04:00
< p > < a class = "reference external" href = "https://github.com/markqvist/nomadnet" > Nomad Network< / a > is a user-facing client
in the development for the messaging and information-sharing protocol
< a class = "reference external" href = "https://github.com/markqvist/lxmf" > LXMF< / a > , another project built with Reticulum.< / p >
2021-09-18 10:29:47 -04:00
< p > You can install Nomad Network via pip:< / p >
2021-09-25 15:39:31 -04:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # Install ...< / span >
2021-09-18 10:29:47 -04:00
< span class = "n" > pip3< / span > < span class = "n" > install< / span > < span class = "n" > nomadnet< / span >
2021-09-25 15:39:31 -04:00
< span class = "c1" > # ... and run< / span >
2021-09-18 10:29:47 -04:00
< span class = "n" > nomadnet< / span >
< / pre > < / div >
< / div >
2021-05-16 17:40:49 -04:00
< / div >
2021-10-08 12:30:17 -04:00
< div class = "section" id = "using-the-included-utilities" >
< h2 > Using the Included Utilities< a class = "headerlink" href = "#using-the-included-utilities" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Reticulum comes with a range of included utilities that make it easier to
manage your network, check connectivity and make Reticulum available to other
programs on your system.< / p >
< p > You can use < code class = "docutils literal notranslate" > < span class = "pre" > rnsd< / span > < / code > to run Reticulum as a background or foreground service,
and the < code class = "docutils literal notranslate" > < span class = "pre" > rnstatus< / span > < / code > , < code class = "docutils literal notranslate" > < span class = "pre" > rnpath< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > rnprobe< / span > < / code > utilities to view and query
network status and connectivity.< / p >
< p > To learn more about these utility programs, have a look at the
< a class = "reference internal" href = "using.html#using-main" > < span class = "std std-ref" > Using Reticulum on Your System< / span > < / a > chapter of this manual.< / p >
< / div >
2021-09-25 15:39:31 -04:00
< div class = "section" id = "creating-a-network-with-reticulum" >
< h2 > Creating a Network With Reticulum< a class = "headerlink" href = "#creating-a-network-with-reticulum" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > To create a network, you will need to specify one or more < em > interfaces< / em > for
Reticulum to use. This is done in the Reticulum configuration file, which by
default is located at < code class = "docutils literal notranslate" > < span class = "pre" > ~/.reticulum/config< / span > < / code > .< / p >
< p > When Reticulum is started for the first time, it will create a default
configuration file, with one active interface. This default interface uses
your existing ethernet network (if there is one), and only allows you to
communicate with other Reticulum peers within your local broadcast domain.< / p >
< p > To communicate further, you will have to add one or more interfaces. The default
configuration includes a number of examples, ranging from using TCP over the
internet, to LoRa and Packet Radio interfaces.< / p >
2021-09-25 17:22:33 -04:00
< p > Possibly, the examples in the config file are enough to get you started. If
you want more information, you can read the < a class = "reference internal" href = "networks.html#networks-main" > < span class = "std std-ref" > Building Networks< / span > < / a >
and < a class = "reference internal" href = "interfaces.html#interfaces-main" > < span class = "std std-ref" > Interfaces< / span > < / a > chapters of this manual.< / p >
2021-09-25 15:39:31 -04:00
< / div >
2021-05-16 17:40:49 -04:00
< div class = "section" id = "develop-a-program-with-reticulum" >
< h2 > Develop a Program with Reticulum< a class = "headerlink" href = "#develop-a-program-with-reticulum" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > If you want to develop programs that use Reticulum, the easiest way to get
2021-05-20 10:06:12 -04:00
started is to install the latest release of Reticulum via pip:< / p >
2021-05-16 17:40:49 -04:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > pip3< / span > < span class = "n" > install< / span > < span class = "n" > rns< / span >
< / pre > < / div >
< / div >
< p > The above command will install Reticulum and dependencies, and you will be
ready to import and use RNS in your own programs. The next step will most
likely be to look at some < a class = "reference internal" href = "examples.html#examples-main" > < span class = "std std-ref" > Example Programs< / span > < / a > .< / p >
< p > Further information can be found in the < a class = "reference internal" href = "reference.html#api-main" > < span class = "std std-ref" > API Reference< / span > < / a > .< / p >
< / div >
< div class = "section" id = "participate-in-reticulum-development" >
< h2 > Participate in Reticulum Development< a class = "headerlink" href = "#participate-in-reticulum-development" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > If you want to participate in the development of Reticulum and associated
utilities, you’
don’ < / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # Install dependencies< / span >
2021-09-25 15:39:31 -04:00
< span class = "n" > pip3< / span > < span class = "n" > install< / span > < span class = "n" > cryptography< / span > < span class = "n" > pyserial< / span > < span class = "n" > netifaces< / span >
2021-05-16 17:40:49 -04:00
< span class = "c1" > # Clone repository< / span >
< span class = "n" > git< / span > < span class = "n" > clone< / span > < span class = "n" > https< / span > < span class = "p" > :< / span > < span class = "o" > //< / span > < span class = "n" > github< / span > < span class = "o" > .< / span > < span class = "n" > com< / span > < span class = "o" > /< / span > < span class = "n" > markqvist< / span > < span class = "o" > /< / span > < span class = "n" > Reticulum< / span > < span class = "o" > .< / span > < span class = "n" > git< / span >
< span class = "c1" > # Move into Reticulum folder and symlink library to examples folder< / span >
< span class = "n" > cd< / span > < span class = "n" > Reticulum< / span >
< span class = "n" > ln< / span > < span class = "o" > -< / span > < span class = "n" > s< / span > < span class = "o" > ../< / span > < span class = "n" > RNS< / span > < span class = "o" > ./< / span > < span class = "n" > Examples< / span > < span class = "o" > /< / span >
< span class = "c1" > # Run an example< / span >
< span class = "n" > python3< / span > < span class = "n" > Examples< / span > < span class = "o" > /< / span > < span class = "n" > Echo< / span > < span class = "o" > .< / span > < span class = "n" > py< / span > < span class = "o" > -< / span > < span class = "n" > s< / span >
< span class = "c1" > # Unless you' ve manually created a config file, Reticulum will do so now,< / span >
< span class = "c1" > # and immediately exit. Make any necessary changes to the file:< / span >
< span class = "n" > nano< / span > < span class = "o" > ~/.< / span > < span class = "n" > reticulum< / span > < span class = "o" > /< / span > < span class = "n" > config< / span >
< span class = "c1" > # ... and launch the example again.< / span >
< span class = "n" > python3< / span > < span class = "n" > Examples< / span > < span class = "o" > /< / span > < span class = "n" > Echo< / span > < span class = "o" > .< / span > < span class = "n" > py< / span > < span class = "o" > -< / span > < span class = "n" > s< / span >
< span class = "c1" > # You can now repeat the process on another computer,< / span >
< span class = "c1" > # and run the same example with -h to get command line options.< / span >
< span class = "n" > python3< / span > < span class = "n" > Examples< / span > < span class = "o" > /< / span > < span class = "n" > Echo< / span > < span class = "o" > .< / span > < span class = "n" > py< / span > < span class = "o" > -< / span > < span class = "n" > h< / span >
< span class = "c1" > # Run the example in client mode to " ping" the server.< / span >
< span class = "c1" > # Replace the hash below with the actual destination hash of your server.< / span >
< span class = "n" > python3< / span > < span class = "n" > Examples< / span > < span class = "o" > /< / span > < span class = "n" > Echo< / span > < span class = "o" > .< / span > < span class = "n" > py< / span > < span class = "mf" > 3e12< / span > < span class = "n" > fc71692f8ec47bc5< / span >
< span class = "c1" > # Have a look at another example< / span >
< span class = "n" > python3< / span > < span class = "n" > Examples< / span > < span class = "o" > /< / span > < span class = "n" > Filetransfer< / span > < span class = "o" > .< / span > < span class = "n" > py< / span > < span class = "o" > -< / span > < span class = "n" > h< / span >
< / pre > < / div >
< / div >
< p > When you have experimented with the basic examples, it’
< a class = "reference internal" href = "understanding.html#understanding-main" > < span class = "std std-ref" > Understanding Reticulum< / span > < / a > chapter.< / p >
< / 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 = "#" > Getting Started Fast< / a > < ul >
< li > < a class = "reference internal" href = "#try-using-a-reticulum-based-program" > Try Using a Reticulum-based Program< / a > < / li >
2021-10-08 12:30:17 -04:00
< li > < a class = "reference internal" href = "#using-the-included-utilities" > Using the Included Utilities< / a > < / li >
2021-09-25 15:39:31 -04:00
< li > < a class = "reference internal" href = "#creating-a-network-with-reticulum" > Creating a Network With Reticulum< / a > < / li >
2021-05-16 17:40:49 -04:00
< li > < a class = "reference internal" href = "#develop-a-program-with-reticulum" > Develop a Program with Reticulum< / a > < / li >
< li > < a class = "reference internal" href = "#participate-in-reticulum-development" > Participate in Reticulum Development< / a > < / li >
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "whatis.html"
title="previous chapter">What is Reticulum?< / a > < / p >
< h4 > Next topic< / h4 >
2021-09-25 17:22:33 -04:00
< p class = "topless" > < a href = "using.html"
title="next chapter">Using Reticulum on Your System< / a > < / p >
2021-05-16 17:40:49 -04:00
< div role = "note" aria-label = "source link" >
< h3 > This Page< / h3 >
< ul class = "this-page-menu" >
< li > < a href = "_sources/gettingstartedfast.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" >
2021-09-25 17:22:33 -04:00
< a href = "using.html" title = "Using Reticulum on Your System"
2021-05-16 17:40:49 -04:00
>next< / a > |< / li >
< li class = "right" >
< a href = "whatis.html" title = "What is Reticulum?"
>previous< / a > |< / li >
2021-10-08 12:30:17 -04:00
< li class = "nav-item nav-item-0" > < a href = "index.html" > Reticulum Network Stack 0.2.7 beta documentation< / a > » < / li >
2021-05-16 17:40:49 -04:00
< li class = "nav-item nav-item-this" > < a href = "" > Getting Started Fast< / a > < / li >
< / ul >
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2021, Mark Qvist.
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 4.0.1.
< / div >
< / body >
< / html >
