54 lines
2.3 KiB
Markdown
54 lines
2.3 KiB
Markdown
# Yanic
|
|
```
|
|
__ __ _
|
|
\ \ / /_ _ _ __ (_) ___
|
|
\ V / _` | '_ \| |/ __|
|
|
| | (_| | | | | | (__
|
|
|_|\__,_|_| |_|_|\___|
|
|
Yet another node info collector
|
|
```
|
|
|
|
[](https://travis-ci.org/FreifunkBremen/yanic)
|
|
[](https://coveralls.io/github/FreifunkBremen/yanic?branch=master)
|
|
[](https://goreportcard.com/report/github.com/FreifunkBremen/yanic)
|
|
|
|
`yanic` is a respondd client that fetches, stores and publishes information about a Freifunk network. The goals:
|
|
* Generating JSON for [Meshviewer](https://github.com/ffrgb/meshviewer)
|
|
* Storing statistics in [InfluxDB](https://influxdata.com/) or [Graphite](https://graphiteapp.org/) to be analyzed by [Grafana](http://grafana.org/)
|
|
* Provide a little webserver for a standalone installation with a meshviewer
|
|
|
|
## How it works
|
|
|
|
In the first step Yanic sends a multicast message to the group `ff02:0:0:0:0:0:2:1001` and port `1001`.
|
|
Recently seen nodes that does not reply are requested via a unicast message.
|
|
|
|
## [Documentation](https://www.gitbook.com/book/freifunkbremen/yanic/details)
|
|
* [Webview](https://freifunkbremen.gitbooks.io/yanic/content/)
|
|
* [PDF](https://www.gitbook.com/download/pdf/book/freifunkbremen/yanic)
|
|
* [Mobi](https://www.gitbook.com/download/mobi/book/freifunkbremen/yanic)
|
|
* [ePUB](https://www.gitbook.com/download/epub/book/freifunkbremen/yanic)
|
|
|
|
|
|
## Quick startup
|
|
|
|
### Usage
|
|
```
|
|
Usage of ./yanic:
|
|
-config path/to/config.toml
|
|
```
|
|
### Configuration
|
|
Read comments in [config_example.toml](config_example.toml) for more information.
|
|
|
|
### Live
|
|
* [meshviewer](https://map.bremen.freifunk.net) **Freifunk Bremen** with a patch to show state-version of `nodes.json`
|
|
* [grafana](https://grafana.bremen.freifunk.net) **Freifunk Bremen** show data of InfluxDB
|
|
|
|
## Related projects
|
|
|
|
Collecting data from respondd:
|
|
* [HopGlass Server](https://github.com/plumpudding/hopglass-server) written in Node.js
|
|
|
|
Respondd for servers:
|
|
* [ffnord-alfred-announce](https://github.com/ffnord/ffnord-alfred-announce) from FreiFunkNord
|
|
* [respondd](https://github.com/Sunz3r/ext-respondd) from Sunz3r
|