File: configfile-html.pod

package info (click to toggle)
remstats 1.00a4-8woody1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,576 kB
  • ctags: 1,020
  • sloc: perl: 11,706; ansic: 2,776; makefile: 944; sh: 869
file content (161 lines) | stat: -rw-r--r-- 4,075 bytes parent folder | download
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
=cut

TITLE=Configuration - HTML
DESCRIPTION=define the static text for the web-pages
KEYWORDS=configuration,html
DOCTOP=index
DOCPREV=configfile-host-templates
DOCNEXT=configfile-links

=pod

=head1 Configuration - HTML

The C<html> file defines stuff related to web-page generation.  There
are several different kinds of information.

=head2 Locations

These things define where things are, like URLS.  They are:

=over 4

=item C<htmldir> (REQUIRED) - 
The html stuff for a given host is stored under C<htmldir/hostname>.

=item C<htmlurl> (REQUIRED) -
How to refer to the C<htmldir> in a URL.

=item C<viewdir> -
Where to store the views, in case you don't want them under the C<htmldir>.

=item C<viewurl> -
How to refer to the C<viewdir> in a URL.

=item C<webmaster> (REQUIRED) -
Who's in charge of these web-pages, an email address to get stuffed into
mailto URLs.

=item C<logourl> -
Where is the logo for this site

=item C<homeurl> - 
ehere is home for this site

=item C<topurl> -
where top goes for this site

=item C<rrdcgi> -
where to find the rrdcgi program, I like to link it and rrdtool into 
C</usr/local/bin>, for ease of use.

=item C<motdfile> -
where to find the Message-Of-The-Day file.  This is used to add in 
announcements at the top of the index pages, except the host index.

=back 4

=head2 "How-To's"

=over 4

=item C<thumbnail> -
How big the graph portion of a thumbnail image is to be (WIDTHxHEIGHT)

=item C<metadata> -
Where to store CERN-style meta-data, to set expiry times for the gifs.
(METADIR METASUFFIX)

=item C<background> -
what should the background look like.  It's mostly obsolete, because 
you can get the most of the same effects by editing the C<default.css> 
style file instead.

=item C<htmlrefresh> - 
How often to cause the web pages to refresh themselves. (seconds)

=item C<upstatus>, C<upunstablestatus>, C<downunstablestatus>, C<downstatus>, 
C<okstatus>, C<warnstatus>, C<errorstatus>, C<criticalstatus> - 
HTML to display for various statuses.  The defaults use <span style="xxx"> tags.

=item C<viewindices> -
Should L<view-writer> write the index links at the top of view pages? 
(yes or no)

=item C<showinterfaces> -
Should L<graph-writer> show interfaces on a host page?
(yes or no)

=item C<keepimages> -
How long L<cleanup> will permit old images to hang around, in seconds.

=item C<default-tools> -
What tools to show for a host which doesn't specify any.

=back 4

=head2 Markers

This group supplies html to wrap various things in the generated web-pages.

=over 4

=item indexprefix, indexsuffix - for the items on the C<Indices> line
of the header

=item groupprefix, groupsuffix - for the group names on the various indices

=item hostprefix, hostsuffix - for the host names on the various indices

=item toolprefix, toolsuffix - for the tool names on the toolbar

=item linkprefix, linksuffix - for the links in the footer

=item outofrangeprefix, outofrangesuffix - for the current value on the
availability pages when it has gone outside the specified bounds.  (See
L<availability-report>.)

=back 4

=head2 Labels

If you translate the labels, the web-pages should be translated.  It
doesn't include error-messages or debugging messages.

The currently available ones, with their defaults, are:

	alertreport	Alert Report
	comment		Comment
	contact		Contact
	customindex	Custom Index
	description	Description
	groupindex	Group Index
	hardware	Hardware
	hostindex	Host Index
	indices		Indices
	ipnumber	IP #
	lastupdateon	This page last updated on
	links		Links
	logreport	Log Report
	operatingsystem	Operating System
	overallindex	Overall Index
	pingindex	Ping Index
	quickindex	Quick Index
	status		Status
	tools		Tools
	uptime		Uptime
	viewindex	View Index

And also the:

=over 4

=item C<uptimeflag> - shows on some index pages when a host has
been up for less than C<mintime> (defined in the 
L<general|configfile-general> file.)

=item C<alertflagwarn>, C<alertflagerror> and C<alertflagcritical> - 
give HTML to be inserted in the quick index for hosts which have
alerts active.

=back 4