libperry/pybatmesh
1
0
Fork 0
mirror of https://git.disroot.org/pranav/pybatmesh.git synced 2024-11-26 16:52:07 +05:30
Code Issues Actions Packages Projects Releases Wiki Activity

improved documentation

Browse Source
This commit is contained in:
Pranav Jerry 2021-10-08 22:28:01 +05:30
parent 3b3644e107
commit e56ff40495
No known key found for this signature in database
GPG Key ID: F1DCDC4FED0A0C5B
3 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CHANGELOG.md
View File

@ -1,10 +1,11 @@
# Changelog
## [Unreleased][] - 2021-09-29
## [Unreleased][] - 2021-10-08
- Better error messages
- Sets gateway mode automatically. **This might cause problems with nodes
running previous version of naxalnet** (#15)
- Sets gateway mode automatically (to choose the best available
connection). **This might cause problems with nodes running previous
version of naxalnet** (#15)
- Cleanup before exit
- Closed #19

2
HACKING.md
View File

@ -10,7 +10,7 @@ To report a bug or suggest an idea, create a new issue at
## Improving documentation
The README and HACKING.md needs to be more beginner friendly.
See section below.
See #20.
## Contribute code

55
README.md
View File

@ -1,18 +1,15 @@
# naxalnet
**naxalnet** is a program to create a wireless mesh network for
communicating with each other. It can be useful during an
[internet shutdown](#internet-shutdown), or to join
[online classes](#online-class) with a group of laptops.
It uses [B.A.T.M.A.N. Advanced][batman-adv], 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.
communicating with each other. It can be useful during an [internet
shutdown](#internet-shutdown), or to join [online classes](#online-class)
with a group of laptops. It uses [B.A.T.M.A.N. Advanced][batman-adv], 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.
WARNING:
This program uses an **unencrypted** network. This means
you do not get any more privacy or security than with an open WiFi
network.
**WARNING**: This program uses an **unencrypted** network. This means you do
not get any more privacy or security than with an open WiFi network.
<!-- NOTE TO ACTIVISTS
@ -27,13 +24,14 @@ well-being if you get arrested under a draconian national security law.
-->
<!-- UNCOMMENT WHEN NECESSARY
**Disclaimer**:
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 human rights groups designated as "terrorist" groups in India.
**Disclaimer**: 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 human rights defenders or with anyone currently at
risk of death in overcrowded prisons.
Using the name naxal does not imply any form of connection
with anyone currently at risk of death in overcrowded prisons.
Using the name naxal in a program will not shake the foundations of
democracy nor affect the soverignty, unity or integrity of any
nation-state. .
-->
@ -42,7 +40,7 @@ with anyone currently at risk of death in overcrowded prisons.
- [systemd-networkd v248 or greater][batman-systemd]
- Linux kernel with [batman-adv v2021.0][batman-systemd] or greater
- [iwd][] for controlling the WiFi adapter
- python (atleast 3.6)
- python (tested only on 3.9)
- python setuptools, for building and installing naxalnet
- [python-systemd][], for logging to systemd journal
- [dasbus][], for communicating with iwd
@ -90,7 +88,7 @@ Now follow the instructions in the
### Fedora
naxalnet is not packaged for Fedora, so it should be installed manually.
naxalnet requires atleast systemd v248 which is only available on **Fedora
naxalnet requires atleast systemd v248, which is only available on **Fedora
34 and above**. python-setuptools support building rpms, which are the
preferred way of installing software in Fedora. Follow the steps to
install naxalnet on Fedora:
@ -106,7 +104,7 @@ cd naxalnet
# Create an installable rpm from the source code
make rpm
# Now install it.
# Now install it. This will also install the requirements
sudo dnf install dist/naxalnet-$(python3 -m setup --version)-1.noarch.rpm
```
@ -263,6 +261,10 @@ arguments:
naxalnet --help
```
## Contributing or reporting bugs
See [HACKING.md](HACKING.md)
## How it works
There are three modes commonly supported by WiFi adapters - `ap` (WiFi
@ -301,10 +303,11 @@ Withheld due to national security reasons.
You can communicate with neighbouring devices running naxalnet, using
services like [IPFS][], [Jami][], [Secure Scuttlebutt][ssb] and others
which can work on an intranet. They should be installed on your
machine _before_ your friendly democratic government announces an
[internet shutdown][], since you cannot download and install them
during a shutdown. When a shutdown occurs, [enable naxalnet][enablenx].
which can work on an intranet. They should be installed on your machine
_before_ your friendly democratic government announces an [internet
shutdown][], since you cannot download and install them during a shutdown.
When a shutdown occurs, [enable naxalnet][enablenx] and use the installed
software to communicate with anyone within range.
## Uninstalling
@ -318,10 +321,6 @@ sudo make uninstall
sudo make purge
```
## Contributing or reporting bugs
See [HACKING.md](HACKING.md)
## Similar projects
Many projects make setting up B.A.T.M.A.N. Advanced mesh networks with