=head1 NAME

smokeping_install - How to install SmokePing

=head1 OVERVIEW

This document explains how to setup SmokePing at your site.

=head1 DESCRIPTION

=head2 Prerequisites

SmokePing does not stand alone. It relies on various other tools and
services being present. Apart from a Unix OS and a working Perl installation
you need the following things. The list contains the names of the tools
together with the version of the tool which I am using, and a link for
downloading the tool.

=over

=item RRDtool 1.2.x or later

Smokeping uses RRDtool for logging and graphing. If you linux distro provides
an rrdtool  package with perl support, use this. If you want to get the latest
and greates version, compile your own: L<http://oss.oetiker.ch/rrdtool/>

=item FPing 

The official site L<http://fping.sourceforge.net/> seems to be a bit
unmaintained. You might want to grab an updated version of fping from
L<http://oss.oetiker.ch/smokeping/pub/>. 

Note that fping must be installed setuid root. It seems that older versions
of fping report round trip times in 0.1 milliseconds instead of 1 milliseconds
as advertised ... SmokePing tries to figure this out. It tells
you when it starts ... let me know it it gets it wrong.

=item EchoPing  (Optional)

L<http://echoping.sourceforge.net/>

You need this to run the EchoPing probes

=item Curl (Optional)

L<http://curl.haxx.se/>

You need this for the Curl probe.

=item dig (Optional)

L<http://www.isc.org/sw/bind/>

You need this for the DNS probe.

=item SSH (Optional)

L<http://www.openssh.org/>

You need this for the SSH probe.

=item Webserver 

L<http://httpd.apache.org/>

Well I wont get much into this. The important thing is, to have a webserver
which allows you to run CGI and preferably FastCGI scripts. If you are using
Apache I strongly recommend using the F<suexec> system for running CGI
scripts as a particular user.

See L<http://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html> and
L<http://httpd.apache.org/docs/2.2/mod/mod_suexec.html> for more information
on this.

=item Perl 5.8.8 or later.

If you still have an older version, maybe have a look at perlbrew.

=item Various Perl modules (Many are optional)

They are all from L<http://www.cpan.org> and you may be able to get them as
packages from your distro, but there is also a script provided in the setup
folder of this package which will install all the missing modules in a
thirdparty directory into your smokeping installation. So, if you don't have
them yet, look further down.

=over

=item FCGI

The module for supporting FastCGI operation.

=item CGI, CGI::Fast

Perl CGI/FastCGI support. Might already be installed localy.

=item Config::Grammar

The configuration file parser used in smokeping

=item LWP

The master/slave functionality introduced a dependency LWP::UserAgent
from the libwww-perl (also known as LWP) library. Currently the module
is needed even if the master/slave mode is not enabled.

=item Socket6 (optional)

Optionally installing the Socket6 module for perl enables
smokeping to check hostnames that only resolve to an IPv6
address. If you probe such hosts using ie. the FPing6 probe
and get warnings that those hosts don't resolve to an IP
address, you need to install it.

=item Net::Telnet (optional)

You need this for the TelnetIOSPing probe.

=item Net::OpenSSH (optional)

You need this for the OpenSSHJunOSPing probe.

=item Net::DNS (optional)

You need this for the AnotherDNS probe.

=item Net::LDAP (optional)

You need this for the LDAP probe.

=item IO::Socket::SSL (optional)

You need this if you want the LDAP probe to be able to use the 'starttls' command.

=item Authen::Radius (optional)

You need this for the Radius probe.

=back

=back

=head2 Installation

Once the tools listed above are in place, you can start setting up SmokePing
itself. Once the SmokePing tar archive is unpacked, it is more of less ready
to use. At least to the extent, that it is not necessary to B<install> them.

You may want to move and rename the directory so that it does not contain the
version number of SmokePing, or at least make a symlink, so that you can use
a persistent name when referring to SmokePing files.

Once all is in place, you get to plug everyting together:

=over

=item Building missing perl modules

To make sure all the necessary perl modules are available, use the script in the F<setup/> directory:

 cd setup
 ./build-perl-modules.sh

=item Configure Smokeping

Use the F<etc/config.dist> file as a template to create your own smokeping configuration file.
See L<smokeping_config> for details.

=item Installing the webinterface

Copy the content of the F<htdocs/> directory to the place where your webserver
expects its data. Maybe to F</var/www/smokeping>.

Edit the F<smokeping.fcgi> script to point to your smokeping installation.

If you have no FastCGI support in your webserver, you may want to rename the script
to F<smokeping.cgi>.


=item F<etc/basepage.html>

Edit the html template to your likings. Please do not remove the link to the
SmokePing counter and my name from the template. The content of the template
will be renderd by the smokeping.cgi. This means that all embeded links must
be relative to smokeping.cgi.

=item F<etc/smokemail>

If you are going to use the B<DYNAMIC> IP support, customize the contents of this file.

=back

=head2 Starting the Smokeping Daemon

With all the scaffolding in place, you can now launch the smokeping daemon and send
have it gather data for you. First you may want to run it in debug mode to see what
it is doing

 ./bin/smokeping --config=/opt/smokeping/etc/config --debug

once all is well, start it up as a deamon. I would recomend to enable the logfile
option so that you can see if it runs into trouble.

 ./bin/smokeping --config=/opt/smokeping/etc/config --logfile=smoke.log

Once the system works, you may want to put a SmokePing startup script into
your F</etc/init.d> tree. Check out L<smokeping> for further information.

When you can now also open the smokeping.cgi webpage to look at your data.

=head1 COPYRIGHT

Copyright (c) 2001, 2011 by Tobias Oetiker. All right reserved.

=head1 LICENSE

This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the GNU General Public License for more
details.

You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
02139, USA.

=head1 AUTHOR

Tobias Oetiker E<lt>tobi@oetiker.chE<gt>

=cut