Communicate Freely
 
 
 
 
Go to file
JP Hastings-Spital a917cbf010 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-27 21:42:59 +01:00
.github/workflows Automated docker build for nomadnet daemon 2022-04-27 21:42:59 +01:00
docs/screenshots
nomadnet Fixed typo 2022-04-20 21:17:52 +02:00
.dockerignore Automated docker build for nomadnet daemon 2022-04-27 21:42:59 +01:00
.gitignore
Dockerfile Automated docker build for nomadnet daemon 2022-04-27 21:42:59 +01:00
LICENSE
Makefile Added makefile 2021-12-01 20:14:51 +01:00
README.md Automated docker build for nomadnet daemon 2022-04-27 21:42:59 +01:00
setup.py Updated dependency versions 2022-03-28 15:32:49 +02:00

README.md

Nomad Network - Communicate Freely

Off-grid, resilient mesh communication with strong encryption, forward secrecy and extreme privacy.

Screenshot

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.

Nomad Network is build on LXMF and 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.

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.

Notable Features

  • Encrypted messaging over packet-radio, LoRa, WiFi or anything else Reticulum supports.
  • Zero-configuration, minimal-infrastructure mesh communication
  • Distributed and encrypted message store holds messages for offline users
  • Connectable nodes that can host pages and files
  • Node-side generated pages with PHP, Python, bash or others
  • 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

Current Status

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.

Feature roadmap

  • Network-wide propagated bulletins and discussion threads
  • Collaborative maps
  • Facilitation of trade and barter

How do I get started?

The easiest way to install Nomad Network is via pip:

# Install Nomad Network and dependencies
pip3 install nomadnet

# Run the client
nomadnet

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.

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. For a general introduction on how to set up such a system, take a look at this post.

If you want to try Nomad Network without building your own physical network, you can connect to the Unsigned.io RNS Testnet over the Internet, where there is already some Nomad Network and LXMF activity.

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.

Installing on Android

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 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.

For a native Android application with a graphical user interface, have a look at Sideband.

Using docker / running a daemon

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).

$ 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

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.

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:

Caveat Emptor

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

Screenshot 2

Screenshot 3

Screenshot 4

Screenshot 5