parent
428a9731e0
commit
4b88a196ac
26
README.md
26
README.md
|
@ -2,33 +2,21 @@
|
|||
|
||||
[![Build Status](https://travis-ci.org/ffnord/ffmap-backend.svg?branch=master)](https://travis-ci.org/ffnord/ffmap-backend)
|
||||
|
||||
ffmap-backend gathers information on the batman network by invoking
|
||||
ffmap-backend gathers information on the batman network by invoking :
|
||||
|
||||
* batctl,
|
||||
* batctl (might require root),
|
||||
* alfred-json and
|
||||
* batadv-vis
|
||||
|
||||
as root (via sudo) and has this information placed into a target directory
|
||||
as the file "nodes.json" and also updates the directory "nodes" with graphical
|
||||
representations of uptimes and the number of clients connecting.
|
||||
In order to use alfred-json and batadv-vis make sure the user running this
|
||||
backend is allowed to access alfred's socket.
|
||||
|
||||
The output will be written to a directory (`-d output`).
|
||||
|
||||
Run `backend.py --help` for a quick overview of all available options.
|
||||
|
||||
When executed without root privileges, we suggest to grant sudo permissions
|
||||
within wrappers of those binaries, so no further changes are required in other
|
||||
scripts:
|
||||
|
||||
<pre>
|
||||
$ cat <<EOCAT > $HOME/batctl
|
||||
#!/bin/sh
|
||||
exec sudo /usr/sbin/batctl $*
|
||||
EOCAT
|
||||
</pre>
|
||||
|
||||
and analogously for batadv-vis. The entry for /etc/sudoers could be
|
||||
whateveruser ALL=(ALL:ALL) NOPASSWD: /usr/sbin/batctl,/usr/sbin/batadv-vis,/usr/sbin/alfred-json
|
||||
|
||||
For the script's regular execution add the following to the crontab:
|
||||
|
||||
<pre>
|
||||
* * * * * /path/to/ffmap-backend/backend.py -d /path/to/output -a /path/to/aliases.json --vpn ae:7f:58:7d:6c:2a --vpn d2:d0:93:63:f7:da
|
||||
</pre>
|
||||
|
|
Loading…
Reference in New Issue