NomadNet/README.md

48 lines
2.7 KiB
Markdown
Raw Normal View History

2021-03-27 05:58:13 -04:00
Nomad Network
==========
2021-05-04 14:57:57 -04:00
Communicate Freely.
2021-03-27 05:58:13 -04:00
2021-05-17 13:49:12 -04:00
![Screenshot](https://github.com/markqvist/NomadNet/raw/master/docs/screenshots/3.png)
2021-07-06 11:37:48 -04:00
The intention with this program is to provide a tool to that allows you to build private and resilient communications platforms that are in complete control and ownership of the people that use them.
Nomad Network is build on [LXMF](https://github.com/markqvist/LXMF) and [Reticulum](https://github.com/markqvist/Reticulum), which together provides the cryptographic mesh functionality and peer-to-peer message routing that Nomad Network relies on. This foundation also makes it possible to use the program over a very wide variety of communication mediums, from packet radio to gigabit fiber.
Nomad Network does not need any connections to the public internet to work. In fact, it doesn't even need an IP or Ethernet network. You can use it entirely over packet radio, LoRa or even serial lines. But if you wish, you can bridge islanded Reticulum networks over the Internet or private ethernet networks, or you can build networks running completely over the Internet. The choice is yours.
2021-03-27 05:58:13 -04:00
## Notable Features
2021-05-17 13:58:17 -04:00
- Encrypted messaging over packet-radio, LoRa, WiFi or anything else [Reticulum](https://github.com/markqvist/Reticulum) supports.
- Zero-configuration, minimal-infrastructure mesh communication
## Current Status
2021-07-06 11:37:48 -04:00
The current version of the program should be considered an alpha release. The program works well, but there will most probably be bugs and possibly sub-optimal performance in some scenarios. On the other hand, this is the ideal time to have an influence on the direction of the development of Nomad Network. To do so, join the discussion, report bugs and request features here on the GitHub project.
Development is ongoing and current features being implemented are:
2021-05-17 13:58:17 -04:00
- Propagated messaging and discussion threads
- Connectable nodes that can host pages, files and other resources
- Collaborative information sharing and spatial map-style "wikis"
2021-03-27 05:58:13 -04:00
## Dependencies:
- Python 3
- RNS
- LXMF
## How do I get started?
The easiest way to install Nomad Network is via pip:
```bash
# Install Nomad Network and dependencies
pip3 install nomadnet
# Run the client
nomadnet
```
2021-05-17 13:58:17 -04:00
To use Nomad Network on packet radio or LoRa, you will need to configure your Reticulum installation to use any relevant packet radio TNCs or LoRa devices on your system. See the Reticulum documentation for info.
2021-03-27 05:58:13 -04:00
## Caveat Emptor
Nomad Network is experimental software, and should be considered as such. While it has been built with cryptography best-practices very foremost in mind, it _has not_ been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.