Change documentation
This commit is contained in:
parent
1356e69ffd
commit
c767e72767
1 changed files with 20 additions and 13 deletions
|
|
@ -1,32 +1,39 @@
|
||||||
#!/usr/bin/env perl
|
#!/usr/bin/env perl
|
||||||
# -*- perl -*-
|
# -*- perl -*-
|
||||||
=head1 NAME
|
=head1 NAME
|
||||||
|
|
||||||
freemobile - A plugin to monitor a freemobile subscription
|
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<You have to manually create the folder:>
|
|
||||||
F<$HOME/.config/weboob/munin/>
|
|
||||||
|
|
||||||
=head1 CONFIGURATION
|
=head1 CONFIGURATION
|
||||||
|
|
||||||
You need to configure the user and the home PATH like that:
|
You need to configure the plugin like that:
|
||||||
|
|
||||||
[freemobile]
|
[freemobile]
|
||||||
env.HOME /home/florent
|
|
||||||
user 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<user> I<required>: user with freemobile backend configured
|
||||||
C<env.freemonitored voice sms mms data>
|
|
||||||
|
|
||||||
Others monitored options: voicetoint voiceint smsint mmsint dataint
|
C<env.HOME> I<required>: path to user home
|
||||||
specialvoice
|
|
||||||
|
|
||||||
The cache timeout is 3 hours by default. You can change this value
|
C<env.freemonitored> (optional): default only 'voice sms'
|
||||||
with C<env.cache_expire 3600> (seconds).
|
The full list of monitored options is :
|
||||||
|
* voice sms mms data specialvoice voicetoint voiceint smsint mmsint dataint
|
||||||
|
|
||||||
|
C<env.cache_expire 3600> (optional): cache interval in second, or time
|
||||||
|
between two connection to the website. The cache interval is 3 hours by default.
|
||||||
|
|
||||||
|
C<timeout 30> (optional): Munin internal option. The plugin can be slow,
|
||||||
|
30s is recommended.
|
||||||
|
|
||||||
=head1 LICENSE
|
=head1 LICENSE
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue