c7aeb97fe5
Typos
36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
# Respond Collector
|
|
|
|
[![Build Status](https://travis-ci.org/FreifunkBremen/respond-collector.svg?branch=master)](https://travis-ci.org/FreifunkBremen/respond-collector)
|
|
[![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/respond-collector/badge.svg?branch=master)](https://coveralls.io/github/FreifunkBremen/respond-collector?branch=master)
|
|
|
|
`respond-collector` is a respondd client that fetches, stores and publishes information about a Freifunk network. The goals:
|
|
* Generating JSON for [MeshViewer](https://github.com/ffnord/meshviewer) (Works with branch [JSONv2](https://github.com/FreifunkBremen/meshviewer/tree/JSONv2))
|
|
* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/)
|
|
* Provide information via JSON-APIs
|
|
|
|
## Usage
|
|
```
|
|
Usage of ./respond-collector:
|
|
-config path/to/config.yml
|
|
```
|
|
|
|
## Development
|
|
### respond
|
|
It sends the `gluon-neighbour-info` request and collects the answers.
|
|
|
|
It will send UDP packets with multicast group `ff02:0:0:0:0:0:2:1001` and port `1001`.
|
|
|
|
### nodes.Nodes
|
|
It caches the information of the nodes and will save them periodical to a JSON file.
|
|
The current nodes are saved default under `nodes.json`.
|
|
|
|
## 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
|