NomadNet/README.md

109 lines
6.5 KiB
Markdown
Raw Normal View History

2021-09-18 09:14:54 -04:00
Nomad Network - Communicate Freely
2021-03-27 05:58:13 -04:00
==========
2021-10-08 12:41:20 -04:00
Off-grid, resilient mesh communication with strong encryption, forward secrecy and extreme privacy.
2021-07-13 16:44:10 -04:00
![Screenshot](https://github.com/markqvist/NomadNet/raw/master/docs/screenshots/1.png)
2021-05-17 13:49:12 -04:00
2021-10-08 12:41:20 -04:00
Nomad Network Allows you to build private and resilient communications platforms that are in complete control and ownership of the people that use them. No signups, no agreements, no handover of any data, no permissions and gatekeepers.
2021-07-06 11:37:48 -04:00
2021-10-08 12:41:20 -04:00
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 fiber optics.
2021-07-06 11:37:48 -04:00
2021-10-08 12:41:20 -04:00
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 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
2021-10-08 12:41:20 -04:00
- Distributed and encrypted message store holds messages for offline users
2021-09-11 05:11:23 -04:00
- Connectable nodes that can host pages and files
- Node-side generated pages with PHP, Python, bash or others
2021-09-11 05:11:23 -04:00
- Built-in text-based browser for interacting with contents on nodes
- An easy to use and bandwidth efficient markup language for writing pages
- Page caching in browser
2021-05-17 13:58:17 -04:00
## Current Status
2021-09-11 05:11:23 -04:00
The current version of the program should be considered a beta 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.
2021-05-17 13:58:17 -04:00
2021-09-11 05:11:23 -04:00
### Feature roadmap
2021-10-08 12:41:20 -04:00
- Network-wide propagated bulletins and discussion threads
2022-05-17 16:34:35 -04:00
- Collaborative maps and geospatial information sharing
2021-12-11 14:52:32 -05:00
- Facilitation of trade and barter
2021-03-27 05:58:13 -04:00
## 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
2022-05-17 07:18:55 -04:00
# Or alternatively run as a daemon, with no user interface
nomadnet --daemon
# List options
nomadnet --help
2021-03-27 05:58:13 -04:00
```
The first time the program is running, you will be presented with the guide section, which contains all the information you need to start using Nomad Network.
2022-04-01 11:39:56 -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](https://markqvist.github.io/Reticulum/manual/interfaces.html) for info. For a general introduction on how to set up such a system, take a look at [this post](https://unsigned.io/private-messaging-over-lora/).
2022-04-01 11:42:31 -04:00
If you want to try Nomad Network without building your own physical network, you can connect to the [Unsigned.io RNS Testnet](https://github.com/markqvist/Reticulum#public-testnet) over the Internet, where there is already some Nomad Network and LXMF activity.
2021-05-17 13:58:17 -04:00
2022-02-01 17:01:22 -05:00
**Please Note**: If this is the very first time you use pip to install a program on your system, you might need to reboot your system for the program to become available. If you get a "command not found" error or similar when running the program, reboot your system and try again.
2022-05-17 07:18:55 -04:00
### Install on Android
2022-02-01 17:01:22 -05:00
You can install Nomad Network on Android using Termux, but there's a few more commands involved than the above one-liner. The process is documented in the [Android Installation](https://markqvist.github.io/Reticulum/manual/gettingstartedfast.html#reticulum-on-android) section of the Reticulum Manual. Once the Reticulum has been installed according to the linked documentation, Nomad Network can be installed as usual with pip.
2021-12-11 14:48:41 -05:00
2022-03-28 16:56:20 -04:00
For a native Android application with a graphical user interface, have a look at [Sideband](https://unsigned.io/sideband).
2022-05-17 07:19:35 -04:00
### Nomad Network Daemon with Docker
Automated docker build for nomadnet daemon Uses a Github Action (`.github/workflows/publish-container.yml`) to create a docker container image (from `Dockerfile`) that represents an extremely minimal python installation with a virtualenv holding all requirements necessary to execute `nomadnet`. New docker images are created on pushes to `master` or pushes to tags matching `*.*.*` (ie. version tags) and are retrievable with those tags. Examples: ```sh $ docker pull ghcr.io/markqvist/nomadnet:master # Print docker labels, to demonstrate the image has been retrieved $ docker inspect -f '{{json .Config.Labels}}' ghcr.io/markqvist/nomadnet:master | jq { "org.opencontainers.image.created": "2022-04-27T06:01:55.894Z", "org.opencontainers.image.description": "Communicate Freely", "org.opencontainers.image.licenses": "GPL-3.0", "org.opencontainers.image.revision": "59cffc4a9de0f276d2cc87537ff1316aed5f16dd", "org.opencontainers.image.source": "https://github.com/markqvist/NomadNet", "org.opencontainers.image.title": "NomadNet", "org.opencontainers.image.url": "https://github.com/markqvist/NomadNet", "org.opencontainers.image.version": "master" } # Run nomadnet interactively without installing it (with default config) $ docker run -it ghcr.io/markqvist/nomadnet:master # Run nomadnet as a daemon, using config stored on the host machine in specific directories $ docker run -d -v /local/path/nomadnetconfig/:/root/.nomadnetwork/ -v /local/path/reticulumconfig/:/root/.reticulum/:rw ghcr.io/markqvist/nomadnet:master ``` # Please enter the commit message for your changes. Lines starting # with '#' will be kept; you may remove them yourself if you want to. # An empty message aborts the commit. # # Date: Tue Apr 26 23:50:22 2022 +0100 # # On branch dockerfile # Changes to be committed: # new file: .dockerignore # new file: .github/workflows/publish-container.yml # new file: Dockerfile # modified: README.md # # Please enter the commit message for your changes. Lines starting # with '#' will be kept; you may remove them yourself if you want to. # An empty message aborts the commit. # # Date: Tue Apr 26 23:50:22 2022 +0100 # # On branch dockerfile # Changes to be committed: # new file: .dockerignore # new file: .github/workflows/publish-container.yml # new file: Dockerfile # modified: README.md # # Please enter the commit message for your changes. Lines starting # with '#' will be kept; you may remove them yourself if you want to. # An empty message aborts the commit. # # Date: Tue Apr 26 23:50:22 2022 +0100 # # On branch dockerfile # Changes to be committed: # new file: .dockerignore # new file: .github/workflows/publish-container.yml # new file: Dockerfile # modified: README.md #
2022-04-26 18:50:22 -04:00
Nomad Network is automatically published as a docker image on Github Packages. Image tags are one of either `master` (for the latest release) or the version number (eg `0.1.7`) for the specified version number (as tagged in this git repo).
```sh
$ docker pull ghcr.io/markqvist/nomadnet:master
# Run nomadnet interactively without installing it (with default config)
$ docker run -it ghcr.io/markqvist/nomadnet:master
# Run nomadnet as a daemon, using config stored on the host machine in specific
# directories, and allowing access to specific numbered ports openned by nomadnet
# on the host machine on the same port numbers.
$ docker run -d \
-v /local/path/nomadnetconfig/:/root/.nomadnetwork/ \
-v /local/path/reticulumconfig/:/root/.reticulum/ \
-p 37428:37428 \
-p 37429:37429 \
ghcr.io/markqvist/nomadnet:master
```
2022-04-01 11:41:29 -04:00
## Help & Discussion
For help requests, discussion, sharing ideas or anything else related to Nomad Network, please have a look at the [Nomad Network discussions pages](https://github.com/markqvist/Reticulum/discussions/categories/nomad-network).
2021-10-11 09:25:29 -04:00
## Support Nomad Network
You can help support the continued development of open, free and private communications systems by donating via one of the following channels:
- Ethereum: 0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a
- Bitcoin: 3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq
- Ko-Fi: https://ko-fi.com/markqvist
2021-03-27 05:58:13 -04:00
## Caveat Emptor
2021-09-18 09:11:40 -04:00
Nomad Network is beta 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.
## Screenshots
![Screenshot 1](https://github.com/markqvist/NomadNet/raw/master/docs/screenshots/1.png)
![Screenshot 2](https://github.com/markqvist/NomadNet/raw/master/docs/screenshots/2.png)
![Screenshot 3](https://github.com/markqvist/NomadNet/raw/master/docs/screenshots/3.png)
![Screenshot 4](https://github.com/markqvist/NomadNet/raw/master/docs/screenshots/4.png)
2021-09-18 09:14:54 -04:00
![Screenshot 5](https://github.com/markqvist/NomadNet/raw/master/docs/screenshots/5.png)