mirror of
https://github.com/markqvist/Reticulum.git
synced 2025-05-02 06:36:14 -04:00
Updated documentation
This commit is contained in:
parent
77fe621cba
commit
c14f6aa14a
19 changed files with 153 additions and 50 deletions
|
@ -22,7 +22,7 @@ copyright = '2021, Mark Qvist'
|
|||
author = 'Mark Qvist'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '0.2.5 beta'
|
||||
release = '0.2.6 beta'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
|
|
@ -23,14 +23,35 @@ You can install Nomad Network via pip:
|
|||
|
||||
.. code::
|
||||
|
||||
# Install
|
||||
# Install ...
|
||||
pip3 install nomadnet
|
||||
|
||||
# And run
|
||||
# ... and run
|
||||
nomadnet
|
||||
|
||||
|
||||
|
||||
Creating a Network With Reticulum
|
||||
=============================================
|
||||
|
||||
To create a network, you will need to specify one or more *interfaces* for
|
||||
Reticulum to use. This is done in the Reticulum configuration file, which by
|
||||
default is located at ``~/.reticulum/config``.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
Possibly, the examples in the config file are enough to gen you started. If
|
||||
you want more information, you can read the :ref:`Interfaces<interfaces-main>`
|
||||
chapter of this manual.
|
||||
|
||||
|
||||
Develop a Program with Reticulum
|
||||
===========================================
|
||||
If you want to develop programs that use Reticulum, the easiest way to get
|
||||
|
@ -56,7 +77,7 @@ don't use pip, but try this recipe:
|
|||
.. code::
|
||||
|
||||
# Install dependencies
|
||||
pip3 install cryptography pyserial
|
||||
pip3 install cryptography pyserial netifaces
|
||||
|
||||
# Clone repository
|
||||
git clone https://github.com/markqvist/Reticulum.git
|
||||
|
|
|
@ -10,6 +10,7 @@ the development of Reticulum itself.
|
|||
|
||||
whatis
|
||||
gettingstartedfast
|
||||
networks
|
||||
understanding
|
||||
reference
|
||||
examples
|
||||
|
|
|
@ -6,9 +6,9 @@ Reticulum is a cryptography-based networking stack for wide-area networks built
|
|||
|
||||
Reticulum allows you to build very wide-area networks with off-the-shelf tools, and offers end-to-end encryption, autoconfiguring cryptographically backed multi-hop transport, efficient addressing, unforgeable packet acknowledgements and more.
|
||||
|
||||
Reticulum is a complete networking stack, and does not use IP or higher layers, although it is easy to utilise IP (with TCP or UDP) as the underlying carrier for Reticulum. It is therefore trivial to tunnel Reticulum over the Internet or private IP networks. Reticulum is built directly on cryptographic principles, allowing resilience and stable functionality in open and trustless networks.
|
||||
Reticulum is a complete networking stack, and does not need IP or higher layers, although it is easy to utilise IP (with TCP or UDP) as the underlying carrier for Reticulum. It is therefore trivial to tunnel Reticulum over the Internet or private IP networks. Reticulum is built directly on cryptographic principles, allowing resilience and stable functionality in open and trustless networks.
|
||||
|
||||
No kernel modules or drivers are required. Reticulum runs completely in userland, and can run on practically any system that runs Python 3.
|
||||
No kernel modules or drivers are required. Reticulum runs completely in userland, and can run on practically any system that runs Python 3. Reticulum runs well even on small single-board computers like the Pi Zero.
|
||||
|
||||
|
||||
Current Status
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue