Munin plugin for showing information about Freebox
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md
freebox_

README.md

Munin Plugin for Freebox

Overview

This can only be useful to you if you are:

  1. Client of French ISP Free and have a Freebox v6.
  2. Use Munin for monitoring your server.

If both of these conditions are true, you may find this plugin useful to add the display of Freebox data to your Munin graphs, please read on.

Installation

This plugin relies on WebService::Freebox Perl package. The simplest way to install it is to get it from CPAN, e.g.

$ cpan -i WebService::Freebox

As part of its installation, freebox-authorize program is made available. You need to run it once, before using this plugin, in order to obtain the authorization token needed to connect to the Freebox:

$ freebox-authorize org.munin.plugin.freebox "Munin Freebox plugin" 1.0 "Name of your server here"

Keep this token secret as it is sufficient to connect to the Freebox (i.e. no password is required)!

Configuration

Add the following section to /etc/munin/plugin-conf.d/munin-node file:

[freebox_*]
env.app_token token-obtained-above

Add a symbolic link from /etc/munin/plugins/freebox_temp to wherever you put the file freebox_ itself, e.g. /usr/local/share/munin/plugins.

As with any Munin plugin, check that it works manually:

$ munin-run --debug freebox_temp

If everything looks correctly, restart munin to start using it:

$ service munin-node restart

Copyright and Licence

This plugin is (c) 2014 Vadim Zeitlin and distributed under the terms of GPLv2.