free
/
freedombonee
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Note on administering the system

This commit is contained in:
Bob Mottram 2015-12-03 12:20:12 +00:00
parent 6c1530acf6
commit f21c1c054f
3 changed files with 64 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/EN/installation.org
View File

@ -7,7 +7,7 @@
#+BEGIN_CENTER #+BEGIN_CENTER
[[./images/logo.png]] [[./images/logo.png]]
#+END_CENTER #+END_CENTER
| [[file:index.html][Home]] | [[Building an image for an SBC or Virtual Machine]] | [[Checklist]] | [[./mesh.html][Mesh network]] | [[Installation]] | [[Social Key Management (aka 'The Unforgettable Key')]] | [[Final Setup]] | [[Keydrives]] | [[On Client Machines]] | | [[file:index.html][Home]] | [[Building an image for an SBC or Virtual Machine]] | [[Checklist]] | [[./mesh.html][Mesh network]] | [[Installation]] | [[Social Key Management (aka 'The Unforgettable Key')]] | [[Final Setup]] | [[Keydrives]] | [[On Client Machines]] | [[Administering the system]] |
* Building an image for an SBC or Virtual Machine * Building an image for an SBC or Virtual Machine
You don't have to trust images downloaded from random internet locations signed with untrusted keys. You can build one from scratch yourself, and this is the recommended procedure for maximum security. For guidance on how to build images see the manpage for the *freedombone-image* command. You don't have to trust images downloaded from random internet locations signed with untrusted keys. You can build one from scratch yourself, and this is the recommended procedure for maximum security. For guidance on how to build images see the manpage for the *freedombone-image* command.
@ -200,3 +200,14 @@ cd freedombone
sudo make install sudo make install
freedombone-client freedombone-client
#+END_SRC #+END_SRC
* Administering the system
To administer the system after installation log in via ssh, become the root user and then launch the control panel.
#+BEGIN_SRC bash
ssh myusername@freedombone.local -p 2222
sudo su
control
#+END_SRC
From there you will be able to perform various tasks, such as backups, adding and removing users and so on. You can also do this via commands, which are typically installed as /usr/local/bin/freedombone* and the corresponding manpages.

BIN
man/freedombone.1.gz
View File

Binary file not shown.

