Skip to content

Commit 82fc7c7

Browse files
author
Ethan Galstad
committed
Doc fixes, sample config file cleanup
git-svn-id: https://nagios.svn.sourceforge.net/svnroot/nagios/nagioscore/trunk@506 5f96b256-904b-4d8d-8c98-d829582c6739
1 parent 2f3e261 commit 82fc7c7

15 files changed

+592
-702
lines changed

‎configure

+2-9
Original file line numberDiff line numberDiff line change
@@ -3785,17 +3785,10 @@ perl subst sample-config/cgi.cfg
37853785
perl subst sample-config/resource.cfg
37863786
perl subst sample-config/httpd.conf
37873787
3788-
perl subst sample-config/template-object/hosts.cfg
3789-
perl subst sample-config/template-object/hostgroups.cfg
3790-
perl subst sample-config/template-object/services.cfg
3791-
perl subst sample-config/template-object/contacts.cfg
3792-
perl subst sample-config/template-object/contactgroups.cfg
3793-
perl subst sample-config/template-object/timeperiods.cfg
3794-
perl subst sample-config/template-object/escalations.cfg
3795-
perl subst sample-config/template-object/dependencies.cfg
3788+
perl subst sample-config/template-object/minimal.cfg
3789+
perl subst sample-config/template-object/bigger.cfg
37963790
perl subst sample-config/template-object/checkcommands.cfg
37973791
perl subst sample-config/template-object/misccommands.cfg
3798-
perl subst sample-config/template-object/minimal.cfg
37993792
38003793
38013794

‎configure.in

+2-9
Original file line numberDiff line numberDiff line change
@@ -656,17 +656,10 @@ perl subst sample-config/cgi.cfg
656656
perl subst sample-config/resource.cfg
657657
perl subst sample-config/httpd.conf
658658

659-
perl subst sample-config/template-object/hosts.cfg
660-
perl subst sample-config/template-object/hostgroups.cfg
661-
perl subst sample-config/template-object/services.cfg
662-
perl subst sample-config/template-object/contacts.cfg
663-
perl subst sample-config/template-object/contactgroups.cfg
664-
perl subst sample-config/template-object/timeperiods.cfg
665-
perl subst sample-config/template-object/escalations.cfg
666-
perl subst sample-config/template-object/dependencies.cfg
659+
perl subst sample-config/template-object/minimal.cfg
660+
perl subst sample-config/template-object/bigger.cfg
667661
perl subst sample-config/template-object/checkcommands.cfg
668662
perl subst sample-config/template-object/misccommands.cfg
669-
perl subst sample-config/template-object/minimal.cfg
670663

671664

672665

‎html/docs/extcommands.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ <h2 class="PageTitle">External Commands</h2>
292292
<tr>
293293
<td valign=top><font size=-1>STOP_EXECUTING_SVC_CHECKS</font></td>
294294
<td valign=top><font size=-1></font></td>
295-
<td valign=top><font size=-1>This is used to stop the execution of service checks. When service checks are not being executed, Nagios will not keep requeuing checks for a later time, but will not actually execute any checks. This essentially puts Nagios into a "sleep" mode, as far as monitoring is concerned. Most often used when implementing <a href="redundancy.html">redundant monitoring hosts</a>.</td>
295+
<td valign=top><font size=-1>This is used to stop the execution of service checks. When service checks are not being executed, Nagios will keep requeuing checks for a later time, but will not actually execute any checks. This essentially puts Nagios into a "sleep" mode, as far as monitoring is concerned. Most often used when implementing <a href="redundancy.html">redundant monitoring hosts</a>.</td>
296296
</tr>
297297

298298
<tr>

‎html/docs/installweb.html

+9-6
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,19 @@ <h2 class="PageTitle">Setting Up The Web Interface</h2>
3131
In these instructions I will assume that you are running the <a href="http://www.apache.org">Apache</a> web server on your machine. If you are using some other web server, you'll have to make changes where appropriate. I am also assuming that you used the <i>/usr/local/nagios</i> as the installation prefix.
3232
</p>
3333

34+
<p>
35+
<strong><u>Sample Configuration</u></strong>
36+
</p>
37+
<p>
38+
A sample Apache config file snippet is created when you run the configure script - you can find the sample config file (named <i>httpd.conf</i>) in the <i>sample-config/</i> subdirectory of the Nagios distribution. You will need to add the contents of this file to your Apache configuration files before you can access the Nagios web interface. The instruction found below detail how to manually add the appropriate configuration entries to Apache.
39+
</p>
40+
3441
<p>
3542
<strong><u>Configure Script Alias For The CGIs</u></strong>
3643
</p>
3744

