pybatmesh/README.md

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

<!-- UNCOMMENT WHEN NECESSARY

**Disclaimer**:
In case you are either 1) a complete idiot; or 2) a member of parliament in
India; or 3) both, please be aware that this project is not affiliated with
any groups designated as terrorist groups in India.

Using the name Naxal does not imply any form of connection
with anyone the government collectively calles Urban Naxals (human rights
activists, lawyers, poets, writers, journalists or anyone else
advocating the constitutional rights).

-->

## 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](https://ipfs.io),
[Jami](https://jami.net), [Secure Scuttlebutt](https://scuttlebutt.nz)
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}`.

To install in /usr/local instead, use `sudo make install PREFIX=/usr/local`.

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 wpa_supplicant
```

Enable the naxalnet service on the device `wlan0` (iwd replaces interface
names like wlp1s0 with wlan0):
```
sudo systemctl enable --now naxalnet@wlan0.service
```
Now naxalnet will configure a batman interface on every boot.

## Uninstalling

Currently there is now way to uninstall naxalnet than to manually removing
the files:
```
sudo rm -r /usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}
```
Or if you installed naxalnet in /usr/local:
```
sudo rm -r /usr/local/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}
```

## TODO

- add support for wireless ap (WiFi hotspot)

Add list of things here.

This project is in pre-alpha stage. Documentation is incomplete.