From ef6f81b4262fc4dfa104f8352a6543bbba0baa26 Mon Sep 17 00:00:00 2001 From: Christian Stade-Schuldt Date: Wed, 12 Sep 2018 17:07:10 +0200 Subject: [PATCH] update Readme --- README.md | 74 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 38 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 8f63f17..690c5ae 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,20 @@ A collection of munin plugins to monitor your AVM FRITZ!Box router. The scripts If you are using the scripts on a different Fritz!Box model please let me know by - - opening an issue - - submitting a pull request +- opening an issue +- submitting a pull request So far the following models (running FRITZ!OS 06.83) have been confirmed working: - - [FRITZ!Box 3370](http://geni.us/zh3U) - - [FRITZ!Box 5490](http://geni.us/ACtUyFt) - - [FRITZ!Box 7362 SL](http://geni.us/fTyoY) - - [FRITZ!Box 7390](http://geni.us/BlAP) - - [FRITZ!Box 7430](http://geni.us/BlAP) - - [FRITZ!Box 7490](http://geni.us/fTyoY) - - [FRITZ!Box 7580](http://geni.us/yUYyQTE) - - [FRITZ!Box 7590](http://geni.us/OO2c7S) +- [FRITZ!Box 3370](http://geni.us/zh3U) +- [FRITZ!Box 5490](http://geni.us/ACtUyFt) +- [FRITZ!Box 7362 SL](http://geni.us/fTyoY) +- [FRITZ!Box 7390](http://geni.us/BlAP) +- [FRITZ!Box 7430](http://geni.us/BlAP) +- [FRITZ!Box 7490](http://geni.us/fTyoY) +- [FRITZ!Box 7560](http://geni.us/6gPZNI) +- [FRITZ!Box 7580](http://geni.us/yUYyQTE) +- [FRITZ!Box 7590](http://geni.us/OO2c7S) If you are still running Fritz!OS 6.30 check out the [releases section](https://github.com/Tafkas/fritzbox-munin/releases/tag/6.30.1). @@ -26,36 +27,36 @@ If you are using the scripts on a different Fritz!Box model please let me know b ## fritzbox\_traffic - fritzbox\_traffic shows you the traffic of the WAN interface (requires fritzconnection) + fritzbox\_traffic shows you the traffic of the WAN interface (requires fritzconnection) ![http://i.imgur.com/8BwNMOL.png](http://i.imgur.com/8BwNMOL.png) If you do not want to show the interface maximum values, add the following to your plugin-configuration: env.traffic_remove_max true - + ## fritzbox\_connection\_uptime - fritzbox\_connection\_uptime shows you the connection uptime in days (requires fritzconnection) + fritzbox\_connection\_uptime shows you the connection uptime in days (requires fritzconnection) ![http://i.imgur.com/8oE1OYL.png](http://i.imgur.com/8oE1OYL.png) - + ## fritzbox\_cpu\_usage - fritzbox\_cpu\_usage shows you the cpu usage (requires password) + fritzbox\_cpu\_usage shows you the cpu usage (requires password) ![http://i.imgur.com/A9uGvWP.png](http://i.imgur.com/A9uGvWP.png) ## fritzbox\_cpu\_temperature - fritzbox\_cpu\_temperature shows you the cpu temperature (requires password) + fritzbox\_cpu\_temperature shows you the cpu temperature (requires password) ![http://i.imgur.com/duHYhw6.png](http://i.imgur.com/duHYhw6.png) - + ## fritzbox\_memory\_usage - fritzbox\_memory\_usage shows you the memory usage (requires password) + fritzbox\_memory\_usage shows you the memory usage (requires password) ![http://i.imgur.com/WhxrINK.png](http://i.imgur.com/WhxrINK.png) ## fritzbox\_power\_consumption - fritzbox\_power\_consumption shows you the power consumption (requires password) + fritzbox\_power\_consumption shows you the power consumption (requires password) ![http://i.imgur.com/a7uQzn6.png](http://i.imgur.com/a7uQzn6.png) ## fritzbox\_uptime @@ -67,30 +68,31 @@ If you are using the scripts on a different Fritz!Box model please let me know b fritzbox\_wifi\_devices shows you the number of connected wifi clients (requires password) (language dependant, see below). ![http://i.imgur.com/lqvK1b2.png](http://i.imgur.com/lqvK1b2.png) - -## Installation & Configuration +## Installation & Configuration + +1. Pre-requesites for the fritzbox\_traffic and fritzbox\_uptime plugins are the [fritzconnection](https://pypi.python.org/pypi/fritzconnection) and [requests](https://pypi.python.org/pypi/requests) package. To install it -0. Pre-requesites for the fritzbox\_traffic and fritzbox\_uptime plugins are the [fritzconnection](https://pypi.python.org/pypi/fritzconnection) and [requests](https://pypi.python.org/pypi/requests) package. To install it - pip install fritzconnection pip install requests -1. Make sure the FritzBox has UPnP status information enabled. (German interface: Heimnetz > Heimnetzübersicht > Netzwerkeinstellungen > Statusinformationen über UPnP übertragen) +2. Make sure the FritzBox has UPnP status information enabled. (German interface: Heimnetz > Heimnetzübersicht > Netzwerkeinstellungen > Statusinformationen über UPnP übertragen) -2. Copy all the scripts to `/usr/share/munin/plugins` - -3. Create entry in `/etc/munin/plugin-conf.d/munin-node`: - - [fritzbox_*] - env.fritzbox_ip - env.fritzbox_password +3. Copy all the scripts to `/usr/share/munin/plugins` -4. Create symbolic links to `/etc/munin/plugins`. +4. Create entry in `/etc/munin/plugin-conf.d/munin-node`: -5. Restart the munin-node daemon: `/etc/init.d/munin-node restart`. + [fritzbox_*] + env.fritzbox_ip + env.fritzbox_password + env.traffic_remove_max true # if you do not want the possible max values + host_name fritzbox -6. Done. You should now start to see the charts on the Munin pages. +5. Create symbolic links to `/etc/munin/plugins`. + +6. Restart the munin-node daemon: `/etc/init.d/munin-node restart`. + +7. Done. You should now start to see the charts on the Munin pages. ## Localization @@ -114,7 +116,7 @@ You can split the graphs of your fritzbox from the localhost graphs by following address 127.0.0.1 use_node_name yes - + [home.yourhost.net;fritzbox] address 127.0.0.1 use_node_name no @@ -126,5 +128,5 @@ You can split the graphs of your fritzbox from the localhost graphs by following 3. Restart your munin-node: `systemctl restart munin-node` ## Environment Settings - + Do not forget to restart the munin-node daemon as described in step 3 of the installation instructions above.