pybatmesh/README.md

3.4 KiB

naxalnet

Naxalnet is an experiment to create an intranet and use it for communicating with each other during an internet shutdown. It tries to use existing software and tech as much as possible. Currently you can only communicate with other peers running the same software.

The name naxal comes from Naxalbari, a village in Darjeeling, West Bengal.

A rewrite in python is in progress in the branch python-rewrite.

How it works

The program naxalnet copies predefined systemd-networkd configuration into networkd's runtime configuration directory. It uses iwctl to start an ad-hoc network named "Hello World". The wireless interface is linked to bat0, the batman interface. A bridge bridge0 is created so that other devices such as wired connections and wireless ap can be bridged. bat0 is added to the bridge, and the bridge gets an ip address (link-local, or DHCP if any of the computers have a DHCP server configured). If these were successful, an intranet is created. You can now use services like IPFS, Jami, Secure Scuttlebutt and others which can work without internet access.

Requirements

  • systemd v248 or more (for batman support)
  • Linux kernel with batman-adv module (if modinfo batman-adv shows no error then you already have it)
  • iwd (for starting ad-hoc network)
  • wifi adapter with ad-hoc support
  • two or more computers with wifi adapter

Installing

Manually

Clone the repo and cd into it.

Run sudo make install to install naxalnet. This will install naxalnet in /usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}.

After installing, reload systemd so that you can enable naxalnet@.service without rebooting:

sudo systemctl daemon-reload

Running the program

You need more than one computer running for the connection to work. Any network managers such as NetworkManager and wifi daemons like wpa_supplicant should be disabled:

sudo systemctl disable --now NetworkManager

Enable the naxalnet service on the device wlan0 (iwd replaces interface names like wlp1s0 with wlan0):

sudo systemctl enable --now naxalnet.service

Now naxalnet will configure a batman interface on every boot.

Uninstalling

Currently there is now way to uninstall naxalnet than manually removing the files:

sudo rm -rf /usr/{bin,share}/naxalnet \
/usr/lib/systemd/system/naxalnet.service

If you were using NetworkManager before, enable it:

sudo systemctl enable --now NetworkManager.service

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

See LICENSE.md for the complete version of the license.

TODO

  • add support for wireless ap (WiFi hotspot)

Add list of things here.

This project is in alpha stage. Documentation is incomplete.