-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path24_web.html
More file actions
586 lines (440 loc) · 26.8 KB
/
24_web.html
File metadata and controls
586 lines (440 loc) · 26.8 KB
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Web interface configuration — RPi-Monitor v2.13-r0</title>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="next" title="Addons configuration" href="25_addons.html" />
<link rel="prev" title="Interactive Configuration Helper" href="23_configuration_helper.html" />
<script src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<script>
(adsbygoogle = window.adsbygoogle || []).push({
google_ad_client: "ca-pub-6853682829194266",
enable_page_level_ads: true
});
</script>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-114314379-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-18642541-8');
</script>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> RPi-Monitor
</a>
<div class="version">
2.13
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="01_features.html">Keys features of RPi-Monitor</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="10_index.html">Getting started</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="20_index.html">Configuration</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="21_daemon.html">Daemon configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="22_extraction.html">Metrics extraction configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="23_configuration_helper.html">Interactive Configuration Helper</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Web interface configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="25_addons.html">Addons configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="26_alert.html">Alert configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="27_configuration_templates.html">Configuration templates</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="30_index.html">Usages</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="40_index.html">To go further</a></li>
</ul>
<hr />
<div style="padding: 0;">
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<ins class="adsbygoogle"
style="display:inline-block;width:300px;height:250px"
data-ad-client="ca-pub-6853682829194266"
data-ad-slot="2876944524"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">RPi-Monitor</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><a href="20_index.html">Configuration</a> »</li>
<li>Web interface configuration</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/XavierBerger/RPi-Monitor/blob/develop/docs/source/24_web.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="web-interface-configuration">
<h1>Web interface configuration<a class="headerlink" href="#web-interface-configuration" title="Permalink to this headline">¶</a></h1>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>The presentation of the information is performed by HTML5 pages. These pages
dynamically download the information extracted from daemon and perform the
rendering the in a nice looking format using:</p>
<ul class="simple">
<li><a class="reference external" href="http://twitter.github.io/bootstrap/">bootstrap</a></li>
<li><a class="reference external" href="http://jquery.com/">jquery</a></li>
<li><a class="reference external" href="https://code.google.com/p/jsqrencode/">jsqrencode</a></li>
<li><a class="reference external" href="http://javascriptrrd.sourceforge.net/">javascriptrrd</a></li>
<li><a class="reference external" href="http://www.flotcharts.org/">flot</a></li>
<li><a class="reference external" href="http://www.justgage.com">justgage</a> and <a class="reference external" href="http://raphaeljs.com">raphael</a></li>
<li><a class="reference external" href="https://github.com/rubaxa/Sortable">Sortable</a></li>
</ul>
<p>This architecture has the advantage in an embedded architecture to offload the server task and delegate
processing and rendering to the client.</p>
<p>Some data are stored into client browser into <em>local storage</em>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Embedded server doesn’t provide access control or authentication.</p>
<p class="last">Refer to <a class="reference external" href="34_autentication.html#authentication-and-secure-access">Authentication and secure access</a>
to see how to use <strong>nginx</strong> to secure <strong>RPi-Monitor</strong></p>
</div>
<p>The following chapter is explaining how to customize the web interface.</p>
</div>
<div class="section" id="friends">
<h2>Friends<a class="headerlink" href="#friends" title="Permalink to this headline">¶</a></h2>
<p>Friends are defining a displayed title and a link reachable from a
top left menu visible if at least one friends is configured. Each
friend is identified by its <code class="docutils literal"><span class="pre"><id></span></code> and is described by the 2 following
parameters</p>
<dl class="docutils">
<dt>web.friends.<id>.title=<display title></dt>
<dd><code class="docutils literal"><span class="pre"><display</span> <span class="pre">title></span></code> is the title printed into the drop down menu.
This parameter will be evaluated by the javascript command with the function <code class="docutils literal"><span class="pre">eval()</span></code>
theirfore parameter should be valid javacript.</dd>
<dt>web.friends.<id>.link=<link to RPi-Monitor></dt>
<dd><code class="docutils literal"><span class="pre"><link</span> <span class="pre">to</span> <span class="pre">RPi-Monitor></span></code> is the link to another RPi-Monitor running
into the friend machine.</dd>
</dl>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">Example of implementation in <a class="reference external" href="31_customisation.html#friends">Friends customisation example</a></p>
</div>
</div>
<div class="section" id="header-customisation">
<h2>Header customisation<a class="headerlink" href="#header-customisation" title="Permalink to this headline">¶</a></h2>
<p>Header of web page can be customized with the following parameters:</p>
<dl class="docutils">
<dt>web.page.icon=<icon location relative to webroot></dt>
<dd><code class="docutils literal"><span class="pre"><icon</span> <span class="pre">location</span> <span class="pre">relative</span> <span class="pre">to</span> <span class="pre">webroot></span></code> is the path and filename of
the icon to be displayed into <strong>RPi-Monitor</strong> title bar</dd>
<dt>web.page.menutitle=<menu title></dt>
<dd><code class="docutils literal"><span class="pre"><menu</span> <span class="pre">title></span></code> javascript code defining the text displayed into
RPi-Monotor title bar. This code can use status information with
the keyword <code class="docutils literal"><span class="pre">data</span></code> including the <code class="docutils literal"><span class="pre">data.hostname</span></code> available natively</dd>
<dt>web.page.pagetitle=<page title></dt>
<dd><p class="first"><code class="docutils literal"><span class="pre"><page</span> <span class="pre">title></span></code> javascript code defining the text displayed into
tab and window title bar. This code can use status information with
the keyword <code class="docutils literal"><span class="pre">data</span></code> including the <code class="docutils literal"><span class="pre">data.hostname</span></code> available natively</p>
<a class="last reference internal image-reference" href="_images/header001.png"><img alt="_images/header001.png" class="align-center" src="_images/header001.png" style="width: 500px;" /></a>
</dd>
</dl>
</div>
<div class="section" id="status">
<h2>Status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h2>
<p>The status page is fully configurable. It is possible to define multiple pages.
Each page is identified by its <code class="docutils literal"><span class="pre"><page</span> <span class="pre">id></span></code>.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">Example of implementation in <a class="reference external" href="31_customisation.html#multiple-pages">Multi-pages customisation example</a></p>
</div>
<dl class="docutils">
<dt>web.status.<page id>.title=<page title></dt>
<dd><p class="first"><code class="docutils literal"><span class="pre"><page</span> <span class="pre">title></span></code> title of the page displayed into the drop down menu in case of multiple pages.
This parameter will be evaluated by the javascript command with the function <code class="docutils literal"><span class="pre">eval()</span></code>
theirfore parameter should be valid javacript.</p>
<div class="last admonition hint">
<p class="first admonition-title">Hint</p>
<p class="last">You can use the function <code class="docutils literal"><span class="pre">LinkToGraph(page,graph,text)</span></code> direct link to graph.</p>
</div>
</dd>
</dl>
<p>Status page is split in strips displaying information. Each status strip is
identified by a unique <code class="docutils literal"><span class="pre"><status</span> <span class="pre">id></span></code>. Each status strip is defined by a title,
an icon and a serie of parameters described as follow:</p>
<dl class="docutils">
<dt>web.status.<page id>.content.<status id>.visibility=<visibility formula></dt>
<dd><p class="first"><code class="docutils literal"><span class="pre"><visibility</span> <span class="pre">formula></span></code> should be a valid javascript formula returning
<code class="docutils literal"><span class="pre">0</span></code>: to hide the row anything else but <code class="docutils literal"><span class="pre">0</span></code>: show the row</p>
<div class="last admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">Example of implementation in <a class="reference external" href="27_configuration_templates.html#visibility">Visibility example</a></p>
</div>
</dd>
<dt>web.status.<page id>.content.<status id>.title=<display title></dt>
<dd><code class="docutils literal"><span class="pre"><display</span> <span class="pre">title></span></code> title displayed as title of the strip</dd>
<dt>web.status.<page id>.content.<status id>.icon=<display icon></dt>
<dd><code class="docutils literal"><span class="pre"><display</span> <span class="pre">icon></span></code> Icon of the strip</dd>
<dt>web.status.<page id>.content.<status id>.line.<line number>=<parameter></dt>
<dd><p class="first"><code class="docutils literal"><span class="pre"><line</span> <span class="pre">number></span></code> represent the position of the line within the strip.</p>
<p>This number has to be unique within the strip.</p>
<p><code class="docutils literal"><span class="pre"><parameter></span></code> is describing the content of the line. This parameter will be evaluated by the
javascript command with the function <code class="docutils literal"><span class="pre">eval()</span></code> theirfore parameter should be valid javacript.</p>
<p>To have clean rendering, <strong>RPi-Monitor</strong> web interface provides some functions
that could be used inside the parameter. The object <code class="docutils literal"><span class="pre">data</span></code> is also available
and contains the result of <code class="docutils literal"><span class="pre">dynamic</span></code> and <code class="docutils literal"><span class="pre">static</span></code> extracted as described in
the KPI extraction section (Ex: <code class="docutils literal"><span class="pre">data.version</span></code>).</p>
<p>Functions provided by <strong>RPi-Monitor</strong> are the following:</p>
<blockquote class="last">
<div><ul>
<li><dl class="first docutils">
<dt><strong>Uptime(uptime in sec)</strong></dt>
<dd><p class="first last">Print the uptime from seconds to the following format: XX year XX days XX hours XX minutes XX seconds</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Pad(value)</strong></dt>
<dd><p class="first last">Add a prefixed 0 for number smaller than 10</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>KMG(value, prefix)</strong></dt>
<dd><p class="first last">Print value in kilo, Mega, Giga, Peta.
prefix can be ‘k’, ‘M’, ‘G’ or ‘P’ depending on the value.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Percent(value,total)</strong></dt>
<dd><p class="first last">Print percentage of value compared to total</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>ProgressBar(value,total,warning, danger)</strong></dt>
<dd><p class="first">Draw a progressbar representing the value compared to total.</p>
<p>The default color of pregressbar is blue.</p>
<p>If warning value is lower than critical, progressbar color will be orange if percentage is higher than warning value and red
if the percentage is higher than danger value.</p>
<p>If warning value is higher than critical, progressbar color will be orange if percentage is lower than warning value and red if the percentage is lower than danger value.</p>
<div class="last figure align-center">
<a class="reference internal image-reference" href="_images/web001.png"><img alt="_images/web001.png" src="_images/web001.png" style="width: 500px;" /></a>
</div>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>JustGageBar(title, label,min, value, max, width, height, levelColors, warning, critical)</strong></dt>
<dd><p class="first">Draw a half-circular gauge</p>
<ul class="simple">
<li><strong>title</strong> : Title of the gauge (located on to of the gauge)</li>
<li><strong>label</strong> : Label of the gauge (located under the value)</li>
<li><strong>min</strong> : min value of the gauge</li>
<li><strong>value</strong> : value to be drawn</li>
<li><strong>max</strong> : max value of the gauge</li>
<li><strong>width</strong>, <strong>height</strong> : size of the gauge</li>
<li><strong>levelColors</strong> : Array defining colors of each level [normal,warning,critical] (in Hex format), default: green, orange and red. Default colors are available into the array <code class="docutils literal"><span class="pre">percentColors</span></code>.</li>
<li><strong>warning</strong> : Warning level (in %) used to define color (default: 33)</li>
<li><strong>critical</strong> : Critical level (in %) used to define color (default: 66)</li>
</ul>
<div class="last figure align-center">
<a class="reference internal image-reference" href="_images/web002.png"><img alt="_images/web002.png" src="_images/web002.png" style="width: 500px;" /></a>
</div>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Plural(value)</strong></dt>
<dd><p class="first last">Print ‘s ‘ if value > 1 or ‘ ‘ if not.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Clock(data.localtime)</strong></dt>
<dd><p class="first last">This function is a little bit particular and should be written exactly
as in the upper line. It will display on screen the current time and
will simulate the seconds by incrementing them periodically.</p>
</dd>
</dl>
</li>
<li><p class="first"><strong>Label(data,formula, text, level)</strong></p>
</li>
<li><dl class="first docutils">
<dt><strong>Badge(data,formula, text, level)</strong></dt>
<dd><p class="first">This function write a label/badge with a defined background color if the formula return TRUE.</p>
<ul class="simple">
<li><strong>data</strong> : data to use with the formula</li>
<li><strong>formula</strong> : formula evaluated in regards to data to determine if label/badge has to be printed</li>
<li><strong>text</strong> : text to be displayed</li>
<li><strong>level</strong> : ‘default’ (grey), ‘primary’ (blue label/grey badge), ‘success’ (green), ‘info’ (cyan), ‘warning’ (orange), ‘danger’ (red)</li>
</ul>
<a class="last reference internal image-reference" href="_images/web003.png"><img alt="_images/web003.png" class="align-center" src="_images/web003.png" style="width: 500px;" /></a>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>InsertHTML(url)</strong></dt>
<dd><p class="first">This function is used to insert an HTML information inside a page.</p>
<div class="last admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">Example of implementation in <a class="reference external" href="25_addons.html#top3-addon">Top3 addon</a></p>
</div>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>LinkToGraph(page,graph,text)</strong></dt>
<dd><p class="first">This function is used create a link to graph in specific page.</p>
<ul class="simple">
<li><strong>page</strong> : page id (starting from 0)</li>
<li><strong>graph</strong> : graph id (starting from 0)</li>
<li><strong>text</strong> : text of the link</li>
</ul>
<a class="last reference internal image-reference" href="_images/web004.png"><img alt="_images/web004.png" class="align-center" src="_images/web004.png" style="width: 500px;" /></a>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
</dd>
</dl>
</div>
<div class="section" id="statistics">
<h2>Statistics<a class="headerlink" href="#statistics" title="Permalink to this headline">¶</a></h2>
<p>The statistic page is fully configurable.
It is possible to define multiple pages. Each page is identified by
its <code class="docutils literal"><span class="pre"><page</span> <span class="pre">id></span></code>.</p>
<dl class="docutils">
<dt>web.statistic.<page id>.title=<page title></dt>
<dd><code class="docutils literal"><span class="pre"><page</span> <span class="pre">title></span></code> title of the page displayed into the drop down menu in
case of multiple pages. This parameter will be evaluated by the javascript
command with the function <code class="docutils literal"><span class="pre">eval()</span></code> theirfore parameter should be valid javacript.</dd>
</dl>
<p>The statistic page displays statistics graphs. The graphs are
identified an unique <code class="docutils literal"><span class="pre"><statistic</span> <span class="pre">id></span></code> and by the following parameters.</p>
<dl class="docutils">
<dt>web.statistics.<page id>.content.<statistic id>.title=<statistic title></dt>
<dd><code class="docutils literal"><span class="pre"><statistic</span> <span class="pre">title></span></code> is the title of the statistics displayed in the
top left drop down list.</dd>
<dt>web.statistics.<page id>.content.<statistic id>.graph.<rrd id>=<data name></dt>
<dd><code class="docutils literal"><span class="pre"><rrd</span> <span class="pre">id></span></code> is identifying the graph and is unique per <code class="docutils literal"><span class="pre"><statistic</span> <span class="pre">id></span></code>
<code class="docutils literal"><span class="pre"><data</span> <span class="pre">name></span></code> is the name of the dynamic and static extracted as
described in the KPI extraction section.</dd>
<dt>web.statistics.<page id>.content.<statistic id>.ds_graph_options.<data name>.label=<label></dt>
<dd><code class="docutils literal"><span class="pre"><data</span> <span class="pre">name></span></code> same as the previous <code class="docutils literal"><span class="pre"><data</span> <span class="pre">name></span></code>
<code class="docutils literal"><span class="pre"><label></span></code> Label to display in legends. It is possible to setup other parameters
of ds_graph_options. Refer to
<a class="reference external" href="http://javascriptrrd.sourceforge.net/docs/javascriptrrd_v0.5.0/doc/lib/rrdFlot_js.html">javascriptrrd documentation</a>
for details.</dd>
<dt>web.statistics.<page id>.content.<statistic id>.graph_options.<parameter>=<value></dt>
<dd><code class="docutils literal"><span class="pre"><parameter></span></code> and <code class="docutils literal"><span class="pre"><value></span></code> can be find into the same web page as previous
parameter. This allow to customize the graph and axis.</dd>
</dl>
</div>
<div class="section" id="addons">
<h2>Addons<a class="headerlink" href="#addons" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p><strong>RPi-Monitor</strong> features can be extended by addons. Addons are <code class="docutils literal"><span class="pre">html</span></code>, <code class="docutils literal"><span class="pre">javascript</span></code>
and <code class="docutils literal"><span class="pre">css</span></code> code installed in <code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web/addons/</span></code>.</p>
<p>Each addons is idendifier by an <code class="docutils literal"><span class="pre">id</span></code> and the following parameters:</p>
<dl class="docutils">
<dt>web.addons.<id>.title=<title to be display></dt>
<dd><code class="docutils literal"><span class="pre"><title</span> <span class="pre">to</span> <span class="pre">be</span> <span class="pre">display></span></code> defines the text display in RPi-Monitor web interface.
This parameter will be evaluated by the javascript command with the function <code class="docutils literal"><span class="pre">eval()</span></code>
theirfore parameter should be valid javacript.</dd>
<dt>web.addons.<id>.addons=<addon name></dt>
<dd><code class="docutils literal"><span class="pre"><addon</span> <span class="pre">name></span></code> defines the addon to activate.</dd>
<dt>web.addons.<id>.showTitle=<0|1></dt>
<dd><code class="docutils literal"><span class="pre"><0|1></span></code> defines it the title of addon has to be shown in addon page.</dd>
<dt>web.addons.<id>.<parameter>=<value></dt>
<dd><code class="docutils literal"><span class="pre"><parameter>=<value></span></code> are optional parameter to configure addon</dd>
</dl>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">Example of addons in <a class="reference external" href="24_addons.html">addons configuration</a></p>
</div>
</div></blockquote>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="25_addons.html" class="btn btn-neutral float-right" title="Addons configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="23_configuration_helper.html" class="btn btn-neutral" title="Interactive Configuration Helper" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Xavier Berger.
Last updated on Mar 18, 2018.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-6853682829194266"
data-ad-slot="2876944524"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: ''
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enableSticky();
});
</script>
</body>
</html>