-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path25_addons.html
429 lines (283 loc) · 20 KB
/
25_addons.html
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
<!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>Addons 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="Alert configuration" href="26_alert.html" />
<link rel="prev" title="Web interface configuration" href="24_web.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"><a class="reference internal" href="24_web.html">Web interface configuration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">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>Addons configuration</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/XavierBerger/RPi-Monitor/blob/develop/docs/source/25_addons.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="addons-configuration">
<h1>Addons configuration<a class="headerlink" href="#addons-configuration" title="Permalink to this headline">¶</a></h1>
<p>Addons are custom pages designed to give you the possibility to free your imagination
and cutomise <strong>RPi-Monitor</strong> interface to match your needs.</p>
<p>Addons are <code class="docutils literal"><span class="pre">html</span></code> pages, <code class="docutils literal"><span class="pre">javascript</span></code> and <code class="docutils literal"><span class="pre">css</span></code> directly integrated into <strong>RPi-Monitor</strong>.
Addons are installed in <code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web/addons/</span></code> and activation is done in configuration file.</p>
<p>It is possible to use an addon many time into a same configuration file using
different parameters if the addon support them as show hereunder with <a class="reference external" href="25_addons.html#id1">custom addon</a>.</p>
<p>The next part of this chapter shows some examples of addons and highlight the possibilities of this feature.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="_images/addons001.png"><img alt="_images/addons001.png" src="_images/addons001.png" style="width: 500px;" /></a>
</div>
<div class="section" id="about-addon">
<h2>About Addon<a class="headerlink" href="#about-addon" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal"><span class="pre">About</span> <span class="pre">addon</span></code> is activated by default and present addons feature.</p>
<p>To remove this addons, simply comment out or delete the following lines from <code class="docutils literal"><span class="pre">/etc/rpimonitor/data.conf</span></code>.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">include</span><span class="o">=/</span><span class="n">etc</span><span class="o">/</span><span class="n">rpimonitor</span><span class="o">/</span><span class="n">template</span><span class="o">/</span><span class="n">addons</span><span class="o">.</span><span class="n">conf</span>
</pre></div>
</div>
</div>
<div class="section" id="top3-addon">
<h2>Top3 Addon<a class="headerlink" href="#top3-addon" title="Permalink to this headline">¶</a></h2>
<p>Top3 is showing how to use addons to add additionnal information into status page.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="_images/addons002.png"><img alt="_images/addons002.png" src="_images/addons002.png" style="width: 400px;" /></a>
</div>
<p>This addons is designed to periodically generate HTML content. This content can
be accessible from the addons menu and/or can be inserted into status page
using the function <code class="docutils literal"><span class="pre">InsertHTML()</span></code>.</p>
<p>Top3 addons shows the 3 process consuming the most CPU time in addition to
cunsumption of <code class="docutils literal"><span class="pre">rpimonitord</span></code> process.</p>
<p>To activate this addon, add the following lines to your configuration file</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">title</span><span class="o">=</span><span class="n">Top3</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">addons</span><span class="o">=</span><span class="n">top3</span>
</pre></div>
</div>
<p>Copy <code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web/addons/top3/top3.cron</span></code> to <code class="docutils literal"><span class="pre">/etc/cron.d/top3</span></code> to activate periodical check.</p>
<p>To add top3 information into status page, add the following line to configuration file.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">web</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="mf">1.</span><span class="n">content</span><span class="o">.</span><span class="mf">1.</span><span class="n">line</span><span class="o">.</span><span class="mi">1</span><span class="o">=</span><span class="n">InsertHTML</span><span class="p">(</span><span class="s2">"/addons/top3/top3.html"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1">
<h2>Custom Addon<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>If you are not confortable with html, javascript and css, the addon custom may
help you to customise <strong>RPi-Monitor</strong> to your wishes. This addons implement an
iframe that can display any other web pages.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="_images/addons003.png"><img alt="_images/addons003.png" src="_images/addons003.png" style="width: 500px;" /></a>
</div>
<p>Custom addon can be configured with the following parameters:</p>
<dl class="docutils">
<dt>web.addons.<id>.title=<title></dt>
<dd><code class="docutils literal"><span class="pre"><title></span></code> represent the title displayed in addon menu or addon title
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=custom</dt>
<dd><code class="docutils literal"><span class="pre">custom</span></code> is the addon activated</dd>
<dt>web.addons.<id>.showtitle=<title visibility></dt>
<dd><code class="docutils literal"><span class="pre"><title</span> <span class="pre">visibility></span></code> define if title should be displayed or not</dd>
<dt>web.addons.<id>.url=<url></dt>
<dd><code class="docutils literal"><span class="pre">url</span></code> is defining the page to be displayed into the iframe. It can be a file
reachable from <strong>RPi-Monitor</strong> internal server or a site available on the Internet.</dd>
<dt>web.addons.<id>.allowupdate=<allow update></dt>
<dd><code class="docutils literal"><span class="pre"><allow</span> <span class="pre">update></span></code> define is <code class="docutils literal"><span class="pre">url</span></code> can be updated in option</dd>
</dl>
<div class="section" id="shellinabox">
<h3>Shellinabox<a class="headerlink" href="#shellinabox" title="Permalink to this headline">¶</a></h3>
<p><a class="reference external" href="https://github.com/shellinabox/shellinabox">Shellinabox</a> allow you to access to the shell of your
Raspberry Pi through a web interface.</p>
<p>Installing shellinabox can be done with the following command:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">shellinabox</span>
</pre></div>
</div>
<p>By default shellinabox listening on <a class="reference external" href="http://raspberrypi.local:4200/">http://raspberrypi.local:4200/</a>.</p>
<p>Shellinabox can be integrated to <strong>RPi-Monitor</strong> with custom addon as follow:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">title</span><span class="o">=</span><span class="n">ShelleInABox</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">addons</span><span class="o">=</span><span class="n">custom</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">showtitle</span><span class="o">=</span><span class="n">false</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">url</span><span class="o">=</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">raspberrypi</span><span class="o">.</span><span class="n">local</span><span class="p">:</span><span class="mi">4200</span><span class="o">/</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">allowupdate</span><span class="o">=</span><span class="n">false</span>
</pre></div>
</div>
</div>
<div class="section" id="webcam">
<h3>Webcam<a class="headerlink" href="#webcam" title="Permalink to this headline">¶</a></h3>
<p>If you want to see the image of your webcam in your browser, you can use
<a class="reference external" href="https://github.com/ipartola/hawkeye">hawkeye</a>.
Once <code class="docutils literal"><span class="pre">hawkeye</span></code> is installed, it is very easy to add it into <strong>RPi-Monitor</strong> interface
using the custom addon. The configuration will then be the following:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">title</span><span class="o">=</span><span class="n">Webcam</span> <span class="o">-</span> <span class="n">Hawkeye</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">addons</span><span class="o">=</span><span class="n">custom</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">url</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">raspberrypi</span><span class="o">.</span><span class="n">local</span><span class="p">:</span><span class="mi">8000</span><span class="o">/</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">allowupdate</span><span class="o">=</span><span class="n">false</span>
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">url</span></code> parameter point to hawkeye web interface.</p>
<div class="admonition danger">
<p class="first admonition-title">Danger</p>
<p>If you are doing such a configuration, keep in mind about the
security of your images. You should use the capacity of hawkeye to
restrict the access to the image using a login and a password.</p>
<div class="last admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">You can also have a look to <a class="reference external" href="34_autentication.html">Authentication and secure access to RPi-Monitor</a>.</p>
</div>
</div>
</div>
</div>
<div class="section" id="example-addon">
<h2>Example Addon<a class="headerlink" href="#example-addon" title="Permalink to this headline">¶</a></h2>
<p>If you want to develop your own addon, you can refer to the example addons to
see how to implement such a feature.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="_images/addons006.png"><img alt="_images/addons006.png" src="_images/addons006.png" style="width: 500px;" /></a>
</div>
<p>Example addon is providing a <code class="docutils literal"><span class="pre">html</span></code> page, a <code class="docutils literal"><span class="pre">javacript</span></code> and a <code class="docutils literal"><span class="pre">css</span></code> showing
how an addon page can interact with <strong>RPi-Monitor</strong>.</p>
<p>Example addon can activate by adding the following lines into the configuration file:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">title</span><span class="o">=</span><span class="n">Addon</span> <span class="n">example</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">addons</span><span class="o">=</span><span class="n">example</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">showtitle</span><span class="o">=</span><span class="n">true</span>
<span class="n">web</span><span class="o">.</span><span class="n">addons</span><span class="o">.</span><span class="mf">1.</span><span class="n">parameter</span><span class="o">=</span><span class="n">parameter_example</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="26_alert.html" class="btn btn-neutral float-right" title="Alert configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="24_web.html" class="btn btn-neutral" title="Web interface configuration" 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>