Browse Source

Document the user control panel

Bob Mottram 9 years ago
parent
commit
d8591c7a05
3 changed files with 74 additions and 35 deletions
  1. 11
    0
      doc/EN/controlpanel.org
  2. BIN
      img/controlpanel/control_panel_user.jpg
  3. 63
    35
      website/EN/controlpanel.html

+ 11
- 0
doc/EN/controlpanel.org View File

17
 #+END_EXPORT
17
 #+END_EXPORT
18
 
18
 
19
 | [[Main menu]]               |
19
 | [[Main menu]]               |
20
+| [[User control panel]]      |
20
 | [[About screen]]            |
21
 | [[About screen]]            |
21
 | [[Email filtering rules]]   |
22
 | [[Email filtering rules]]   |
22
 | [[Hubzilla menu]]           |
23
 | [[Hubzilla menu]]           |
43
 
44
 
44
 To select anythng on the control panel use the *up and down* cursor keys and *space bar* to tag, then press *Enter*.
45
 To select anythng on the control panel use the *up and down* cursor keys and *space bar* to tag, then press *Enter*.
45
 
46
 
47
+* User control panel
48
+When a user initially logs in they will see a version of the control panel with restricted options aimed at the kinds of things which someone who isn't the administrator might wish to do. An expected scenario is that you might have a few friends or family members on the system, and this is who this menu is intended for.
49
+
50
+From this menu checking email or running chat applications is very easy, and they are confugured in a safe manner without the user needing to do anything special. Email uses *mutt*, XMPP uses *profanity* and IRC uses *irssi*.
51
+
52
+#+BEGIN_CENTER
53
+[[./images/controlpanel/control_panel_user.jpg]]
54
+#+END_CENTER
55
+
56
+It's also possible for the user to define email filtering rules, add a ssh public key for key based login and also add or remove GPG public keys. They can also do this via the commandline if they prefer, but the menu system may provide an easier user interface.
46
 * About screen
57
 * About screen
47
 To find out your current domain names select the About screen from the main menu. This is especially useful for finding your onion addresses. For improved security by compartmentalisation, and also simpler implementation, each application has its own onion address.
58
 To find out your current domain names select the About screen from the main menu. This is especially useful for finding your onion addresses. For improved security by compartmentalisation, and also simpler implementation, each application has its own onion address.
48
 
59
 

BIN
img/controlpanel/control_panel_user.jpg View File


+ 63
- 35
website/EN/controlpanel.html View File

3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5
 <head>
5
 <head>
6
-<!-- 2016-02-27 Sat 22:07 -->
6
+<!-- 2016-02-27 Sat 22:48 -->
7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9
 <title></title>
9
 <title></title>
174
 </tr>
174
 </tr>
175
 
175
 
176
 <tr>
176
 <tr>
177
-<td class="org-left"><a href="#orgheadline2">About screen</a></td>
177
+<td class="org-left"><a href="#orgheadline2">User control panel</a></td>
178
 </tr>
178
 </tr>
179
 
179
 
180
 <tr>
180
 <tr>
181
-<td class="org-left"><a href="#orgheadline3">Email filtering rules</a></td>
181
+<td class="org-left"><a href="#orgheadline3">About screen</a></td>
182
 </tr>
182
 </tr>
183
 
183
 
184
 <tr>
184
 <tr>
185
-<td class="org-left"><a href="#orgheadline4">Hubzilla menu</a></td>
185
+<td class="org-left"><a href="#orgheadline4">Email filtering rules</a></td>
186
 </tr>
186
 </tr>
187
 
187
 
188
 <tr>
188
 <tr>
189
-<td class="org-left"><a href="#orgheadline5">IRC menu</a></td>
189
+<td class="org-left"><a href="#orgheadline5">Hubzilla menu</a></td>
190
 </tr>
190
 </tr>
191
 
191
 
192
 <tr>
192
 <tr>
193
-<td class="org-left"><a href="#orgheadline6">Media menu</a></td>
193
+<td class="org-left"><a href="#orgheadline6">IRC menu</a></td>
194
 </tr>
194
 </tr>
195
 
195
 
196
 <tr>
196
 <tr>
197
-<td class="org-left"><a href="#orgheadline7">Repository mirrors</a></td>
197
+<td class="org-left"><a href="#orgheadline7">Media menu</a></td>
198
 </tr>
198
 </tr>
199
 
199
 
200
 <tr>
200
 <tr>
201
-<td class="org-left"><a href="#orgheadline8">Backup and restore menu</a></td>
201
+<td class="org-left"><a href="#orgheadline8">Repository mirrors</a></td>
202
 </tr>
