1 |
neysx 06/03/10 22:36:46 |
2 |
|
3 |
Modified: metadoc.xml |
4 |
Added: jffnms.xml |
5 |
Log: |
6 |
#125721 New doc about jffnms |
7 |
|
8 |
Revision Changes Path |
9 |
1.144 xml/htdocs/doc/en/metadoc.xml |
10 |
|
11 |
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.144&content-type=text/x-cvsweb-markup&cvsroot=gentoo |
12 |
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.144&content-type=text/plain&cvsroot=gentoo |
13 |
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml.diff?r1=1.143&r2=1.144&cvsroot=gentoo |
14 |
|
15 |
Index: metadoc.xml |
16 |
=================================================================== |
17 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v |
18 |
retrieving revision 1.143 |
19 |
retrieving revision 1.144 |
20 |
diff -u -r1.143 -r1.144 |
21 |
--- metadoc.xml 6 Mar 2006 16:45:58 -0000 1.143 |
22 |
+++ metadoc.xml 10 Mar 2006 22:36:46 -0000 1.144 |
23 |
@@ -1,9 +1,9 @@ |
24 |
<?xml version='1.0' encoding="UTF-8"?> |
25 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.143 2006/03/06 16:45:58 neysx Exp $ --> |
26 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.144 2006/03/10 22:36:46 neysx Exp $ --> |
27 |
<!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd"> |
28 |
|
29 |
<metadoc lang="en"> |
30 |
-<version>1.71</version> |
31 |
+<version>1.72</version> |
32 |
<members> |
33 |
<lead>neysx</lead> |
34 |
<member>fox2mike</member> |
35 |
@@ -386,6 +386,7 @@ |
36 |
<file id="gcc-upgrading">/doc/en/gcc-upgrading.xml</file> |
37 |
<file id="x86-at-faq">/proj/en/base/x86/arch-testers-faq.xml</file> |
38 |
<file id="php-upgrade">/proj/en/php/php-upgrading.xml</file> |
39 |
+ <file id="jffnms">/doc/en/jffnms.xml</file> |
40 |
</files> |
41 |
<docs> |
42 |
<doc id="name-logo"> |
43 |
@@ -1239,5 +1240,9 @@ |
44 |
<memberof>upgrade</memberof> |
45 |
<fileid>php-upgrade</fileid> |
46 |
</doc> |
47 |
+ <doc id="jffnms"> |
48 |
+ <memberof>sysadmin_specific</memberof> |
49 |
+ <fileid>jffnms</fileid> |
50 |
+ </doc> |
51 |
</docs> |
52 |
</metadoc> |
53 |
|
54 |
|
55 |
|
56 |
1.1 xml/htdocs/doc/en/jffnms.xml |
57 |
|
58 |
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/jffnms.xml?rev=1.1&content-type=text/x-cvsweb-markup&cvsroot=gentoo |
59 |
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/jffnms.xml?rev=1.1&content-type=text/plain&cvsroot=gentoo |
60 |
|
61 |
Index: jffnms.xml |
62 |
=================================================================== |
63 |
<?xml version="1.0" encoding="UTF-8"?> |
64 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
65 |
<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/jffnms.xml,v 1.1 2006/03/10 22:36:46 neysx Exp $ --> |
66 |
|
67 |
<guide link="/doc/en/jffnms.xml" lang="en"> |
68 |
<title>Jffnms Installation and Setup Guide</title> |
69 |
|
70 |
<author title="Author"> |
71 |
<mail link="angusyoung@g.o">Otavio R. Piske</mail> |
72 |
</author> |
73 |
|
74 |
<abstract> |
75 |
This guide shows you how to proceed with the post installation setup of Jffnms, |
76 |
a network management and monitoring system, and how to monitor your systems |
77 |
with it. |
78 |
</abstract> |
79 |
|
80 |
<!-- The content of this document is licensed under the CC-BY-SA license --> |
81 |
<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
82 |
<license/> |
83 |
|
84 |
<version>1.0</version> |
85 |
<date>2006-03-10</date> |
86 |
|
87 |
<chapter> |
88 |
<title>Jffms Basics</title> |
89 |
<section> |
90 |
<title>Introduction</title> |
91 |
<body> |
92 |
|
93 |
<p> |
94 |
<uri link="http://www.jffnms.org">Jffnms</uri> is a network management and |
95 |
monitoring system. It allows you to grab information from many different kinds |
96 |
of hosts and protocols. With this guide, we aim to show you how to get Jffnms |
97 |
properly installed and have your systems monitored by this amazing tool. |
98 |
</p> |
99 |
|
100 |
</body> |
101 |
</section> |
102 |
</chapter> |
103 |
|
104 |
<chapter> |
105 |
<title>Initial Setup</title> |
106 |
<section> |
107 |
<title>Installation</title> |
108 |
<body> |
109 |
|
110 |
<p> |
111 |
Just like any package in Portage, jffnms can be installed with <c>emerge</c>: |
112 |
</p> |
113 |
|
114 |
<pre caption="Installing Jffnms"> |
115 |
# <i>emerge jffnms</i> |
116 |
</pre> |
117 |
|
118 |
<p> |
119 |
Jffnms should be installed in <path>/opt/jffnms/</path>. |
120 |
</p> |
121 |
|
122 |
</body> |
123 |
</section> |
124 |
<section> |
125 |
<title>Configuring Apache 2</title> |
126 |
<body> |
127 |
|
128 |
<warn> |
129 |
This very basic configuration procedure for apache does not cover all aspects |
130 |
of setting up a web server. |
131 |
</warn> |
132 |
|
133 |
<p> |
134 |
Sometimes you will want to run Jffnms on your local computer instead of a |
135 |
remote server. If this is your case, it is very likely that you don't have an |
136 |
apache setup running. Don't worry about installing apache though, Portage has |
137 |
already done that for you. Nevertheless, you still have to configure and test |
138 |
apache, which (luckily) is pretty straightforward. Start by adding apache to |
139 |
your default runlevel: |
140 |
</p> |
141 |
|
142 |
<pre caption="Adding apache 2 to the default runlevel"> |
143 |
# <i>rc-update add apache2 default</i> |
144 |
* apache2 added to runlevel default |
145 |
* rc-update complete. |
146 |
</pre> |
147 |
|
148 |
<p> |
149 |
If you haven't done it yet, it's time to start apache2: |
150 |
</p> |
151 |
|
152 |
<pre caption="Starting apache2"> |
153 |
# <i>/etc/init.d/apache2 start</i> |
154 |
</pre> |
155 |
|
156 |
<p> |
157 |
Finally, point your browser at <uri>http://localhost/</uri> and you should be |
158 |
presented with a home page about your newly installed Apache 2. Now that we |
159 |
know that Apache is up and running, we can proceed to the mod_php |
160 |
configuration. Fire up your favorite text editor, open |
161 |
<path>/etc/conf.d/apache2</path> and add <c>-D PHP4</c> the APACHE2_OPTS |
162 |
variable. |
163 |
</p> |
164 |
|
165 |
<pre caption="Apache 2 Configuration"> |
166 |
# <i>nano -w /etc/conf.d/apache2</i> |
167 |
APACHE2_OPTS="-D DEFAULT_VHOST -D PHP4" |
168 |
</pre> |
169 |
|
170 |
<p> |
171 |
After that, you should create a symlink to the Jffnms install directory in your |
172 |
Apache document root dir. In Gentoo, by default, Apache uses |
173 |
<path>/var/www/localhost/htdocs</path> as document root. So, you should do the |
174 |
following: |
175 |
</p> |
176 |
|
177 |
<pre caption="Creating Jffnms symlink"> |
178 |
# <i>cd /var/www/localhost/htdocs && ln -s /opt/jffnms/htdocs</i> |
179 |
</pre> |
180 |
|
181 |
</body> |
182 |
</section> |
183 |
<section> |
184 |
<title>Configuring PHP</title> |
185 |
<body> |
186 |
|
187 |
<p> |
188 |
Now that apache is running, it is time to configure PHP. Jffnms requires that |
189 |
you set some variables in php.ini in order to run. The php.ini file is usually |
190 |
located in <path>/etc/php/apache2-php4/php.ini</path>. You have to set these |
191 |
variables to the following values: |
192 |
</p> |
193 |
|
194 |
<pre caption="Configuring PHP"> |
195 |
# <i>nano -w /etc/php/apache2-php4/php.ini</i> |
196 |
register_globals = On |
197 |
register_argc_argv = On |
198 |
error_reporting = E_ALL & ~E_NOTICE |
199 |
allow_url_fopen = On |
200 |
include_path = ".:/usr/share/php4:/usr/share/php:/usr/share/php/PEAR" |
201 |
short_open_tag = On |
202 |
</pre> |
203 |
|
204 |
</body> |
205 |
</section> |
206 |
<section> |
207 |
<title>Database setup</title> |
208 |
<body> |
209 |
|
210 |
<warn> |
211 |
Please note again that this a very basic configuration procedure for any |
212 |
database system and does not cover all aspects of setting up such systems. |
213 |
</warn> |
214 |
|
215 |
<p> |
216 |
Jffnms allows you to use either PostgreSQL or MySQL as its database. Here we'll |
217 |
show you how to create the database and necessary tables where Jffnms will |
218 |
store its data. It's important to note that it isn't necessary to have a |
219 |
database running localy to run Jffnms and except for the fact that you need to |
220 |
run this commands on the remote host, the procedure is the same. |
221 |
</p> |
222 |
|
223 |
</body> |
224 |
</section> |
225 |
<section> |
226 |
<title>Setting Up PostgreSQL</title> |
227 |
<body> |
228 |
|
229 |
<note> |
230 |
If you already have a PostgreSQL database up and running, you can proceed to |
231 |
the <uri link="#use-pg">next section</uri>. |
232 |
</note> |
233 |
|
234 |
<p> |
235 |
You should add PostgreSQL to your default runlevel so it's started each time |
236 |
you boot your computer. |
237 |
</p> |
238 |
|
239 |
<pre caption="Adding PostgreSQL to the default runlevel"> |
240 |
# <i>rc-update add postgresql default</i> |
241 |
* postgresql added to runlevel default |
242 |
* rc-update complete. |
243 |
</pre> |
244 |
|
245 |
<p> |
246 |
Now, you must prepare PostgreSQL directories. This is done through the |
247 |
<c>initdb</c> command. By default, PostgreSQL data directories are generally |
248 |
stored in <path>/var/lib/postgresql/data</path>. |
249 |
</p> |
250 |
|
251 |
<impo> |
252 |
The following command must be run with your PostgreSQL user. By default this |
253 |
user is generally called "postgres". |
254 |
</impo> |
255 |
|
256 |
<pre caption="Preparing PostgreSQL Directories"> |
257 |
# <i>su - postgres</i> |
258 |
$ <i>initdb -D /var/lib/postgresql/data</i> |
259 |
The files belonging to this database system will be owned by user "postgres". |
260 |
This user must also own the server process. |
261 |
|
262 |
The database cluster will be initialized with locale C. |
263 |
|
264 |
creating directory /var/lib/postgresql/data ... ok |
265 |
creating directory /var/lib/postgresql/data/global ... ok |
266 |
creating directory /var/lib/postgresql/data/pg_xlog ... ok |
267 |
creating directory /var/lib/postgresql/data/pg_xlog/archive_status ... ok |
268 |
creating directory /var/lib/postgresql/data/pg_clog ... ok |
269 |
creating directory /var/lib/postgresql/data/pg_subtrans ... ok |
270 |
creating directory /var/lib/postgresql/data/base ... ok |
271 |
creating directory /var/lib/postgresql/data/base/1 ... ok |
272 |
creating directory /var/lib/postgresql/data/pg_tblspc ... ok |
273 |
selecting default max_connections ... 100 |
274 |
selecting default shared_buffers ... 1000 |
275 |
creating configuration files ... ok |
276 |
creating template1 database in /var/lib/postgresql/data/base/1 ... ok |
277 |
initializing pg_shadow ... ok |
278 |
enabling unlimited row size for system tables ... ok |
279 |
initializing pg_depend ... ok |
280 |
creating system views ... ok |
281 |
loading pg_description ... ok |
282 |
creating conversions ... ok |
283 |
setting privileges on built-in objects ... ok |
284 |
creating information schema ... ok |
285 |
vacuuming database template1 ... ok |
286 |
copying template1 to template0 ... ok |
287 |
|
288 |
WARNING: enabling "trust" authentication for local connections |
289 |
You can change this by editing pg_hba.conf or using the -A option the |
290 |
next time you run initdb. |
291 |
|
292 |
Success. You can now start the database server using: |
293 |
|
294 |
postmaster -D /var/lib/postgresql/data |
295 |
or |
296 |
pg_ctl -D /var/lib/postgresql/data -l logfile start |
297 |
</pre> |
298 |
|
299 |
<p> |
300 |
If initdb was successfully executed, you can go back to your root user and |
301 |
start PostgreSQL. |
302 |
</p> |
303 |
|
304 |
<pre caption="Starting PostgreSQL"> |
305 |
# <i>/etc/init.d/postgresql start</i> |
306 |
</pre> |
307 |
|
308 |
</body> |
309 |
</section> |
310 |
<section id="use-pg"> |
311 |
<title>Using PostgreSQL as database</title> |
312 |
<body> |
313 |
|
314 |
<p> |
315 |
Once you have your PostgreSQL set up and running, you have to create a Jffnms |
316 |
user and a database to store host data. We provide files to do both. |
317 |
</p> |
318 |
|
319 |
<note> |
320 |
If you don't use <path>/usr/portage</path> as your portage dir ($PORTDIR) you |
321 |
have to change the last part of these commands to whatever your portage dir |
322 |
is. |
323 |
</note> |
324 |
|
325 |
<pre caption="Creating Jffnms user"> |
326 |
# <i>psql template1 postgres < /usr/portage/net-analyzer/jffnms/files/postgresql_db</i> |
327 |
</pre> |
328 |
|
329 |
<pre caption="Creating Jffnms database"> |
330 |
# <i>psql template1 postgres < /usr/portage/net-analyzer/jffnms/files/postgresql_db_tables</i> |
331 |
</pre> |
332 |
|
333 |
<p> |
334 |
Finally, you need to create all the tables where data will be stored: |
335 |
</p> |
336 |
|
337 |
<pre caption="Creating Jffnms database"> |
338 |
# <i>psql jffnms jffnms < /opt/jffnms/docs/jffnms-0.8.2.pgsql</i> |
339 |
</pre> |
340 |
|
341 |
<p> |
342 |
Once you have run those steps, PostgreSQL database configuration for Jffnms |
343 |
should be ok. |
344 |
</p> |
345 |
|
346 |
</body> |
347 |
</section> |
348 |
<section> |
349 |
<title>Using MySQL as database.</title> |
350 |
<body> |
351 |
|
352 |
<warn> |
353 |
Installing and configuring a MySQL database is not covered in this guide. |
354 |
Please see our <uri link="/doc/en/mysql-howto.xml">MySQL Startup Guide</uri>. |
355 |
</warn> |
356 |
|
357 |
<p> |
358 |
In case you want to run Jffnms with MySQL, the process is a bit simpler. We |
359 |
provide two files to create database, user and tables for MySQL. |
360 |
</p> |
361 |
|
362 |
<note> |
363 |
If you don't use <path>/usr/portage</path> as your portage dir ($PORTDIR) you |
364 |
have to change the last part of these commands to whatever your portage dir |
365 |
is. |
366 |
</note> |
367 |
|
368 |
<pre caption="Create a database and a mysql user."> |
369 |
# <i>mysql -u <comment>username</comment> -p <comment>password</comment> < /usr/portage/net-analyzer/jffnms/files/mysql_db</i> |
370 |
</pre> |
371 |
|
372 |
<pre caption="Create a mysql tables."> |
373 |
# <i>mysql -u jffnms -pjffnms jffnms < /opt/jffnms/docs/docs/jffnms-0.8.2.mysql</i> |
374 |
</pre> |
375 |
|
376 |
</body> |
377 |
</section> |
378 |
<section> |
379 |
<title>UDP Port Monitoring and discovery</title> |
380 |
<body> |
381 |
|
382 |
<warn> |
383 |
This section covers setting up and running suid programs, so it may not be |
384 |
adequate for systems where security is too much an issue. |
385 |
</warn> |
386 |
|
387 |
<p> |
388 |
If you want UDP port monitoring and discovery, you need to set <c>nmap</c> and |
389 |
<c>fping</c> as a SUID programns. This may give you security hole in case |
390 |
there's a bug in one of them. To set them as a SUID you can run the following |
391 |
commands: |
392 |
</p> |
393 |
|
394 |
<pre caption="Setting up udp port monitoring and discovery"> |
395 |
# <i>chmod +s /usr/bin/nmap ; chmod a+x /usr/bin/nmap</i> |
396 |
# <i>chmod +s /usr/sbin/fping ; chmod a+x /usr/sbin/fping</i> |
397 |
</pre> |
398 |
|
399 |
</body> |
400 |
</section> |
401 |
</chapter> |
402 |
|
403 |
<chapter> |
404 |
<title>Configuring Jffnms</title> |
405 |
<section> |
406 |
<title>Configuring the poller process</title> |
407 |
<body> |
408 |
|
409 |
<p> |
410 |
The poller process is responsible for gathering data from hosts. In order to |
411 |
collect this data at regular intervals, it must be added to crontab. |
412 |
</p> |
413 |
|
414 |
<pre caption="Setting up udp port monitoring and discovery"> |
415 |
# <i>crontab -u jffnms /opt/jffnms/docs/unix/crontab</i> |
416 |
# <i>crontab -e -u jffnms</i> |
417 |
</pre> |
418 |
|
419 |
</body> |
420 |
</section> |
421 |
</chapter> |
422 |
|
423 |
<chapter> |
424 |
<title>Support</title> |
425 |
<section> |
426 |
<title>Support</title> |
427 |
<body> |
428 |
|
429 |
<p> |
430 |
Though Jffnms is a wonderful software, it is a bit hard to get it up and |
431 |
running. So if you run into problems with Jffnms, there are some places where |
432 |
you can look for help: |
433 |
</p> |
434 |
|
435 |
<ul> |
436 |
<li> |
437 |
<uri link="http://www.jffnms.org/docs/installing.html">Jffnms Installation |
438 |
Manual</uri> |
439 |
</li> |
440 |
<li> |
441 |
<uri link="http://www.jffnms.org/docs/jffnms.html">Jffnms Manual</uri> |
442 |
</li> |
443 |
<li><uri link="http://forums.gentoo.org">Gentoo Forums</uri></li> |
444 |
</ul> |
445 |
|
446 |
<p> |
447 |
You may also run into problems when configuring Apache to work with PHP |
448 |
(specially if you run both PHP4 and PHP5 on the same system). In that case, our |
449 |
<uri link="/proj/en/php/php4-php5-configuration.xml">Configuring Apache to Work |
450 |
with PHP4 and PHP5</uri> guide may give you some help. |
451 |
</p> |
452 |
|
453 |
</body> |
454 |
</section> |
455 |
</chapter> |
456 |
</guide> |
457 |
|
458 |
|
459 |
|
460 |
-- |
461 |
gentoo-doc-cvs@g.o mailing list |