1SMOKEPING_INSTALL(7)               SmokePing              SMOKEPING_INSTALL(7)
2
3
4

NAME

6       smokeping_install - How to install SmokePing
7

OVERVIEW

9       This document explains how to setup SmokePing at your site.
10

DESCRIPTION

12   Prerequisites
13       SmokePing does not stand alone. It relies on various other tools and
14       services being present. Apart from a Unix OS and a working Perl
15       installation you need the following components:
16
17       RRDtool 1.2.x or later
18           Smokeping uses RRDtool for logging and graphing. If your linux
19           distro provides an rrdtool  package with perl support, use this. If
20           you want to get the latest and greatest version, compile your own:
21           <http://oss.oetiker.ch/rrdtool/>
22
23           Ubuntu:
24
25            sudo apt install rrdtool librrds-perl libssl-dev
26
27           RedHat:
28
29            sudo yum install rrdtool perl-rrdtool openssl-devel
30
31       FPing (optional)
32           Go to <http://www.fping.org/> to grab a copy.
33
34           Note that fping must be installed setuid root. It seems that older
35           versions of fping report round trip times in 0.1 milliseconds
36           instead of 1 milliseconds as advertised ... SmokePing tries to
37           figure this out. It tells you when it starts ... let me know if it
38           gets it wrong.
39
40       EchoPing  (Optional)
41           <https://github.com/bortzmeyer/echoping/>
42
43           You need this to run the EchoPing probes
44
45       Curl (Optional)
46           <http://curl.haxx.se/>
47
48           You need this for the Curl probe.
49
50       dig (Optional)
51           <http://www.isc.org/sw/bind/>
52
53           You need this for the DNS probe.
54
55       SSH (Optional)
56           <http://www.openssh.org/>
57
58           You need this for the SSH probe.
59
60       Webserver
61           <http://httpd.apache.org/>
62
63           Well I won't get much into this. The important thing is, to have a
64           webserver which allows you to run CGI and preferably FastCGI
65           scripts. If you are using Apache I strongly recommend using the
66           suexec system for running CGI scripts as a particular user.
67
68           See <http://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html> and
69           <http://httpd.apache.org/docs/2.2/mod/mod_suexec.html> for more
70           information on this.
71
72       Perl 5.10.1 or later.
73           If you still have an older version, maybe have a look at perlbrew.
74
75           Ubuntu:
76
77            sudo apt install perl
78
79           RedHat:
80
81            sudo yum install perl-core
82
83   Installation
84       Once the tools listed above are in place, you can start setting up
85       SmokePing itself. Unpack the tar archive and run the included configure
86       script:
87
88        ./configure --prefix=/opt/smokeping
89
90       Configure will verify that all the required perl modules are available.
91       If some are missing it will tell you to run the module build script.
92       Just follow the instructions on screen and then run configure again.
93       Once it completes, you can run
94
95        make install
96
97       to finish your setup.
98
99   Configuration
100       Use the etc/config.dist file as a template to create your own smokeping
101       configuration file.  See smokeping_config for details.
102
103       Installing the webinterface
104           Copy the content of the PREFIX/htdocs directory to the place where
105           your webserver expects its data. Maybe to /var/www/smokeping.
106
107           Edit the smokeping.fcgi script to point to your smokeping_cgi
108           script.
109
110           If you have no FastCGI support in your webserver, you may want to
111           use the smokeping.cgi script.
112
113       etc/basepage.html
114           Edit the html template to your liking. Please do not remove the
115           link to the SmokePing counter and my name from the template.  The
116           content of the template will be rendered by smokeping.cgi.  This
117           means that all embedded links must be relative to smokeping.cgi.
118           If you are using HTTP authentication, then the template variable
119           "authuser" will be populated from the $ENV{REMOTE_USER} environment
120           variable.
121
122       etc/smokemail
123           If you are going to use the DYNAMIC IP support, customize the
124           contents of this file.
125
126   Starting the Smokeping Daemon
127       With all the scaffolding in place, you can now launch the smokeping
128       daemon and have it gather data for you. First you may want to run it in
129       debug mode to see what it is doing
130
131        ./bin/smokeping --config=/opt/smokeping/etc/config --debug
132
133       once all is well, start it up as a daemon. I would recommend you enable
134       the logfile option so that you can see if it runs into trouble.
135
136        ./bin/smokeping --config=/opt/smokeping/etc/config --logfile=smoke.log
137
138       Once the system works, you may want to put a SmokePing startup script
139       into your /etc/init.d tree. Check out smokeping for further
140       information.
141
142       You can now open the smokeping.cgi webpage to look at your data.
143
144       See the smokeping_cgi documentation on how to setup the smokeping web
145       interface.
146
148       Copyright (c) 2001, 2011 by Tobias Oetiker. All right reserved.
149

LICENSE

151       This program is free software; you can redistribute it and/or modify it
152       under the terms of the GNU General Public License as published by the
153       Free Software Foundation; either version 2 of the License, or (at your
154       option) any later version.
155
156       This program is distributed in the hope that it will be useful, but
157       WITHOUT ANY WARRANTY; without even the implied warranty of
158       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
159       General Public License for more details.
160
161       You should have received a copy of the GNU General Public License along
162       with this program; if not, write to the Free Software Foundation, Inc.,
163       675 Mass Ave, Cambridge, MA 02139, USA.
164

AUTHOR

166       Tobias Oetiker <tobi@oetiker.ch>
167
168
169
1702.8.2                             2023-07-22              SMOKEPING_INSTALL(7)
Impressum