202
 </tr>
203
 
203
 
204
 <tr>
204
 <tr>
205
-<td class="org-left"><a href="#orgheadline9">Security menu</a></td>
205
+<td class="org-left"><a href="#orgheadline9">Backup and restore menu</a></td>
206
 </tr>
206
 </tr>
207
 
207
 
208
 <tr>
208
 <tr>
209
-<td class="org-left"><a href="#orgheadline10">User management menu</a></td>
209
+<td class="org-left"><a href="#orgheadline10">Security menu</a></td>
210
+</tr>
211
+
212
+<tr>
213
+<td class="org-left"><a href="#orgheadline11">User management menu</a></td>
210
 </tr>
214
 </tr>
211
 </tbody>
215
 </tbody>
212
 </table>
216
 </table>
244
 </div>
248
 </div>
245
 
249
 
246
 <div id="outline-container-orgheadline2" class="outline-2">
250
 <div id="outline-container-orgheadline2" class="outline-2">
247
-<h2 id="orgheadline2">About screen</h2>
251
+<h2 id="orgheadline2">User control panel</h2>
248
 <div class="outline-text-2" id="text-orgheadline2">
252
 <div class="outline-text-2" id="text-orgheadline2">
249
 <p>
253
 <p>
254
+When a user initially logs in they will see a version of the control panel with restricted options aimed at the kinds of things which someone who isn't the administrator might wish to do. An expected scenario is that you might have a few friends or family members on the system, and this is who this menu is intended for.
255
+</p>
256
+
257
+<p>
258
+From this menu checking email or running chat applications is very easy, and they are confugured in a safe manner without the user needing to do anything special. Email uses <b>mutt</b>, XMPP uses <b>profanity</b> and IRC uses <b>irssi</b>.
259
+</p>
260
+
261
+<div class="org-center">
262
+
263
+<div class="figure">
264
+<p><img src="./images/controlpanel/control_panel_user.jpg" alt="control_panel_user.jpg" />
265
+</p>
266
+</div>
267
+</div>
268
+
269
+<p>
270
+It's also possible for the user to define email filtering rules, add a ssh public key for key based login and also add or remove GPG public keys. They can also do this via the commandline if they prefer, but the menu system may provide an easier user interface.
271
+</p>
272
+</div>
273
+</div>
274
+<div id="outline-container-orgheadline3" class="outline-2">
275
+<h2 id="orgheadline3">About screen</h2>
276
+<div class="outline-text-2" id="text-orgheadline3">
277
+<p>
250
 To find out your current domain names select the About screen from the main menu. This is especially useful for finding your onion addresses. For improved security by compartmentalisation, and also simpler implementation, each application has its own onion address.
278
 To find out your current domain names select the About screen from the main menu. This is especially useful for finding your onion addresses. For improved security by compartmentalisation, and also simpler implementation, each application has its own onion address.
251
 </p>
279
 </p>
252
 
280
 
268
 </div>
296
 </div>
269
 </div>
297
 </div>
270
 
298
 
271
-<div id="outline-container-orgheadline3" class="outline-2">
272
-<h2 id="orgheadline3">Email filtering rules</h2>
273
-<div class="outline-text-2" id="text-orgheadline3">
299
+<div id="outline-container-orgheadline4" class="outline-2">
300
+<h2 id="orgheadline4">Email filtering rules</h2>
301
+<div class="outline-text-2" id="text-orgheadline4">
274
 <p>
302
 <p>
275
 You can add users to mailing lists, or block particular email addresses or subject lines in this menu.
303
 You can add users to mailing lists, or block particular email addresses or subject lines in this menu.
276
 </p>
304
 </p>
285
 </div>
313
 </div>
286
 </div>
314
 </div>
287
 
315
 
288
-<div id="outline-container-orgheadline4" class="outline-2">
289
-<h2 id="orgheadline4">Hubzilla menu</h2>
290
-<div class="outline-text-2" id="text-orgheadline4">
316
+<div id="outline-container-orgheadline5" class="outline-2">
317
+<h2 id="orgheadline5">Hubzilla menu</h2>
318
+<div class="outline-text-2" id="text-orgheadline5">
291
 <p>
319
 <p>
292
 This allows you to set the global directory location and obtain an SSL/TLS certificate if necessary.
320
 This allows you to set the global directory location and obtain an SSL/TLS certificate if necessary.
293
 </p>
321
 </p>
302
 </div>
330
 </div>
303
 </div>
331
 </div>
304
 
332
 
