Merge pull request #3 from Madlohe/master
[Nagios-Plugin.git] / README
blob3651adf6d706bdbc38f1623b9e14805ea97f69aa
1 ![Nagios!](https://www.nagios.com/wp-content/uploads/2015/05/Nagios-Black-500x124.png)
3 [![Build Status](https://travis-ci.org/nagios-plugins/nagios-plugin-perl.svg?branch=master)](https://travis-ci.org/nagios-plugins/nagios-plugin-perl)
5 Nagios::Monitoring::Plugin
6 ==========================
8 * These modules are meant for perl developers of [Nagios plugins](https://github.com/nagios-plugins/nagios-plugin-perl).
10 * It is meant to simplify a lot of the common functions required to do checking of a particular service.
12 * **The modules are still in an experimental stage and will be considered 
13 stable when it reaches version 1.0.**
15 Installing
16 ----------
18 You may need some prerequisites first. If you're on CentOS/RHEL, make sure to 
19 install CPAN and use those packages, since yum no longer supports some 
20 required packages.   
21 For CentOS 6/7:
23     yum install -y perl-devel cpan make
24     cpan Test::More
25     cpan Params::Validate Math::Calc::Units Class::Accessor::Fast Config::Tiny
27 For Debian 7+/Ubuntu 14.04+:
29     apt-get install make libperl-dev libparams-validate-perl libmath-calc-units-perl libclass-accessor-perl libconfig-tiny-perl
31 For Fedora 25+:
33     dnf install -y make perl-devel 'perl(Params::Validate)' 'perl(Math::Calc::Units)' 'perl(Class::Accessor::Fast)' 'perl(Config::Tiny)' 'perl(Test::More)'
35 To install this module type the following:
37     perl Makefile.PL
38     make
39     make test
40     make install
42 Example
43 -------
45 > Enough talk!  Show me where to start!
47 See the file `check_stuff.pl` in the `t/` directory for a complete 
48 working example of a plugin script.
51 License Notice
52 --------------
54 Copyright (C) 2006-2017 by Nagios Plugin Development Team
56 This library is free software; you can redistribute it and/or modify
57 it under the same terms as Perl itself, either Perl version 5.8.4 or,
58 at your option, any later version of Perl 5 you may have available.