1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
=cut
TITLE=The Configuration Directory
DESCRIPTION=the new remstats configdir
KEYWORDS=configuration,configdir
DOCTOP=index
DOCPREV=install
DOCNEXT=configfile-general
SECTION=The Configuration Directory
=pod
=head1 The Configuration Directory
The run-time configuration of remstats is done through a directory-tree of files.
The current tree structure is:
configdir
+--- L<alerts|configfile-alerts>
+--- L<alert-destination-map|configfile-alert-destination-map>
+--- L<alert-template-map|configfile-alert-template-map>
+--- L<alert-templates|configfile-alert-templates>
| +--- template1
| +--- template2
| ...
+--- L<archives|configfile-archives>
+--- L<availability|configfile-availability>
+--- L<colors|configfile-colors>
+--- L<customgraphs|configfile-customgraphs>
| +--- graph1
| +--- graph2
| ...
+--- L<datapages|datapage-cgi>
| +--- datapage1.page
| +--- datapage2.page
| ...
+--- L<general|configfile-general>
+--- L<groups|configfile-groups>
+--- L<hosts|configfile-hosts>
| +--- host1
| +--- host2
| ...
+--- L<host-templates|configfile-host-templates>
| +--- host-template1
| +--- host-template2
| ...
+--- L<html|configfile-html>
+--- L<links|configfile-links>
+--- L<oids|configfile-oids>
+--- L<remotepings|configfile-remotepings>
+--- L<rrds|configfile-rrds>
| +--- rrd1
| +--- rrd2
| ...
+--- L<scripts|configfile-scripts>
| +--- script1
| +--- script2
| ...
+--- L<times|configfile-times>
+--- L<tools|configfile-tools>
+--- L<views|configfile-views>
| +--- view1
| +--- view1
| ...
+--- L<view-templates|configfile-view-templates>
+--- template1
+--- template2
...
(You can look at the base configuration directory if
you want, but you should also read through this so you know the
significance of what you see.
Almost all the configuration files allow both blank lines and comment-lines.
A comment-line B<begins> with a B<#> and the whole line is ignored by
remstats. Inline comments are B<not> permitted as the 'B<#>' is used
in some places for other purposes. The only files which don't permit comments
are the C<view-templates>, which are html, and the last part of C<datapages>,
which are also html.
C<alert-templates>, C<customgraphs>, C<datapages>, C<scripts>, C<rrds>, C<hosts>,
C<host-templates>, C<views> and
C<view-templates> are sub-directories with the files within describing one
of that kind of entity. E.G. a file in the C<hosts> sub-directory is
named for the host and contains that host's configuration.
B<NOTE>: within the sub-directories, files with names beginning with 'IGNORE-'
or ending with '~', will be ignored.
There are also a few L<tools|config-tools> to help
you make and update your config-file, although not all parts of it.
|
