yanic/README.md
Julian Kornberger f43871ef90 Add Travis CI
2016-03-20 12:36:46 +01:00

34 lines
1.3 KiB
Markdown

# Respond Collector
[![Build Status](https://travis-ci.org/FreifunkBremen/respond-collector.svg?branch=master)](https://travis-ci.org/FreifunkBremen/respond-collector)
`respond-collector` is a respond 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 Websocket- and JSON-APIs
## Usage
```
Usage of ./respond-collector:
-config path/to/config.yml
```
## 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.