From 863affc2d1f4e2fcc152bcff1a2569227699576f Mon Sep 17 00:00:00 2001 From: Ruben Barkow Date: Mon, 30 Oct 2017 16:43:22 +0100 Subject: [PATCH] README: hint to dev branch or modern backends --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 37e4a88..2556758 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ [![Build Status](https://travis-ci.org/ffnord/ffmap-backend.svg?branch=master)](https://travis-ci.org/ffnord/ffmap-backend) +The `master` branch only supports the old `nodes.json` `v1` format. Please +consider using the `dev` branch or one of the more advanced aproaches that +generate `nodes.json` in the new `v2` format or as `meshviewer.json` + + * Yanic: https://github.com/FreifunkBremen/yanic + * Hopglass-Server: https://github.com/hopglass/hopglass-server + +--- + ffmap-backend gathers information on the batman network by invoking : * batctl (might require root), @@ -10,14 +19,14 @@ ffmap-backend gathers information on the batman network by invoking : The output will be written to a directory (`-d output`). -Copy `mkmap.sh-example` to `mkmap.sh` and adapt to your needs, test `backend.py` for example with: +Copy `mkmap.sh-example` to `mkmap.sh` and adapt to your needs, test `backend.py` for example with: backend.py -d /path/to/output -a /path/to/aliases.json --vpn ae:7f:58:7d:6c:2a d2:d0:93:63:f7:da Run `backend.py --help` for a quick overview of all available options. For the script's regular execution add the following file to cron in `/etc/cron.d/ffmap-backend`: - + MAILTO=example@your-NOC.org # Freifunk Map Updates PATH=/usr/sbin:/usr/bin:/sbin:/bin