/[gentoo]/xml/htdocs/doc/en/jffnms.xml
Gentoo

Contents of /xml/htdocs/doc/en/jffnms.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.10 - (show annotations) (download) (as text)
Tue Mar 18 04:38:46 2008 UTC (6 years, 6 months ago) by nightmorph
Branch: MAIN
Changes since 1.9: +16 -20 lines
File MIME type: application/xml
The spelling, grammar, capitalization, punctuation, and various useless things in this doc suck. Fixed.

1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
3 <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/jffnms.xml,v 1.9 2008/03/18 04:30:57 nightmorph Exp $ -->
4
5 <guide link="/doc/en/jffnms.xml" lang="en">
6 <title>Jffnms Installation and Setup Guide</title>
7
8 <author title="Author">
9 <mail link="angusyoung@gentoo.org">Otavio R. Piske</mail>
10 </author>
11
12 <abstract>
13 This guide shows you how to proceed with the post installation setup of Jffnms,
14 a network management and monitoring system, and how to monitor your systems
15 with it.
16 </abstract>
17
18 <!-- The content of this document is licensed under the CC-BY-SA license -->
19 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
20 <license/>
21
22 <version>1.5</version>
23 <date>2008-03-17</date>
24
25 <chapter>
26 <title>Jffnms Basics</title>
27 <section>
28 <title>Introduction</title>
29 <body>
30
31 <p>
32 <uri link="http://www.jffnms.org">Jffnms</uri> is a network management and
33 monitoring system. It allows you to grab information from many different kinds
34 of hosts and protocols. With this guide, we aim to show you how to get Jffnms
35 properly installed and have your systems monitored by this amazing tool.
36 </p>
37
38 </body>
39 </section>
40 </chapter>
41
42 <chapter>
43 <title>Initial Setup</title>
44 <section>
45 <title>Choosing your USE flags</title>
46 <body>
47
48 <p>
49 The Jffnms ebuild has the following USE flags available:
50 </p>
51
52 <table>
53 <tr>
54 <th>USE Flags for Jffnms</th>
55 <th>Description</th>
56 </tr>
57 <tr>
58 <ti><c>mysql</c></ti>
59 <ti>Uses Mysql to store Jffnms data</ti>
60 </tr>
61 <tr>
62 <ti><c>postgres</c></ti>
63 <ti>Uses PostgreSQL to store Jffnms data</ti>
64 </tr>
65 <tr>
66 <ti><c>snmp</c></ti>
67 <ti>
68 Adds support for snmp, which enables jffnms to gather data from other hosts.
69 </ti>
70 </tr>
71 </table>
72
73 </body>
74 </section>
75 <section>
76 <title>USE flags for PHP</title>
77 <body>
78
79 <p>
80 Being written in PHP, Jffnms is heavily dependent on PHP USE flags. In order to
81 install Jffnms successfully, you are required to have your PHP package installed
82 with (at least) the following USE flags:
83 </p>
84
85 <table>
86 <tr>
87 <th>USE Flags for PHP</th>
88 <th>Description</th>
89 </tr>
90 <tr>
91 <ti><c>gd</c></ti>
92 <ti>Adds support for media-libs/gd (to generate graphics on the fly)</ti>
93 </tr>
94 <tr>
95 <ti><c>wddx</c></ti>
96 <ti>Adds support for Web Distributed Data eXchange </ti>
97 </tr>
98 <tr>
99 <ti><c>sockets</c></ti>
100 <ti>Adds support for tcp/ip sockets</ti>
101 </tr>
102 <tr>
103 <ti><c>session</c></ti>
104 <ti>Adds persistent session support</ti>
105 </tr>
106 <tr>
107 <ti><c>spl</c></ti>
108 <ti>Adds support for the Standard PHP Library</ti>
109 </tr>
110 <tr>
111 <ti><c>cli</c></ti>
112 <ti>Enable CLI SAPI</ti>
113 </tr>
114 </table>
115
116 </body>
117 </section>
118 <section>
119 <title>Installation</title>
120 <body>
121
122 <p>
123 Just like any package in Portage, jffnms can be installed with <c>emerge</c>:
124 </p>
125
126 <pre caption="Installing Jffnms">
127 # <i>emerge jffnms</i>
128 </pre>
129
130 <p>
131 Jffnms should be installed in <path>/opt/jffnms/</path>.
132 </p>
133
134 </body>
135 </section>
136 <section>
137 <title>Configuring Apache 2</title>
138 <body>
139
140 <warn>
141 This very basic configuration procedure for Apache does not cover all aspects
142 of setting up a web server.
143 </warn>
144
145 <p>
146 Sometimes you will want to run Jffnms on your local computer instead of a
147 remote server. If this is your case, it is very likely that you don't have an
148 apache setup running. Don't worry about installing apache though, Portage has
149 already done that for you. Nevertheless, you still have to configure and test
150 apache, which (luckily) is pretty straightforward. Start by adding Apache to
151 your default runlevel:
152 </p>
153
154 <pre caption="Adding apache2 to the default runlevel">
155 # <i>rc-update add apache2 default</i>
156 </pre>
157
158 <p>
159 If you haven't done it yet, it's time to start apache2:
160 </p>
161
162 <pre caption="Starting apache2">
163 # <i>/etc/init.d/apache2 start</i>
164 </pre>
165
166 <p>
167 Finally, point your browser at <uri>http://localhost/</uri> and you should be
168 presented with a home page about your newly installed Apache 2. Now that we
169 know that Apache is up and running, we can proceed to the mod_php
170 configuration. Fire up your favorite text editor, open
171 <path>/etc/conf.d/apache2</path> and add <c>-D PHP5</c> the APACHE2_OPTS
172 variable.
173 </p>
174
175 <pre caption="Apache 2 Configuration">
176 # <i>nano -w /etc/conf.d/apache2</i>
177 APACHE2_OPTS="-D DEFAULT_VHOST -D PHP5"
178 </pre>
179
180 <p>
181 After that, you should create a symlink to the Jffnms install directory in your
182 Apache document root dir. In Gentoo, by default, Apache uses
183 <path>/var/www/localhost/htdocs</path> as document root. So, you should do the
184 following:
185 </p>
186
187 <pre caption="Creating Jffnms symlink">
188 # <i>cd /var/www/localhost/htdocs &amp;&amp; ln -s /opt/jffnms/</i>
189 </pre>
190
191 </body>
192 </section>
193 <section>
194 <title>Configuring PHP</title>
195 <body>
196
197 <p>
198 Now that Apache is running, it is time to configure PHP. Jffnms requires that
199 you set some variables in php.ini in order to run. The <path>php.ini</path> file
200 is usually located in <path>/etc/php/apache2-php5/php.ini</path>. You have to
201 set these variables to the following values:
202 </p>
203
204 <pre caption="Configuring PHP">
205 # <i>nano -w /etc/php/apache2-php5/php.ini</i>
206 register_globals = On
207 register_argc_argv = On
208 error_reporting = E_ALL &amp; ~E_NOTICE
209 allow_url_fopen = On
210 include_path = ".:/usr/share/php5:/usr/share/php:/usr/share/php/PEAR"
211 short_open_tag = On
212 </pre>
213
214 </body>
215 </section>
216 <section>
217 <title>Database setup</title>
218 <body>
219
220 <warn>
221 Please note again that this a very basic configuration procedure for any
222 database system and does not cover all aspects of setting up such systems.
223 </warn>
224
225 <p>
226 Jffnms allows you to use either PostgreSQL or MySQL as its database. Here we'll
227 show you how to create the database and necessary tables where Jffnms will
228 store its data. It's important to note that it isn't necessary to have a
229 database running locally to run Jffnms and except for the fact that you need to
230 run this commands on the remote host, the procedure is the same.
231 </p>
232
233 </body>
234 </section>
235 <section>
236 <title>Setting up PostgreSQL</title>
237 <body>
238
239 <note>
240 If you already have a PostgreSQL database up and running, you can proceed to
241 the <uri link="#use-pg">next section</uri>.
242 </note>
243
244 <p>
245 You should add PostgreSQL to your default runlevel so it's started each time
246 you boot your computer.
247 </p>
248
249 <pre caption="Adding PostgreSQL to the default runlevel">
250 # <i>rc-update add postgresql default</i>
251 </pre>
252
253 <p>
254 Now you must setup the PostgreSQL database.
255 </p>
256
257 <pre caption="Preparing PostgreSQL">
258 # <i>emerge --config postgresql</i>
259 </pre>
260
261 <p>
262 Now start PostgreSQL:
263 </p>
264
265 <pre caption="Starting PostgreSQL">
266 # <i>/etc/init.d/postgresql start</i>
267 </pre>
268
269 </body>
270 </section>
271 <section id="use-pg">
272 <title>Using PostgreSQL as database</title>
273 <body>
274
275 <p>
276 Once you have your PostgreSQL set up and running, you have to create a Jffnms
277 user and a database to store host data.
278 </p>
279
280 <pre caption="Creating the Jffnms user and database">
281 # <i>psql template1 postgres</i>
282 template1=# <i>create user jffnms password 'jfnms' createdb;</i>
283 template1=# <i>\connect template1 jffnms</i>
284 template1=# <i>create database jffnms;</i>
285 template1=# <i>\q</i>
286 </pre>
287
288 <p>
289 Finally, you need to create all the tables where data will be stored:
290 </p>
291
292 <pre caption="Creating Jffnms tables">
293 # <i>psql jffnms jffnms &lt; /opt/jffnms/docs/jffnms-0.8.3.pgsql</i>
294 </pre>
295
296 <p>
297 Once you have run those steps, the PostgreSQL database configuration for Jffnms
298 should be ok.
299 </p>
300
301 </body>
302 </section>
303 <section>
304 <title>Using MySQL as database</title>
305 <body>
306
307 <warn>
308 Installing and configuring a MySQL database is not covered in this guide.
309 Please see our <uri link="/doc/en/mysql-howto.xml">MySQL Startup Guide</uri>.
310 </warn>
311
312 <p>
313 In case you want to run Jffnms with MySQL, you'll first need to create a
314 database and a MySQL user. After that, create your MySQL table:
315 </p>
316
317 <pre caption="Create a mysql table.">
318 # <i>mysql -u jffnms -pjffnms jffnms &lt; /opt/jffnms/docs/jffnms-0.8.3.mysql</i>
319 </pre>
320
321 </body>
322 </section>
323 <section>
324 <title>UDP Port Monitoring and discovery</title>
325 <body>
326
327 <warn>
328 This section covers setting up and running suid programs, so it may not be
329 adequate for systems where security is too much an issue.
330 </warn>
331
332 <p>
333 If you want UDP port monitoring and discovery, you need to set <c>nmap</c> and
334 <c>fping</c> as a SUID programs. This may give you security hole in case
335 there's a bug in one of them. To set them as a SUID you can run the following
336 commands:
337 </p>
338
339 <pre caption="Setting up udp port monitoring and discovery">
340 # <i>chmod +s /usr/bin/nmap ; chmod a+x /usr/bin/nmap</i>
341 # <i>chmod +s /usr/sbin/fping ; chmod a+x /usr/sbin/fping</i>
342 </pre>
343
344 </body>
345 </section>
346 </chapter>
347
348 <chapter>
349 <title>Configuring Jffnms</title>
350 <section>
351 <title>Configuring the poller process</title>
352 <body>
353
354 <p>
355 The poller process is responsible for gathering data from hosts. In order to
356 collect this data at regular intervals, it must be added to crontab.
357 </p>
358
359 <pre caption="Collecting data at regular intervals">
360 # <i>crontab -u jffnms /opt/jffnms/docs/unix/crontab</i>
361 # <i>crontab -e -u jffnms</i>
362 </pre>
363
364 </body>
365 </section>
366 <section>
367 <title>Final setup</title>
368 <body>
369
370 <p>
371 By now, Jffnms should be correctly installed on your system. You still need,
372 however, to configure Jffnms. Luckily, Jffnms provides us with an easy to use
373 web page where it's possible to configure access to database, user access as
374 well as check if the current host configuration suffices Jffnms needs. You can
375 access this web interface through the following URL:
376 <uri>http://localhost/jffnms/admin/setup.php</uri>. You can login to your new
377 installation by using the username and password <c>admin</c>. You should visit
378 <uri link="http://www.jffnms.org/">Jffnms's home page</uri> for details on how
379 to properly configure it.
380 </p>
381
382 </body>
383 </section>
384 </chapter>
385
386 <chapter>
387 <title>Support</title>
388 <section>
389 <body>
390
391 <p>
392 Though Jffnms is a wonderful application, it is a bit hard to get it up and
393 running. So if you run into problems with Jffnms, there are some places where
394 you can look for help:
395 </p>
396
397 <ul>
398 <li>
399 <uri link="http://www.jffnms.org/docs/installing.html">Jffnms Installation
400 Manual</uri>
401 </li>
402 <li>
403 <uri link="http://www.jffnms.org/docs/jffnms.html">Jffnms Manual</uri>
404 </li>
405 <li><uri link="http://forums.gentoo.org">Gentoo Forums</uri></li>
406 <li>
407 <uri link="http://www.postgresql.org/docs/8.0/static/index.html">PostgreSQL
408 8 Documentation</uri>
409 </li>
410 <li><uri link="http://dev.mysql.com/doc/">MySQL Documentation</uri></li>
411 </ul>
412
413 </body>
414 </section>
415 </chapter>
416 </guide>

  ViewVC Help
Powered by ViewVC 1.1.20