What is Reticulum?#

-

Reticulum is a cryptography-based networking stack for building wide-area -networks with readily available hardware, that can continue to operate even -with extremely low bandwidth and very high latency.

+

Reticulum is a cryptography-based networking stack for building both local and +wide-area networks with readily available hardware, that can continue to operate +under adverse conditions, such as extremely low bandwidth and very high latency.

Reticulum allows you to build 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.

+offers end-to-end encryption, forward secrecy, autoconfiguring cryptographically +backed multi-hop transport, efficient addressing, unforgeable packet +acknowledgements and more.

+

From a users perspective, Reticulum allows the creation of applications that +respect and empower the autonomy and sovereignity of communities and individuals. +Reticulum enables secure digital communication that cannot be subjected to +outside control, manipulation or censorship.

+

Reticulum enables the construction of planetary-scale networks, without the need for +hierarchichal or beaureucratical structures to control or manage them, while still +allowing individuals and communities full sovereignity over their own network segments.

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 @@ -241,9 +248,9 @@ 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#

-

Reticulum should currently be considered beta software. All core protocol +

Please know! Reticulum should currently be considered beta software. All core protocol features are implemented and functioning, but additions will probably occur as -real-world use is explored. There will be bugs. The API and wire-format can be +real-world use is explored. There will be bugs. The API and wire-format can be considered stable at the moment, but could change if absolutely warranted.

diff --git a/docs/source/gettingstartedfast.rst b/docs/source/gettingstartedfast.rst index b13e02b..e2f0318 100644 --- a/docs/source/gettingstartedfast.rst +++ b/docs/source/gettingstartedfast.rst @@ -278,7 +278,10 @@ don't use pip, but try this recipe: python3 Examples/Filetransfer.py -h When you have experimented with the basic examples, it's time to go read the -:ref:`Understanding Reticulum` chapter. +:ref:`Understanding Reticulum` chapter. Before submitting +your first pull request, it is probably a good idea to introduce yourself on +the `disucssion forum on GitHub `_, +or ask one of the developers or maintainers for a good place to start. Reticulum on ARM64 @@ -343,7 +346,7 @@ From within Termux, execute the following: It is also possible to include Reticulum in apps compiled and distributed as Android APKs. A detailed tutorial and example source code will be included -here at a later point. +here at a later point. Until then you can use the `Sideband source code `_ as an example and startig point. Pure-Python Reticulum ============================================== diff --git a/docs/source/whatis.rst b/docs/source/whatis.rst index c319866..d08c546 100644 --- a/docs/source/whatis.rst +++ b/docs/source/whatis.rst @@ -2,14 +2,23 @@ What is Reticulum? ****************** -Reticulum is a cryptography-based networking stack for building wide-area -networks with readily available hardware, that can continue to operate even -with extremely low bandwidth and very high latency. +Reticulum is a cryptography-based networking stack for building both local and +wide-area networks with readily available hardware, that can continue to operate +under adverse conditions, such as extremely low bandwidth and very high latency. Reticulum allows you to build 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. +offers end-to-end encryption, forward secrecy, autoconfiguring cryptographically +backed multi-hop transport, efficient addressing, unforgeable packet +acknowledgements and more. + +From a users perspective, Reticulum allows the creation of applications that +respect and empower the autonomy and sovereignity of communities and individuals. +Reticulum enables secure digital communication that cannot be subjected to +outside control, manipulation or censorship. + +Reticulum enables the construction of planetary-scale networks, without the need for +hierarchichal or beaureucratical structures to control or manage them, while still +allowing individuals and communities full sovereignity over their own network segments. 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 @@ -25,9 +34,9 @@ runs well even on small single-board computers like the Pi Zero. Current Status ============== -Reticulum should currently be considered beta software. All core protocol +**Please know!** Reticulum should currently be considered beta software. All core protocol features are implemented and functioning, but additions will probably occur as -real-world use is explored. There will be bugs. The API and wire-format can be +real-world use is explored. *There will be bugs*. The API and wire-format can be considered stable at the moment, but could change if absolutely warranted.