/[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.7 - (hide annotations) (download) (as text)
Thu Sep 20 18:49:40 2007 UTC (6 years, 6 months ago) by nightmorph
Branch: MAIN
Changes since 1.6: +13 -22 lines
File MIME type: application/xml
updates from bug 186406

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

  ViewVC Help
Powered by ViewVC 1.1.20