Browse Source

Note on administering the system

Bob Mottram 9 years ago
parent
commit
f21c1c054f
3 changed files with 64 additions and 29 deletions
  1. 12
    1
      doc/EN/installation.org
  2. BIN
      man/freedombone.1.gz
  3. 52
    28
      website/EN/installation.html

+ 12
- 1
doc/EN/installation.org View File

@@ -7,7 +7,7 @@
7 7
 #+BEGIN_CENTER
8 8
 [[./images/logo.png]]
9 9
 #+END_CENTER
10
-| [[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]] |
10
+| [[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]] |
11 11
 
12 12
 * Building an image for an SBC or Virtual Machine
13 13
 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
200 200
 sudo make install
201 201
 freedombone-client
202 202
 #+END_SRC
203
+
204
+* Administering the system
205
+To administer the system after installation log in via ssh, become the root user and then launch the control panel.
206
+
207
+#+BEGIN_SRC bash
208
+ssh myusername@freedombone.local -p 2222
209
+sudo su
210
+control
211
+#+END_SRC
212
+
213
+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


+ 52
- 28
website/EN/installation.html View File

@@ -3,7 +3,7 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2015-12-03 Thu 12:09 -->
6
+<!-- 2015-12-03 Thu 12:19 -->
7 7
 <meta  http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta  name="viewport" content="width=device-width, initial-scale=1" />
9 9
 <title></title>
@@ -182,6 +182,8 @@ for the JavaScript code in this tag.
182 182
 <col  class="org-left" />
183 183
 
184 184
 <col  class="org-left" />
185
+
186
+<col  class="org-left" />
185 187
 </colgroup>
186 188
 <tbody>
187 189
 <tr>
@@ -194,6 +196,7 @@ for the JavaScript code in this tag.
194 196
 <td class="org-left"><a href="#orgheadline5">Final Setup</a></td>
195 197
 <td class="org-left"><a href="#orgheadline6">Keydrives</a></td>
196 198
 <td class="org-left"><a href="#orgheadline7">On Client Machines</a></td>
199
+<td class="org-left"><a href="#orgheadline8">Administering the system</a></td>
197 200
 </tr>
198 201
 </tbody>
199 202
 </table>
@@ -272,9 +275,9 @@ Before installing Freedombone you will need a few things.
272 275
 </ul>
273 276
 </div>
274 277
 </div>
275
-<div id="outline-container-orgheadline8" class="outline-2">
276
-<h2 id="orgheadline8">Mesh network</h2>
277
-<div class="outline-text-2" id="text-orgheadline8">
278
+<div id="outline-container-orgheadline9" class="outline-2">
279
+<h2 id="orgheadline9">Mesh network</h2>
280
+<div class="outline-text-2" id="text-orgheadline9">
278 281
 <p>
279 282
 If you are installing one of the mesh network variants then see <a href="./mesh.html">these instructions</a> for details.
280 283
 </p>
@@ -288,9 +291,9 @@ There are three install options: Laptop/Desktop/Netbook, SBC and Virtual Machine
288 291
 </p>
289 292
 </div>
290 293
 
291
-<div id="outline-container-orgheadline9" class="outline-3">
292
-<h3 id="orgheadline9">On a Laptop, Netbook or Desktop machine</h3>
293
-<div class="outline-text-3" id="text-orgheadline9">
294
+<div id="outline-container-orgheadline10" class="outline-3">
295
+<h3 id="orgheadline10">On a Laptop, Netbook or Desktop machine</h3>
296
+<div class="outline-text-3" id="text-orgheadline10">
294 297
 <p>
295 298
 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:
296 299
 </p>
@@ -309,9 +312,9 @@ freedombone menuconfig
309 312
 </div>
310 313
 </div>
311 314
 
312
-<div id="outline-container-orgheadline10" class="outline-3">
313
-<h3 id="orgheadline10">On a single board computer (SBC)</h3>
314
-<div class="outline-text-3" id="text-orgheadline10">
315
+<div id="outline-container-orgheadline11" class="outline-3">
316
+<h3 id="orgheadline11">On a single board computer (SBC)</h3>
317
+<div class="outline-text-3" id="text-orgheadline11">
315 318
 <p>
316 319
 Currently the following boards are supported:
317 320
 </p>
@@ -393,9 +396,9 @@ Using the password 'freedombone'. Take a note of the new login password and then
393 396
 </div>
394 397
 </div>
395 398
 
