Document the user control panel

This commit is contained in:
Bob Mottram 2016-02-27 22:49:02 +00:00
parent 9a5b07cf81
commit d8591c7a05
3 changed files with 74 additions and 35 deletions

View File

@ -17,6 +17,7 @@
#+END_EXPORT
| [[Main menu]] |
| [[User control panel]] |
| [[About screen]] |
| [[Email filtering rules]] |
| [[Hubzilla menu]] |
@ -43,6 +44,16 @@ It should look like this:
To select anythng on the control panel use the *up and down* cursor keys and *space bar* to tag, then press *Enter*.
* User control panel
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.
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*.
#+BEGIN_CENTER
[[./images/controlpanel/control_panel_user.jpg]]
#+END_CENTER
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.
* About screen
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2016-02-27 Sat 22:07 -->
<!-- 2016-02-27 Sat 22:48 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title></title>
@ -174,39 +174,43 @@ for the JavaScript code in this tag.
</tr>
<tr>
<td class="org-left"><a href="#orgheadline2">About screen</a></td>
<td class="org-left"><a href="#orgheadline2">User control panel</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline3">Email filtering rules</a></td>
<td class="org-left"><a href="#orgheadline3">About screen</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline4">Hubzilla menu</a></td>
<td class="org-left"><a href="#orgheadline4">Email filtering rules</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline5">IRC menu</a></td>
<td class="org-left"><a href="#orgheadline5">Hubzilla menu</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline6">Media menu</a></td>
<td class="org-left"><a href="#orgheadline6">IRC menu</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline7">Repository mirrors</a></td>
<td class="org-left"><a href="#orgheadline7">Media menu</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline8">Backup and restore menu</a></td>
<td class="org-left"><a href="#orgheadline8">Repository mirrors</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline9">Security menu</a></td>
<td class="org-left"><a href="#orgheadline9">Backup and restore menu</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline10">User management menu</a></td>
<td class="org-left"><a href="#orgheadline10">Security menu</a></td>
</tr>
<tr>
<td class="org-left"><a href="#orgheadline11">User management menu</a></td>
</tr>
</tbody>
</table>
@ -244,9 +248,33 @@ To select anythng on the control panel use the <b>up and down</b> cursor keys an
</div>
<div id="outline-container-orgheadline2" class="outline-2">
<h2 id="orgheadline2">About screen</h2>
<h2 id="orgheadline2">User control panel</h2>
<div class="outline-text-2" id="text-orgheadline2">
<p>
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.
</p>
<p>
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>.
</p>
<div class="org-center">
<div class="figure">
<p><img src="./images/controlpanel/control_panel_user.jpg" alt="control_panel_user.jpg" />
</p>
</div>
</div>
<p>
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.
</p>
</div>
</div>
<div id="outline-container-orgheadline3" class="outline-2">
<h2 id="orgheadline3">About screen</h2>
<div class="outline-text-2" id="text-orgheadline3">
<p>
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.
</p>
@ -268,9 +296,9 @@ The Local Mirrors contains mirrored copies of the git repositories used by the s
</div>
</div>
<div id="outline-container-orgheadline3" class="outline-2">
<h2 id="orgheadline3">Email filtering rules</h2>
<div class="outline-text-2" id="text-orgheadline3">
<div id="outline-container-orgheadline4" class="outline-2">
<h2 id="orgheadline4">Email filtering rules</h2>
<div class="outline-text-2" id="text-orgheadline4">
<p>
You can add users to mailing lists, or block particular email addresses or subject lines in this menu.
</p>
@ -285,9 +313,9 @@ You can add users to mailing lists, or block particular email addresses or subje
</div>
</div>
<div id="outline-container-orgheadline4" class="outline-2">
<h2 id="orgheadline4">Hubzilla menu</h2>
<div class="outline-text-2" id="text-orgheadline4">
<div id="outline-container-orgheadline5" class="outline-2">
<h2 id="orgheadline5">Hubzilla menu</h2>
<div class="outline-text-2" id="text-orgheadline5">
<p>
This allows you to set the global directory location and obtain an SSL/TLS certificate if necessary.
</p>
@ -302,9 +330,9 @@ This allows you to set the global directory location and obtain an SSL/TLS certi
</div>
</div>
<div id="outline-container-orgheadline5" class="outline-2">
<h2 id="orgheadline5">IRC menu</h2>
<div class="outline-text-2" id="text-orgheadline5">
<div id="outline-container-orgheadline6" class="outline-2">
<h2 id="orgheadline6">IRC menu</h2>
<div class="outline-text-2" id="text-orgheadline6">
<p>
You can set a password for your IRC server here.
</p>
@ -319,9 +347,9 @@ You can set a password for your IRC server here.
</div>
</div>
<div id="outline-container-orgheadline6" class="outline-2">
<h2 id="orgheadline6">Media menu</h2>
<div class="outline-text-2" id="text-orgheadline6">
<div id="outline-container-orgheadline7" class="outline-2">
<h2 id="orgheadline7">Media menu</h2>
<div class="outline-text-2" id="text-orgheadline7">
<p>
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.
</p>
@ -336,9 +364,9 @@ It's possible to add playable media to a USB drive and plug it into the system,
</div>
</div>
<div id="outline-container-orgheadline7" class="outline-2">
<h2 id="orgheadline7">Repository mirrors</h2>
<div class="outline-text-2" id="text-orgheadline7">
<div id="outline-container-orgheadline8" class="outline-2">
<h2 id="orgheadline8">Repository mirrors</h2>
<div class="outline-text-2" id="text-orgheadline8">
<p>
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).
</p>
@ -353,9 +381,9 @@ If you don't want to use the default repositories, or don't have access to them,
</div>
</div>
<div id="outline-container-orgheadline8" class="outline-2">
<h2 id="orgheadline8">Backup and restore menu</h2>
<div class="outline-text-2" id="text-orgheadline8">
<div id="outline-container-orgheadline9" class="outline-2">
<h2 id="orgheadline9">Backup and restore menu</h2>
<div class="outline-text-2" id="text-orgheadline9">
<p>
You can create backups or restore from backup here. It's also possible to create keydrives which store the backup key.
</p>
@ -370,9 +398,9 @@ You can create backups or restore from backup here. It's also possible to create
</div>
</div>
<div id="outline-container-orgheadline9" class="outline-2">
<h2 id="orgheadline9">Security menu</h2>
<div class="outline-text-2" id="text-orgheadline9">
<div id="outline-container-orgheadline10" class="outline-2">
<h2 id="orgheadline10">Security menu</h2>
<div class="outline-text-2" id="text-orgheadline10">
<p>
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.
</p>
@ -387,9 +415,9 @@ If you need to generate SSL/TLS certificates or change cypher details due to cha
</div>
</div>
<div id="outline-container-orgheadline10" class="outline-2">
<h2 id="orgheadline10">User management menu</h2>
<div class="outline-text-2" id="text-orgheadline10">
<div id="outline-container-orgheadline11" class="outline-2">
<h2 id="orgheadline11">User management menu</h2>
<div class="outline-text-2" id="text-orgheadline11">
<p>
Users can be added or removed here.
</p>