Update README
This commit is contained in:
parent
0c18f402a0
commit
332e7f5f54
14
README.md
14
README.md
|
@ -6,7 +6,7 @@
|
||||||
`respond-collector` is a respond client that fetches, stores and publishes information about a Freifunk network. The goals:
|
`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))
|
* 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/)
|
* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/)
|
||||||
* Provide information via Websocket- and JSON-APIs
|
* Provide information via JSON-APIs
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
```
|
```
|
||||||
|
@ -20,18 +20,10 @@ 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`.
|
It will send UDP packetes by the multicast group `ff02:0:0:0:0:0:2:1001` and port `1001`.
|
||||||
|
|
||||||
### modes.Nodes
|
### nodes.Nodes
|
||||||
It cached the Informations of the Nodes and will save them periodical to a JSON file.
|
It cached the information of the Nodes and will save them periodical to a JSON file.
|
||||||
The current nodes are saved default under `nodes.json`.
|
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.
|
|
||||||
|
|
||||||
## Related projects
|
## Related projects
|
||||||
|
|
||||||
Collecting data from respondd:
|
Collecting data from respondd:
|
||||||
|
|
Loading…
Reference in New Issue