80
website/EN/installation.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2015-12-03 Thu 12:09 --> <!-- 2015-12-03 Thu 12:19 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title></title> <title></title>
@ -181,6 +181,8 @@ for the JavaScript code in this tag.
<col class="org-left" /> <col class="org-left" />
<col class="org-left" />
<col class="org-left" /> <col class="org-left" />
</colgroup> </colgroup>
<tbody> <tbody>
@ -194,6 +196,7 @@ for the JavaScript code in this tag.
<td class="org-left"><a href="#orgheadline5">Final Setup</a></td> <td class="org-left"><a href="#orgheadline5">Final Setup</a></td>
<td class="org-left"><a href="#orgheadline6">Keydrives</a></td> <td class="org-left"><a href="#orgheadline6">Keydrives</a></td>
<td class="org-left"><a href="#orgheadline7">On Client Machines</a></td> <td class="org-left"><a href="#orgheadline7">On Client Machines</a></td>
<td class="org-left"><a href="#orgheadline8">Administering the system</a></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -272,9 +275,9 @@ Before installing Freedombone you will need a few things.
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orgheadline8" class="outline-2"> <div id="outline-container-orgheadline9" class="outline-2">
<h2 id="orgheadline8">Mesh network</h2> <h2 id="orgheadline9">Mesh network</h2>
<div class="outline-text-2" id="text-orgheadline8"> <div class="outline-text-2" id="text-orgheadline9">
<p> <p>
If you are installing one of the mesh network variants then see <a href="./mesh.html">these instructions</a> for details. If you are installing one of the mesh network variants then see <a href="./mesh.html">these instructions</a> for details.
</p> </p>
@ -288,9 +291,9 @@ There are three install options: Laptop/Desktop/Netbook, SBC and Virtual Machine
</p> </p>
</div> </div>
<div id="outline-container-orgheadline9" class="outline-3"> <div id="outline-container-orgheadline10" class="outline-3">
<h3 id="orgheadline9">On a Laptop, Netbook or Desktop machine</h3> <h3 id="orgheadline10">On a Laptop, Netbook or Desktop machine</h3>
<div class="outline-text-3" id="text-orgheadline9"> <div class="outline-text-3" id="text-orgheadline10">
<p> <p>
If you have an existing system, such as an old laptop or netbook which you can leave running as a server, then install a new version of Debian Jessie onto it. During the Debian install you won't need the print server or the desktop environment, and unchecking those will reduce the attack surface. Once Debian enter the following commands: If you have an existing system, such as an old laptop or netbook which you can leave running as a server, then install a new version of Debian Jessie onto it. During the Debian install you won't need the print server or the desktop environment, and unchecking those will reduce the attack surface. Once Debian enter the following commands:
</p> </p>
@ -309,9 +312,9 @@ freedombone menuconfig
</div> </div>
</div> </div>
<div id="outline-container-orgheadline10" class="outline-3"> <div id="outline-container-orgheadline11" class="outline-3">
<h3 id="orgheadline10">On a single board computer (SBC)</h3> <h3 id="orgheadline11">On a single board computer (SBC)</h3>
<div class="outline-text-3" id="text-orgheadline10"> <div class="outline-text-3" id="text-orgheadline11">
<p> <p>
Currently the following boards are supported: Currently the following boards are supported:
</p> </p>
@ -393,9 +396,9 @@ Using the password 'freedombone'. Take a note of the new login password and then
</div> </div>
</div> </div>
<div id="outline-container-orgheadline11" class="outline-3"> <div id="outline-container-orgheadline12" class="outline-3">
<h3 id="orgheadline11">As a Virtual Machine</h3> <h3 id="orgheadline12">As a Virtual Machine</h3>
<div class="outline-text-3" id="text-orgheadline11"> <div class="outline-text-3" id="text-orgheadline12">
<p> <p>
Virtualbox and Qemu are supported. You can run a 64 bit Qemu image with: Virtualbox and Qemu are supported. You can run a 64 bit Qemu image with:
</p> </p>
@ -425,25 +428,25 @@ If you are using the interactive installer then you will be aked if you wish to
</p> </p>
</div> </div>
<div id="outline-container-orgheadline12" class="outline-3"> <div id="outline-container-orgheadline13" class="outline-3">
<h3 id="orgheadline12">You have the gnupg keyring on an encrypted USB drive</h3> <h3 id="orgheadline13">You have the gnupg keyring on an encrypted USB drive</h3>
<div class="outline-text-3" id="text-orgheadline12"> <div class="outline-text-3" id="text-orgheadline13">
<p> <p>
If you previously made a master keydrive containing the full keyring (the .gnupg directory). This is the most straightforward case, but not as secure as splitting the key into fragments. If you previously made a master keydrive containing the full keyring (the .gnupg directory). This is the most straightforward case, but not as secure as splitting the key into fragments.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgheadline13" class="outline-3"> <div id="outline-container-orgheadline14" class="outline-3">
<h3 id="orgheadline13">You have a number of key fragments on USB drives retrieved from friends</h3> <h3 id="orgheadline14">You have a number of key fragments on USB drives retrieved from friends</h3>
<div class="outline-text-3" id="text-orgheadline13"> <div class="outline-text-3" id="text-orgheadline14">
<p> <p>
If you previously made some USB drives containing key fragments then retrieve them from your friends and plug them in one after the other. After the last drive has been read then remove it and just select "Ok". The system will then try to reconstruct the key. For this to work you will need to have previously made three or more <a href="#orgheadline6">Keydrives</a>. If you previously made some USB drives containing key fragments then retrieve them from your friends and plug them in one after the other. After the last drive has been read then remove it and just select "Ok". The system will then try to reconstruct the key. For this to work you will need to have previously made three or more <a href="#orgheadline6">Keydrives</a>.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgheadline14" class="outline-3"> <div id="outline-container-orgheadline15" class="outline-3">
<h3 id="orgheadline14">You can specify some ssh login details for friends servers containing key fragments</h3> <h3 id="orgheadline15">You can specify some ssh login details for friends servers containing key fragments</h3>
<div class="outline-text-3" id="text-orgheadline14"> <div class="outline-text-3" id="text-orgheadline15">
<p> <p>
Enter three or more sets of login details and the installer will try to retrieve key fragments and then assemble them into the full key. This only works if you previously were using remote backups and had social key management enabled. Enter three or more sets of login details and the installer will try to retrieve key fragments and then assemble them into the full key. This only works if you previously were using remote backups and had social key management enabled.
</p> </p>
@ -582,9 +585,9 @@ On your internet router, typically under firewall settings, open the following p
After installing for the first time it's a good idea to create some keydrives. These will store your gpg key so that if all else fails you will still be able to restore from backup. There are two ways to do this: After installing for the first time it's a good idea to create some keydrives. These will store your gpg key so that if all else fails you will still be able to restore from backup. There are two ways to do this:
</p> </p>
</div> </div>
<div id="outline-container-orgheadline15" class="outline-3"> <div id="outline-container-orgheadline16" class="outline-3">
<h3 id="orgheadline15">Master Keydrive</h3> <h3 id="orgheadline16">Master Keydrive</h3>
<div class="outline-text-3" id="text-orgheadline15"> <div class="outline-text-3" id="text-orgheadline16">
<p> <p>
This is the traditional security model in which you carry your full keyring on an encrypted USB drive. To make a master keydrive first format a USB drive as a LUKS encrypted drive. In Ubuntu this can be <a href="https://help.ubuntu.com/community/EncryptedFilesystemsOnRemovableStorage">done from the <i>Disk Utility</i> application</a>. Then plug it into the Freedombone system, then from your local machine run: This is the traditional security model in which you carry your full keyring on an encrypted USB drive. To make a master keydrive first format a USB drive as a LUKS encrypted drive. In Ubuntu this can be <a href="https://help.ubuntu.com/community/EncryptedFilesystemsOnRemovableStorage">done from the <i>Disk Utility</i> application</a>. Then plug it into the Freedombone system, then from your local machine run:
</p> </p>
@ -602,9 +605,9 @@ Select <i>Backup and Restore</i> then <i>Backup GPG key to USB (master keydrive)
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgheadline16" class="outline-3"> <div id="outline-container-orgheadline17" class="outline-3">
<h3 id="orgheadline16">Fragment keydrives</h3> <h3 id="orgheadline17">Fragment keydrives</h3>
<div class="outline-text-3" id="text-orgheadline16"> <div class="outline-text-3" id="text-orgheadline17">
<p> <p>
This breaks your GPG key into a number of fragments and randomly selects one to add to the USB drive. First format a USB drive as a LUKS encrypted drive. In Ubuntu this <a href="https://help.ubuntu.com/community/EncryptedFilesystemsOnRemovableStorage">can be done from the <i>Disk Utility</i> application</a>. Plug it into the Freedombone system then from your local machine run the following commands: This breaks your GPG key into a number of fragments and randomly selects one to add to the USB drive. First format a USB drive as a LUKS encrypted drive. In Ubuntu this <a href="https://help.ubuntu.com/community/EncryptedFilesystemsOnRemovableStorage">can be done from the <i>Disk Utility</i> application</a>. Plug it into the Freedombone system then from your local machine run the following commands:
</p> </p>
@ -646,6 +649,27 @@ freedombone-client
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orgheadline8" class="outline-2">
<h2 id="orgheadline8">Administering the system</h2>
<div class="outline-text-2" id="text-orgheadline8">
<p>
To administer the system after installation log in via ssh, become the root user and then launch the control panel.
</p>
<div class="org-src-container">
<pre class="src src-bash">ssh myusername@freedombone.local -p 2222
sudo su
control
</pre>
</div>
<p>
From there you will be able to perform various tasks, such as backups, adding and removing users and so on. You can also do this via commands, which are typically installed as /usr/local/bin/freedombone* and the corresponding manpages.
</p>
</div>
</div>
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">