396
-<div id="outline-container-orgheadline11" class="outline-3">
397
-<h3 id="orgheadline11">As a Virtual Machine</h3>
398
-<div class="outline-text-3" id="text-orgheadline11">
399
+<div id="outline-container-orgheadline12" class="outline-3">
400
+<h3 id="orgheadline12">As a Virtual Machine</h3>
401
+<div class="outline-text-3" id="text-orgheadline12">
399 402
 <p>
400 403
 Virtualbox and Qemu are supported. You can run a 64 bit Qemu image with:
401 404
 </p>
@@ -425,25 +428,25 @@ If you are using the interactive installer then you will be aked if you wish to
425 428
 </p>
426 429
 </div>
427 430
 
428
-<div id="outline-container-orgheadline12" class="outline-3">
429
-<h3 id="orgheadline12">You have the gnupg keyring on an encrypted USB drive</h3>
430
-<div class="outline-text-3" id="text-orgheadline12">
431
+<div id="outline-container-orgheadline13" class="outline-3">
432
+<h3 id="orgheadline13">You have the gnupg keyring on an encrypted USB drive</h3>
433
+<div class="outline-text-3" id="text-orgheadline13">
431 434
 <p>
432 435
 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.
433 436
 </p>
434 437
 </div>
435 438
 </div>
436
-<div id="outline-container-orgheadline13" class="outline-3">
437
-<h3 id="orgheadline13">You have a number of key fragments on USB drives retrieved from friends</h3>
438
-<div class="outline-text-3" id="text-orgheadline13">
439
+<div id="outline-container-orgheadline14" class="outline-3">
440
+<h3 id="orgheadline14">You have a number of key fragments on USB drives retrieved from friends</h3>
441
+<div class="outline-text-3" id="text-orgheadline14">
439 442
 <p>
440 443
 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>.
441 444
 </p>
442 445
 </div>
443 446
 </div>
444
-<div id="outline-container-orgheadline14" class="outline-3">
445
-<h3 id="orgheadline14">You can specify some ssh login details for friends servers containing key fragments</h3>
446
-<div class="outline-text-3" id="text-orgheadline14">
447
+<div id="outline-container-orgheadline15" class="outline-3">
448
+<h3 id="orgheadline15">You can specify some ssh login details for friends servers containing key fragments</h3>
449
+<div class="outline-text-3" id="text-orgheadline15">
447 450
 <p>
448 451
 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.
449 452
 </p>
@@ -582,9 +585,9 @@ On your internet router, typically under firewall settings, open the following p
582 585
 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:
583 586
 </p>
584 587
 </div>
585
-<div id="outline-container-orgheadline15" class="outline-3">
586
-<h3 id="orgheadline15">Master Keydrive</h3>
587
-<div class="outline-text-3" id="text-orgheadline15">
588
+<div id="outline-container-orgheadline16" class="outline-3">
589
+<h3 id="orgheadline16">Master Keydrive</h3>
590
+<div class="outline-text-3" id="text-orgheadline16">
588 591
 <p>
589 592
 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:
590 593
 </p>
@@ -602,9 +605,9 @@ Select <i>Backup and Restore</i> then <i>Backup GPG key to USB (master keydrive)
602 605
 </p>
603 606
 </div>
604 607
 </div>
605
-<div id="outline-container-orgheadline16" class="outline-3">
606
-<h3 id="orgheadline16">Fragment keydrives</h3>
607
-<div class="outline-text-3" id="text-orgheadline16">
608
+<div id="outline-container-orgheadline17" class="outline-3">
609
+<h3 id="orgheadline17">Fragment keydrives</h3>
610
+<div class="outline-text-3" id="text-orgheadline17">
608 611
 <p>
609 612
 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:
610 613
 </p>
@@ -646,6 +649,27 @@ freedombone-client
646 649
 </div>
647 650
 </div>
648 651
 </div>
652
+
653
+<div id="outline-container-orgheadline8" class="outline-2">
654
+<h2 id="orgheadline8">Administering the system</h2>
655
+<div class="outline-text-2" id="text-orgheadline8">
656
+<p>
657
+To administer the system after installation log in via ssh, become the root user and then launch the control panel.
658
+</p>
659
+
660
+<div class="org-src-container">
661
+
662
+<pre class="src src-bash">ssh myusername@freedombone.local -p 2222
663
+sudo su
664
+control
665
+</pre>
666
+</div>
667
+
668
+<p>
669
+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.
670
+</p>
671
+</div>
672
+</div>
649 673
 </div>
650 674
 <div id="postamble" class="status">
651 675