305
-<div id="outline-container-orgheadline5" class="outline-2">
306
-<h2 id="orgheadline5">IRC menu</h2>
307
-<div class="outline-text-2" id="text-orgheadline5">
333
+<div id="outline-container-orgheadline6" class="outline-2">
334
+<h2 id="orgheadline6">IRC menu</h2>
335
+<div class="outline-text-2" id="text-orgheadline6">
308
 <p>
336
 <p>
309
 You can set a password for your IRC server here.
337
 You can set a password for your IRC server here.
310
 </p>
338
 </p>
319
 </div>
347
 </div>
320
 </div>
348
 </div>
321
 
349
 
322
-<div id="outline-container-orgheadline6" class="outline-2">
323
-<h2 id="orgheadline6">Media menu</h2>
324
-<div class="outline-text-2" id="text-orgheadline6">
350
+<div id="outline-container-orgheadline7" class="outline-2">
351
+<h2 id="orgheadline7">Media menu</h2>
352
+<div class="outline-text-2" id="text-orgheadline7">
325
 <p>
353
 <p>
326
 It's possible to add playable media to a USB drive and plug it into the system, then make it accessible to other devices such as tablets or phones on your local network via DLNA.
354
 It's possible to add playable media to a USB drive and plug it into the system, then make it accessible to other devices such as tablets or phones on your local network via DLNA.
327
 </p>
355
 </p>
336
 </div>
364
 </div>
337
 </div>
365
 </div>
338
 
366
 
339
-<div id="outline-container-orgheadline7" class="outline-2">
340
-<h2 id="orgheadline7">Repository mirrors</h2>
341
-<div class="outline-text-2" id="text-orgheadline7">
367
+<div id="outline-container-orgheadline8" class="outline-2">
368
+<h2 id="orgheadline8">Repository mirrors</h2>
369
+<div class="outline-text-2" id="text-orgheadline8">
342
 <p>
370
 <p>
343
 If you don't want to use the default repositories, or don't have access to them, then you can obtain them from another Freedombone server (the details can be found on the other server on the <b>About</b> screen of the control panel).
371
 If you don't want to use the default repositories, or don't have access to them, then you can obtain them from another Freedombone server (the details can be found on the other server on the <b>About</b> screen of the control panel).
344
 </p>
372
 </p>
353
 </div>
381
 </div>
354
 </div>
382
 </div>
355
 
383
 
356
-<div id="outline-container-orgheadline8" class="outline-2">
357
-<h2 id="orgheadline8">Backup and restore menu</h2>
358
-<div class="outline-text-2" id="text-orgheadline8">
384
+<div id="outline-container-orgheadline9" class="outline-2">
385
+<h2 id="orgheadline9">Backup and restore menu</h2>
386
+<div class="outline-text-2" id="text-orgheadline9">
359
 <p>
387
 <p>
360
 You can create backups or restore from backup here. It's also possible to create keydrives which store the backup key.
388
 You can create backups or restore from backup here. It's also possible to create keydrives which store the backup key.
361
 </p>
389
 </p>
370
 </div>
398
 </div>
371
 </div>
399
 </div>
372
 
400
 
373
-<div id="outline-container-orgheadline9" class="outline-2">
374
-<h2 id="orgheadline9">Security menu</h2>
375
-<div class="outline-text-2" id="text-orgheadline9">
401
+<div id="outline-container-orgheadline10" class="outline-2">
402
+<h2 id="orgheadline10">Security menu</h2>
403
+<div class="outline-text-2" id="text-orgheadline10">
376
 <p>
404
 <p>
377
 If you need to generate SSL/TLS certificates or change cypher details due to changing recommendations then you can do that here. If you are changing cypher details be extra careful not to make mistakes/typos, which could reduce the security of your system.
405
 If you need to generate SSL/TLS certificates or change cypher details due to changing recommendations then you can do that here. If you are changing cypher details be extra careful not to make mistakes/typos, which could reduce the security of your system.
378
 </p>
406
 </p>
387
 </div>
415
 </div>
388
 </div>
416
 </div>
389
 
417
 
390
-<div id="outline-container-orgheadline10" class="outline-2">
391
-<h2 id="orgheadline10">User management menu</h2>
392
-<div class="outline-text-2" id="text-orgheadline10">
418
+<div id="outline-container-orgheadline11" class="outline-2">
419
+<h2 id="orgheadline11">User management menu</h2>
420
+<div class="outline-text-2" id="text-orgheadline11">
393
 <p>
421
 <p>
394
 Users can be added or removed here.
422
 Users can be added or removed here.
395
 </p>
423
 </p>