Update README
This commit is contained in:
parent
35094c9d3d
commit
db0524c0a1
29
README.md
29
README.md
|
@ -1,31 +1,16 @@
|
||||||
# README
|
# Respond Collector
|
||||||
`micro-daemon` is a respond daemon to fetch information for Freifunk Nodes
|
|
||||||
and represent this information with Websocket- and JSON-APIs.
|
|
||||||
|
|
||||||
## Issues/Features in the Future
|
`Respond Collector` is a respond client that fetches, stores and publishes information about a Freifunk network. The goals:
|
||||||
It will also APIs for manipulate the fetched data
|
* Generating JSON for [MeshViewer](https://github.com/ffnord/meshviewer)
|
||||||
and give a access for ansible to push changes to the nodes.
|
* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/)
|
||||||
|
* Provide information via Websocket- and JSON-APIs
|
||||||
Also it's will push statistic informations to a influxdb.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
```
|
```
|
||||||
Usage of ./micro-daemon:
|
Usage of ./micro-daemon:
|
||||||
-collectInterval int
|
-config path/to/config.yml
|
||||||
interval for data collections (default 15)
|
|
||||||
-host string
|
|
||||||
path aliases.json file
|
|
||||||
-httpdir string
|
|
||||||
a implemented static file webserver (default "webroot")
|
|
||||||
-path-aliases string
|
|
||||||
path aliases.json file (default "webroot/aliases.json")
|
|
||||||
-path-nodes string
|
|
||||||
path nodes.json file (default "webroot/nodes.json")
|
|
||||||
-port string
|
|
||||||
path aliases.json file (default "8080")
|
|
||||||
-saveInterval int
|
|
||||||
interval for data saving (default 60)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
### respond
|
### respond
|
||||||
It send the `gluon-neighbour-info` request and collect them together.
|
It send the `gluon-neighbour-info` request and collect them together.
|
||||||
|
|
Loading…
Reference in New Issue