Updated README

Now the issue #1 is ready to be closed.
This commit is contained in:
Pranav Jerry 2021-06-15 14:24:03 +05:30
parent 79b9a161f1
commit b8d14e1d65
No known key found for this signature in database
GPG Key ID: F1DCDC4FED0A0C5B

View File

@ -15,14 +15,14 @@ West Bengal.
<!-- 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.
In case you are either 1) a complete idiot; or 2) a member of the saffron
brigade; 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).
with anyone the government of India collectively calles Urban
Naxals (human rights activists, lawyers, poets, writers, journalists
or anyone else advocating for their rights).
-->
@ -37,6 +37,7 @@ advocating the constitutional rights).
- wifi adapter with ad-hoc support
- two or more computers with wifi adapter
- systemd-resolved (optional, for DNS)
- batctl (optional, for debugging)
## Installing
@ -65,15 +66,41 @@ without rebooting:
sudo systemctl daemon-reload
```
## Running the program
## How to use
You need more than one computer running for the connection to work.
Start the naxalnet service:
### Communicate between peers
Connect a wifi adapter to all the computers you intend to run
naxalnet.
Start the naxalnet service on all of them:
```sh
sudo systemctl start naxalnet.service
```
To test if it works, run `ip addr` to find out your address.
Note the `inet` or `inet6` address of `bridge0`. Ping the address
from another computer (example: `ping 169.254.62.90`) to find out
if it is online. Press Ctrl-C to stop.
### Getting internet access
Connect an ethernet to any of the peers and start naxalnet.
Now all the peers should be able to connect after renewing
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
SSID `NaxalNet` and password `naxalnet256`.
If you had set up internet access on one of the peers, internet
can be accessed from the AP.
### Running at boot
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, systemd will stop naxalnet.