Improved README.md

Added how to stop the systemd service and improved the similar projects section.
This commit is contained in:
Pranav Jerry 2021-06-23 13:48:05 +05:30
parent af98a57b0e
commit 47f2324604
Signed by: pranav
GPG Key ID: F1DCDC4FED0A0C5B
1 changed files with 27 additions and 6 deletions

View File

@ -99,7 +99,7 @@ their DHCP connection (`sudo networkctl renew bridge0`).
### Tethering via WiFi AP
Connect two wifi adapters on a device and start naxalnet.
Now an ap will be created on one of the devices with
Now an ap will be created on one of the adapters with
SSID `NaxalNet` and password `naxalnet256`.
If you had set up internet access on one of the peers, internet
can be accessed from the AP.
@ -123,20 +123,36 @@ Disable the service to stop running at boot:
sudo systemctl disable naxalnet.service
```
### Stopping the service
```sh
# Stop the services
sudo systemctl stop naxalnet systemd-networkd systemd-resolved iwd
# Delete the virtual interfaces created by naxalnet
sudo networkctl delete bat0 bridge0
```
If your distribution uses NetworkManager, starting `naxalnet.service`
will have stopped it. Start NetworkManager again:
```sh
sudo systemctl start NetworkManager.service
```
## How it works
The program naxalnet copies predefined systemd-networkd configuration
The program naxalnet copies some `systemd-networkd` configuration files
into networkd's runtime configuration directory. It uses iwd to start
an ad-hoc network named "HelloWorld". See the
[systemd-networkd](systemd-networkd) directory
to see how systemd-networkd configures the network. You can now use
to see how systemd-networkd configures the network. You can use
services like [IPFS][], [Jami][], [Secure Scuttlebutt][ssb]
and others which can work without internet access.
and others which can work on an intranet.
## Uninstalling
Currently there is now way to uninstall naxalnet than manually removing
the files:
If you installed naxalnet manually, there is now way to uninstall
than manually removing the files:
```sh
sudo rm -rf /usr/{bin,share}/naxalnet \
@ -145,6 +161,11 @@ sudo rm -rf /usr/{bin,share}/naxalnet \
## Similar projects
The following projects are similar to naxalnet, but are not designed
to be used in a laptop or computer with wifi adapter. If you live in
an area where the materials required for any of them are easily
available, consider using them instead of naxalnet.
- [LibreMesh][libremesh]: framework for OpenWrt-based
firmwares
- [disaster.radio][]: solar-powered communications network