libperry/pybatmesh
1
0
Fork 0
mirror of https://git.disroot.org/pranav/pybatmesh.git synced 2024-12-24 01:00:02 +05:30
Code Issues Actions Packages Projects Releases Wiki Activity

updated README.md

Browse Source 
Updated the inroduction and added a bit more
on how it works.
This commit is contained in:
Pranav Jerry 2021-06-06 17:49:56 +05:30
parent e28a0f7583
commit adc5601589
2 changed files with 39 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,21 +1,27 @@
# 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
**naxalnet** is an experiment to create a wireless mesh network for
communicating with each other during an internet shutdown, using
existing software and tech as much as possible. Currently
you can only communicate with other peers running the same software.
you can only communicate with other peers running naxalnet or
using the same network as naxalnet. It uses
[B.A.T.M.A.N. Advanced](https://www.open-mesh.org/projects/batman-adv/wiki),
an implementation of the B.A.T.M.A.N. routing protocol to
communicate with peers.
The name naxal comes from Naxalbari, a village in Darjeeling,
West Bengal.
A rewrite in python is in progress in the branch python-rewrite.
This is the ongoing python rewrite branch, which uses
[dasbus](https://github.com/rhinstaller/dasbus) to communicate
with iwd.
<!-- UNCOMMENT WHEN NECESSARY
**Disclaimer**:
In case you are either 1) a complete idiot; or 2) a member of parliament;
or 3) both, please be aware that this project is not affiliated with
any groups designated as terrorist groups in India.
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
@ -54,9 +60,9 @@ without internet access.
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}`.
`/usr/bin/naxalnet`.
After installing, reload systemd so that you can enable `naxalnet@.service`
After installing, reload systemd so that you can enable `naxalnet.service`
without rebooting:
```sh
@ -66,18 +72,20 @@ 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:
Start the naxalnet service:
```
sudo systemctl disable --now NetworkManager
```sh
sudo systemctl start naxalnet.service
```
Enable the naxalnet service on the device `wlan0` (iwd replaces interface
names like wlp1s0 with wlan0):
Starting the service will stop `NetworkManager.service` and
`wpa_supplicant.service` if it is running. If you start either of these
services after naxalnet is started, naxalnet will be stopped by systemd.
```
sudo systemctl enable --now naxalnet.service
To run naxalnet at boot, enable the service:
```sh
sudo systemctl enable naxalnet.service
```
Now naxalnet will configure a batman interface on every boot.
@ -92,12 +100,6 @@ sudo rm -rf /usr/{bin,share}/naxalnet \
/usr/lib/systemd/system/naxalnet.service
```
If you were using NetworkManager before, enable it:
```sh
sudo systemctl enable --now NetworkManager.service
```
## License
This program is free software: you can redistribute it and/or modify

17
naxalnet
View File

@ -85,5 +85,20 @@ try:
except:
sys.exit("An error occured while communicating with iwd")
# Sleep my little baby-oh
# Sleep until you waken
# When you wake you'll see the world
# If I'm not mistaken...
#
# Kiss a lover
# Dance a measure,
# Find your name
# And buried treasure...
#
# Face your life
# Its pain,
# Its pleasure,
# Leave no path untaken.
#
# -- Neil Gaiman, The Graveyard Book
print("Bye")