3845
<p>
39-
You'll need to create an alias for the CGIs as well. The default installation expects to find them accessible at <b>http://yourmachine/nagios/cgi-bin/</b>, although this can be changed using the <b>--with-cgiurl</b> option in the configure script. Anyway, add something like the following to your web server configuration file (i.e. <b>httpd.conf</b>) (changing it to match any directory differences on your system)...
46+
First you'll need to create an alias for the CGIs. The default installation expects to find them accessible at <b>http://yourmachine/nagios/cgi-bin/</b>, although this can be changed using the <b>--with-cgiurl</b> option in the configure script. Anyway, add something like the following to your web server configuration file (i.e. <b>httpd.conf</b>) (changing it to match any directory differences on your system)...
4047
</p>
4148

4249
<pre>
@@ -67,11 +74,7 @@ <h2 class="PageTitle">Setting Up The Web Interface</h2>
6774
</p>
6875

6976
<p>
70-
In order to make the HTML files accessible via the web server, you'll have to edit your Apache configuration file as follows...
71-
</p>
72-
73-
<p>
74-
Add the following to your web server configuration file (i.e. <b>httpd.conf</b>) as follows:
77+
Next you'll need to make the HTML files accessible via the web server. Add the following entries to your web server configuration file (i.e. <b>httpd.conf</b>):
7578
</p>
7679

7780
<pre>

‎html/docs/xodtemplate.html

+8-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,14 @@ <h2 class="PageTitle">Template-Based Object Configuration</h2>
7878
</p>
7979

8080
<p>
81-
<strong><u>Index</u></strong>
81+
<strong><u>Sample Configuration</u></strong>
82+
</p>
83+
<p>
84+
A few sample object configuration files are created when you run the configure script - you can find them in the <i>sample-config/template-object/</i> subdirectory of the Nagios distribution.
85+
</p>
86+
87+
<p>
88+
<strong><u>Object Types</u></strong>
8289
</p>
8390
<p>
8491
<a href="#host">Host definitions</a><br>

‎sample-config/README

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
====================
2-
SAMPLE CONFIG README
3-
====================
1+
=========================
2+
SAMPLE CONFIG FILE README
3+
=========================
44

55
This directory contains *sample* configuration files for Nagios.
66
You should read the HTML documentation for information on
@@ -18,13 +18,15 @@ cgi.cfg - This is a sample CGI config file
1818

1919
nagios.cfg - This is a sample main config file
2020

21-
resource.cfg - This is a sample resource config file, used
22-
for definining custom macros, storing
23-
sensitive data, etc.
21+
resource.cfg - This is a sample resource config file, used for definining
22+
custom macros, storing sensitive data, etc.
23+
24+
httpd.conf - This file contains sample snippets that you'll need to
25+
include in your Apache web server config file if you want
26+
to use the web interface.
27+
28+
template-object/ - This directory contains sample object config files. You'll
29+
need to define object config files like these before you can
30+
actually start to monitor anything.
2431

25-
template-object/ - This directory contains sample object config
26-
files. A minimalistic config file called
27-
minimal.cfg is a barebones example of a config
28-
file that might be easy for new users to
29-
understand.
3032

‎sample-config/template-object/README

+23-18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
====================
2-
SAMPLE CONFIG README
3-
====================
1+
================================
2+
SAMPLE OBJECT CONFIG FILE README
3+
================================
44

55
This directory contains sample object definition config files for
66
use with the TEMPLATE-BASED object configuration file format. This is
@@ -12,26 +12,31 @@ config files.
1212

1313
Please note that you can keep all of your object definitions in a
1414
single file if you wish. You may also split them up into multiple
15-
config files, as is done here (for clarity). Read the HTML docs
16-
for information on how to include multiple object config files.
15+
config files, as is done here. Read the HTML docs for information
16+
on how to include multiple object config files.
1717

1818

19-
NOTE:
2019

21-
A minimalistic config file called minimal.cfg provides a barebones
22-
example of a config file that might be easy for new users to
23-
understand. It contains all types of definitions you need to get
24-
started (hosts, hostgroups, services, command, contacts, etc...)
20+
FILE DESCRIPTIONS:
21+
------------------
2522

23+
minimal.cfg - This is a minimalistic object config file that
24+
should be easier for new users to understand.
25+
It contains all types of object definitions you
26+
need to get started (hosts, services, etc..)
2627

27-
NOTE:
28+
bigger.cfg - A larger object config file than the minimalistic
29+
one provided above. This file shows more detail
30+
one how you can configure objects, etc. The two
31+
command configuration files (described below) are
32+
necessary to complete the definitions found in this
33+
file.
2834

29-
Sample command definitions have been split into two separate files:
35+
misccommands.cfg - This file contains sample notification commands,
36+
performance data commands, etc.
3037

31-
misccommands.cfg - This file contains sample notification
32-
commands, performance data commands, etc.
38+
checkcommands.cfg - This file contains sample command definitions for
39+
host and service checks. These definitions are
40+
highly volatile, as plugin arguments can change
41+
between plugin releases!
3342

34-
checkcommands.cfg - This file contains sample command
35-
definitions for host and service checks.
36-
These definitions are highly volatile, as
37-
plugin arguments can change between releases!

0 commit comments

Comments
 (0)