yanic/README.md

44 lines
1.7 KiB
Markdown
Raw Normal View History

2017-03-03 10:57:38 +01:00
# Yanic
```
__ __ _
\ \ / /_ _ _ __ (_) ___
\ V / _` | '_ \| |/ __|
| | (_| | | | | | (__
|_|\__,_|_| |_|_|\___|
Yet another node info collector
```
2016-02-26 09:28:31 +01:00
[![Build Status](https://travis-ci.org/FreifunkBremen/yanic.svg?branch=master)](https://travis-ci.org/FreifunkBremen/yanic)
[![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/yanic/badge.svg?branch=master)](https://coveralls.io/github/FreifunkBremen/yanic?branch=master)
2016-03-20 12:34:58 +01:00
2017-03-03 10:57:38 +01:00
`yanic` is a respondd client that fetches, stores and publishes information about a Freifunk network. The goals:
2017-01-30 15:23:36 +01:00
* Generating JSON for [Meshviewer](https://github.com/ffrgb/meshviewer)
2016-03-12 16:40:43 +01:00
* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/)
2017-01-30 15:23:36 +01:00
* Provide a little webserver for a standalone installation with a meshviewer
2016-02-26 09:28:31 +01:00
## Usage
```
2017-03-03 10:57:38 +01:00
Usage of ./yanic:
-config path/to/config.toml
2016-02-26 09:28:31 +01:00
```
2017-01-30 15:23:36 +01:00
## Configuration
Read comments in [config_example.toml](config_example.toml) for more information.
## Live
* [meshviewer](https://map.bremen.freifunk.net) **Freifunk Bremen** with a patch to show state-version of `nodes.json`
* [grafana](https://grafana.bremen.freifunk.net) **Freifunk Bremen** show data of InfluxDB
## How it works
2016-03-12 16:40:43 +01:00
In the first step Yanic sends a multicast message to the group `ff02:0:0:0:0:0:2:1001` and port `1001`.
Recently seen nodes that does not reply are requested via a unicast message.
2016-02-26 09:28:31 +01:00
2016-03-21 18:58:49 +01:00
## Related projects
Collecting data from respondd:
* [HopGlass Server](https://github.com/plumpudding/hopglass-server) written in Node.js
Respondd for servers:
2017-01-30 15:23:36 +01:00
* [ffnord-alfred-announce](https://github.com/ffnord/ffnord-alfred-announce) from FreiFunkNord
2016-03-21 18:58:49 +01:00
* [respondd](https://github.com/Sunz3r/ext-respondd) from Sunz3r