yanic/README.md

36 lines
1.6 KiB
Markdown
Raw Normal View History

2016-03-12 16:40:43 +01:00
# Respond Collector
2016-02-26 09:28:31 +01:00
2016-03-20 12:34:58 +01:00
[![Build Status](https://travis-ci.org/FreifunkBremen/respond-collector.svg?branch=master)](https://travis-ci.org/FreifunkBremen/respond-collector)
2016-03-20 12:54:40 +01:00
[![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/respond-collector/badge.svg?branch=master)](https://coveralls.io/github/FreifunkBremen/respond-collector?branch=master)
2016-03-20 12:34:58 +01:00
2016-03-15 23:26:30 +01:00
`respond-collector` is a respond client that fetches, stores and publishes information about a Freifunk network. The goals:
2016-03-14 11:02:10 +01:00
* Generating JSON for [MeshViewer](https://github.com/ffnord/meshviewer) (Works with branch [JSONv2](https://github.com/FreifunkBremen/meshviewer/tree/JSONv2))
2016-03-12 16:40:43 +01:00
* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/)
2016-11-20 18:30:10 +01:00
* Provide information via JSON-APIs
2016-02-26 09:28:31 +01:00
## Usage
```
2016-03-15 23:26:30 +01:00
Usage of ./respond-collector:
2016-03-12 16:40:43 +01:00
-config path/to/config.yml
2016-02-26 09:28:31 +01:00
```
2016-03-12 16:40:43 +01:00
2016-02-26 09:28:31 +01:00
## Development
### respond
It send the `gluon-neighbour-info` request and collect them together.
It will send UDP packetes by the multicast group `ff02:0:0:0:0:0:2:1001` and port `1001`.
2016-11-20 18:30:10 +01:00
### nodes.Nodes
It cached the information of the Nodes and will save them periodical to a JSON file.
2016-02-26 09:28:31 +01:00
The current nodes are saved default under `nodes.json`.
2016-03-21 18:58:49 +01:00
## Related projects
Collecting data from respondd:
* [Node informant](https://github.com/ffdo/node-informant) written in Go
* [HopGlass Server](https://github.com/plumpudding/hopglass-server) written in Node.js
Respondd for servers:
* [respondd branch of ffnord-alfred-announce](https://github.com/ffnord/ffnord-alfred-announce/tree/respondd) from FreiFunkNord
* [respondd](https://github.com/Sunz3r/ext-respondd) from Sunz3r