From c767e7276798fb2d16e35cc1b4849d993bd5cb12 Mon Sep 17 00:00:00 2001 From: Florent Fourcot Date: Thu, 22 Mar 2012 00:02:01 +0100 Subject: [PATCH] Change documentation --- contrib/freemobile-munin | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/contrib/freemobile-munin b/contrib/freemobile-munin index add05a02..a680183a 100755 --- a/contrib/freemobile-munin +++ b/contrib/freemobile-munin @@ -1,32 +1,39 @@ #!/usr/bin/env perl # -*- perl -*- =head1 NAME + freemobile - A plugin to monitor a freemobile subscription -=head1 Installation +=head1 INSTALLATION -Create a link to this script in /etc/munin/plugins/ +Create a link to this script in /etc/munin/plugins/ : +$ ln -s /path/to/freemobile-munin /etc/munin/plugins/freemobile -I - F<$HOME/.config/weboob/munin/> =head1 CONFIGURATION -You need to configure the user and the home PATH like that: +You need to configure the plugin like that: [freemobile] - env.HOME /home/florent user florent - group florent + env.HOME /home/florent + env.freemonitored voice sms mms data specialvoice + env.cache_expire 3600 + timeout 30 -You can configure the list of monitored data with the line: -C +C I: user with freemobile backend configured -Others monitored options: voicetoint voiceint smsint mmsint dataint - specialvoice +C I: path to user home -The cache timeout is 3 hours by default. You can change this value -with C (seconds). +C (optional): default only 'voice sms' +The full list of monitored options is : + * voice sms mms data specialvoice voicetoint voiceint smsint mmsint dataint + +C (optional): cache interval in second, or time +between two connection to the website. The cache interval is 3 hours by default. + +C (optional): Munin internal option. The plugin can be slow, +30s is recommended. =head1 LICENSE