libperry/pybatmesh
1
0
Fork 0
mirror of https://git.disroot.org/pranav/pybatmesh.git synced 2025-02-03 04:19:55 +05:30
Code Issues Actions Packages Projects Releases Wiki Activity

updated README.md

Browse Source 
Now that naxalnet is a daemon, there was some things which didn't make
sense anymore. So they were removed.
This commit is contained in:
Pranav Jerry 2021-09-08 15:52:14 +05:30
parent c638de4c9c
commit f9c969d233
No known key found for this signature in database
GPG Key ID: F1DCDC4FED0A0C5B
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -153,7 +153,7 @@ You need more than one machine running naxalnet for the connection to work.
### Start naxalnet ### Start naxalnet
Though naxalnet can run from the commandline, it was designed to be Though naxalnet can run from the command line, it was designed to be
run as a systemd service. run as a systemd service.
To start naxalnet, do the command on all the nodes: To start naxalnet, do the command on all the nodes:
@ -163,25 +163,25 @@ sudo systemctl start naxalnet.service
This will start a mesh network and connect to all nodes. This will start a mesh network and connect to all nodes.
To test if it works, run `sudo batctl n -w` and check for To test if it works, run `sudo batctl n -w` and check for
nodes. If there are any nodes, your network is up. nodes. If there are any nodes, your network is up. Press
Ctrl+C to stop `batctl`.
### Getting internet access ### Getting internet access
Connect an ethernet cable from a router to any of the peers and Connect an ethernet cable from a router to any of the nodes and
[start naxalnet][startnx]. If it was already started, you should
renew the DHCP connection of all peers. To do this, type renew the DHCP connection of all peers. To do this, type
`sudo networkctl renew bridge0` on all peers. `sudo networkctl renew bridge0` on all nodes.
### Tethering via WiFi AP ### Tethering via WiFi AP
If there are two adapters in a peer, naxalnet will start a If there are two adapters in a peer, naxalnet will start a
WiFi ap (also called WiFi hotspot) on one of them. WiFi ap (also called WiFi hotspot) on one of them.
Connect two WiFi adapters on a device and [start naxalnet][startnx]. Connect two WiFi adapters on a node.
Now an ap will be started on one of the adapters. Now an AP will be started on one of the adapters.
Type `naxalnet --print-wifi` to get the WiFi SSID and password. Type `naxalnet --print-wifi` to get the WiFi SSID and password.
If you had set up internet access on one of the peers, internet If you had set up internet access on one of the nodes, internet
can be accessed from the AP. can be accessed from the AP.
### Running at boot ### Running at boot
@ -246,7 +246,7 @@ naxalnet starts an ad-hoc on one of them and an ap on the other.
You can use the ap for connecting mobile phones and other devices You can use the ap for connecting mobile phones and other devices
to the mesh network. to the mesh network.
Read the code and the documentation to learn the details. Read the code and the documentation in the code to learn the details.
See the directory [systemd-networkd](systemd-networkd) to see how See the directory [systemd-networkd](systemd-networkd) to see how
systemd-networkd configures the network. systemd-networkd configures the network.
@ -295,13 +295,13 @@ See [HACKING.md](HACKING.md)
Many projects make setting up B.A.T.M.A.N. Advanced mesh networks with Many projects make setting up B.A.T.M.A.N. Advanced mesh networks with
WiFi routers easier. They are easier to setup and are more WiFi routers easier. They are easier to setup and are more
configurable. But naxalnet is different from them. It simplifies configurable. But naxalnet is different from them. It simplifies
setting up mesh networks with _laptops or computers_, and is not setting up mesh networks with _laptops or computers_, and was not
designed to work with routers. made to work with routers.
The following projects does something similar to naxalnet, but The following projects does something similar to naxalnet, but
requires special devices or routers to work. If you live in an area requires special devices or routers to work. If you live in an area
where the materials required for any of them are easily available, where the materials are easily available, consider using them instead
consider using them instead of naxalnet. of naxalnet.
- [LibreMesh][]: framework for OpenWrt-based firmwares - [LibreMesh][]: framework for OpenWrt-based firmwares
- [disaster.radio][]: solar-powered communications network - [disaster.radio][]: solar-powered communications network