yanic/README.md

35 lines
1.5 KiB
Markdown
Raw Normal View History

2016-03-12 15:40:43 +00:00
# Respond Collector
2016-02-26 08:28:31 +00:00
2016-03-20 11:34:58 +00:00
[![Build Status](https://travis-ci.org/FreifunkBremen/respond-collector.svg?branch=master)](https://travis-ci.org/FreifunkBremen/respond-collector)
2016-03-20 11:54:40 +00: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 11:34:58 +00:00
2016-03-15 22:26:30 +00:00
`respond-collector` is a respond client that fetches, stores and publishes information about a Freifunk network. The goals:
2016-03-14 10:02:10 +00:00
* Generating JSON for [MeshViewer](https://github.com/ffnord/meshviewer) (Works with branch [JSONv2](https://github.com/FreifunkBremen/meshviewer/tree/JSONv2))
2016-03-12 15:40:43 +00:00
* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/)
* Provide information via Websocket- and JSON-APIs
2016-02-26 08:28:31 +00:00
## Usage
```
2016-03-15 22:26:30 +00:00
Usage of ./respond-collector:
2016-03-12 15:40:43 +00:00
-config path/to/config.yml
2016-02-26 08:28:31 +00:00
```
2016-03-12 15:40:43 +00:00
2016-02-26 08:28:31 +00: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`.
### modes.Nodes
It cached the Informations of the Nodes and will save them periodical to a JSON file.
The current nodes are saved default under `nodes.json`.
### websocketserver
One Instance is running under `/nodes` which send updates or new Nodes,
which are collected by respond.
### Issues
Later there should be also `/aliases` Websocket with Authentification to manage the `aliases.json` with the request for changes.