From f72c41c93fbcc3ae2c596c7bfef91771fbcb954b Mon Sep 17 00:00:00 2001 From: Rico Ullmann Date: Sat, 3 Aug 2019 18:39:56 +0200 Subject: [PATCH] add README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e9ffee --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# telegraf-fritzbox - Simple Fritz!Box statistics for your Grafana + +## Requirements + +* [FritzBoxShell](https://github.com/jhubig/FritzBoxShell) +* telegraf on a system which is in the same network as your Fritz!Box +* InfluxDB reachable by telegraf +* Grafana connected to InfluxDB +* fish shell + +## Setup + +* Download `telegraf_fritzbox`, put it somewhere on your system, change the variable `fbshell` and test if the script works by executing it + * Verify that you've set proper permissions and user (e.g. `-rwx------ 1 telegraf root 2125 Jun 3 22:59 /usr/local/bin/telegraf_fritzbox*`) +* Place `fritzbox.conf` into your telegraf config dir, e.g. `/etc/telegraf/telegraf.d/fritzbox.conf` and adjust the path to `telegraf_fritzbox` +* Test the configuration by executing something like `telegraf -test --config /etc/telegraf/telegraf.d/fritzbox.conf` +* Restart telegraf +* Import `grafana_dashboard.json` into your Grafana instance +* Enjoy! + +## Example Screenshot + +![example grafana dashboard data fritzbox](grafana_fritzbox_dashboard_preview.png)