From 33dfc726b8aa9f629a701eaad26e75633a560f6b Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Mon, 3 Jul 2017 12:29:43 +0100 Subject: [PATCH] Update documentation for v3 --- doc/EN/beaglebone.org | 2 + doc/EN/homeserver.org | 2 + doc/EN/installation.org | 2 + doc/EN/mesh.org | 13 ++-- website/EN/beaglebone.html | 15 +++-- website/EN/homeserver.html | 4 +- website/EN/installation.html | 118 ++++++++++++++++++----------------- website/EN/mesh.html | 101 +++++++++++++++--------------- 8 files changed, 136 insertions(+), 121 deletions(-) diff --git a/doc/EN/beaglebone.org b/doc/EN/beaglebone.org index 54b26977..4cc220dd 100644 --- a/doc/EN/beaglebone.org +++ b/doc/EN/beaglebone.org @@ -41,6 +41,7 @@ On your laptop or desktop prepare a microSD card image as follows. To create an sudo apt-get install git git clone https://github.com/bashrc/freedombone cd freedombone +git checkout stretch sudo make install freedombone-image --setup debian #+end_src @@ -51,6 +52,7 @@ Or on Arch/Parabola: sudo pacman -S git git clone https://github.com/bashrc/freedombone cd freedombone +git checkout stretch sudo make install freedombone-image --setup parabola #+end_src diff --git a/doc/EN/homeserver.org b/doc/EN/homeserver.org index 1074e527..952bdd1f 100644 --- a/doc/EN/homeserver.org +++ b/doc/EN/homeserver.org @@ -23,6 +23,7 @@ First install freedombone onto your local system (not the target hardware that y sudo apt-get install git git clone https://github.com/bashrc/freedombone cd freedombone +git checkout stretch sudo make install freedombone-image --setup debian freedombone-image -t i386 --onion yes @@ -34,6 +35,7 @@ Or on Arch/Parabola: sudo pacman -S git git clone https://github.com/bashrc/freedombone cd freedombone +git checkout stretch sudo make install freedombone-image --setup parabola freedombone-image -t i386 --onion yes diff --git a/doc/EN/installation.org b/doc/EN/installation.org index 489298c6..fc0a1d8f 100644 --- a/doc/EN/installation.org +++ b/doc/EN/installation.org @@ -35,6 +35,7 @@ Install the freedombone commands onto your laptop/desktop: sudo apt-get install git build-essential dialog git clone https://github.com/bashrc/freedombone cd freedombone +git checkout stretch sudo make install #+END_SRC @@ -224,6 +225,7 @@ sudo apt-get update sudo apt-get install git dialog haveged build-essential git clone https://github.com/bashrc/freedombone cd freedombone +git checkout stretch sudo make install freedombone-client #+END_SRC diff --git a/doc/EN/mesh.org b/doc/EN/mesh.org index 1ae47a52..cdaf65ef 100644 --- a/doc/EN/mesh.org +++ b/doc/EN/mesh.org @@ -110,15 +110,16 @@ sudo apt-get -y install build-essential libc6-dev-i386 wget \ vmdebootstrap xz-utils dosfstools btrfs-tools extlinux \ python-distro-info mbr qemu-user-static binfmt-support \ u-boot-tools qemu -wget https://freedombone.net/downloads/freedombone-mesh-13-09-2016.tar.gz -wget https://freedombone.net/downloads/freedombone-mesh-13-09-2016.tar.gz.sig -gpg --verify freedombone-mesh-13-09-2016.tar.gz.sig -sha256sum freedombone-mesh-13-09-2016.tar.gz -3e279f8ed762afb682bec6bd463830087354dd2f24020f3b0de51143585ab0ed -tar -xzvf freedombone-mesh-13-09-2016.tar.gz +wget https://freedombone.net/downloads/v3/freedombone-3.tar.gz +wget https://freedombone.net/downloads/freedombone-3.tar.gz.sig +gpg --verify freedombone-3.tar.gz.sig +sha256sum freedombone-3.tar.gz + +tar -xzvf freedombone-3.tar.gz cd freedombone git checkout stretch sudo make install +freedombone-image --setup debian freedombone-image -t i386 -v meshclient #+end_src diff --git a/website/EN/beaglebone.html b/website/EN/beaglebone.html index f81eab6c..b29dcc13 100644 --- a/website/EN/beaglebone.html +++ b/website/EN/beaglebone.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -71,6 +71,7 @@ pre.src-fortran:before { content: 'Fortran'; } pre.src-gnuplot:before { content: 'gnuplot'; } pre.src-haskell:before { content: 'Haskell'; } + pre.src-hledger:before { content: 'hledger'; } pre.src-java:before { content: 'Java'; } pre.src-js:before { content: 'Javascript'; } pre.src-latex:before { content: 'LaTeX'; } @@ -188,7 +189,7 @@ @licstart The following is the entire license notice for the JavaScript code in this tag. -Copyright (C) 2012-2013 Free Software Foundation, Inc. +Copyright (C) 2012-2017 Free Software Foundation, Inc. The JavaScript code in this tag is free software: you can redistribute it and/or modify it under the terms of the GNU @@ -285,12 +286,13 @@ On your laptop or desktop prepare a microSD card image as follows. To create an

-
sudo apt-get install git
+
sudo apt-get install git
 git clone https://github.com/bashrc/freedombone
 cd freedombone
+git checkout stretch
 sudo make install
 freedombone-image --setup debian
-

+

@@ -298,12 +300,13 @@ Or on Arch/Parabola:

-
sudo pacman -S git
+
sudo pacman -S git
 git clone https://github.com/bashrc/freedombone
 cd freedombone
+git checkout stretch
 sudo make install
 freedombone-image --setup parabola
-

+
diff --git a/website/EN/homeserver.html b/website/EN/homeserver.html index 3b46c1d4..63653e84 100644 --- a/website/EN/homeserver.html +++ b/website/EN/homeserver.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -259,6 +259,7 @@ First install freedombone onto your local system (not the target hardware that y 
sudo apt-get install git
 git clone https://github.com/bashrc/freedombone
 cd freedombone
+git checkout stretch
 sudo make install
 freedombone-image --setup debian
 freedombone-image -t i386 --onion yes
@@ -273,6 +274,7 @@ Or on Arch/Parabola:
 
sudo pacman -S git
 git clone https://github.com/bashrc/freedombone
 cd freedombone
+git checkout stretch
 sudo make install
 freedombone-image --setup parabola
 freedombone-image -t i386 --onion yes
diff --git a/website/EN/installation.html b/website/EN/installation.html
index 218eb595..0dc1d06a 100644
--- a/website/EN/installation.html
+++ b/website/EN/installation.html
@@ -3,7 +3,7 @@
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
 
-
+
 
 
 
@@ -256,11 +256,11 @@ for the JavaScript code in this tag.
 
 
 
-Building an image for a Single Board Computer or Virtual Machine
+Building an image for a Single Board Computer or Virtual Machine
 
 
 
-Checklist
+Checklist
 
 
 
@@ -268,34 +268,34 @@ for the JavaScript code in this tag.
 
 
 
-Installation
+Installation
 
 
 
-Social Key Management - the 'Unforgettable Key'
+Social Key Management - the 'Unforgettable Key'
 
 
 
-Final Setup
+Final Setup
 
 
 
-Keydrives
+Keydrives
 
 
 
-On Client Machines
+On Client Machines
 
 
 
-Administering the system
+Administering the system
 
 
 
 
-

-
Building an image for a Single Board Computer or Virtual Machine

-

+

+
Building an image for a Single Board Computer 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.
 

@@ -308,6 +308,7 @@ Install the freedombone commands onto your laptop/desktop:
 
sudo apt-get install git build-essential dialog
 git clone https://github.com/bashrc/freedombone
 cd freedombone
+git checkout stretch
 sudo make install
 

 

@@ -372,9 +373,9 @@ If the image build fails with an error such as "Error reading from server. Re
 

 

 
-

-
Checklist

-

+

+
Checklist

+

 

 Before installing Freedombone you will need a few things.
 

@@ -388,17 +389,17 @@ Before installing Freedombone you will need a few things.
 
 

 

-

-
Installation

-

+

+
Installation

+

 

 There are three install options: Laptop/Desktop/Netbook, SBC and Virtual Machine.
 

 

 
-

-
On a Laptop, Netbook or Desktop machine

-

+

+
On a Laptop, Netbook or Desktop machine

+

 

 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 Stretch 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:
 

@@ -417,9 +418,9 @@ freedombone menuconfig
 

 

 
-

-
On a single board computer (SBC)

-

+

+
On a single board computer (SBC)

+

 

 Currently the following boards are supported:
 

@@ -497,9 +498,9 @@ Using the password 'freedombone'. Take a note of the new login password and then
 

 

 
-

-
As a Virtual Machine

-

+

+
As a Virtual Machine

+

 

 Qemu is currently supported, since it's s fully free software system. You can run a 64 bit Qemu image with:
 

@@ -516,42 +517,42 @@ The default login will be username 'fbone' and password 'freedombone'. Take a no
 

 

 
-

-
Social Key Management - the 'Unforgettable Key'

-

+

+
Social Key Management - the 'Unforgettable Key'

+

 

 During the install procedure you will be asked if you wish to import GPG keys. If you don't already possess GPG keys then just select "Ok" and they will be generated during the install. If you do already have GPG keys then there are a few possibilities
 

 

 
-

-
You have the gnupg keyring on an encrypted USB drive

-

+

+
You have the gnupg keyring on an encrypted USB drive

+

 

 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.
 

 

 

-

-
You have a number of key fragments on USB drives retrieved from friends

-

+

+
You have a number of key fragments on USB drives retrieved from friends

+

 

-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 Keydrives.
+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 Keydrives.
 

 

 

-

-
You can specify some ssh login details for friends servers containing key fragments

-

+

+
You can specify some ssh login details for friends servers containing key fragments

+

 

 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.
 

 

 

 

-

-
Final Setup

-

+

+
Final Setup

+

 

 Any manual post-installation setup instructions or passwords can be found in /home/username/README.
 

@@ -669,16 +670,16 @@ On your internet router, typically under firewall settings, open the following p
 

 

 
-

-
Keydrives

-

+

+
Keydrives

+

 

 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:
 

 

-

-
Master Keydrive

-

+

+
Master Keydrive

+

 

 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 done from the Disk Utility application. Then plug it into the Freedombone system, then from your local machine run:
 

@@ -693,9 +694,9 @@ Select Administrator controls then Backup and Restore then Back
 

 

 

-

-
Fragment keydrives

-

+

+
Fragment keydrives

+

 

 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 can be done from the Disk Utility application. Plug it into the Freedombone system then from your local machine run the following commands:
 

@@ -715,9 +716,9 @@ Fragments are randomly assigned and so you will need at least three or four keyd
 

 

 

-

-
On Client Machines

-

+

+
On Client Machines

+

 

 You can configure laptops or desktop machines which connect to the Freedombone server in the following way. This alters encryption settings to improve overall security.
 

@@ -727,6 +728,7 @@ You can configure laptops or desktop machines which connect to the Freedombone s
 sudo apt-get install git dialog haveged build-essential
 git clone https://github.com/bashrc/freedombone
 cd freedombone
+git checkout stretch
 sudo make install
 freedombone-client
 

@@ -734,9 +736,9 @@ freedombone-client
-
-

Administering the system

-
+
+

Administering the system

+

To administer the system after installation log in via ssh, become the root user and then launch the control panel.

diff --git a/website/EN/mesh.html b/website/EN/mesh.html index 81d82d6e..137a4c8b 100644 --- a/website/EN/mesh.html +++ b/website/EN/mesh.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -274,13 +274,13 @@ for the JavaScript code in this tag. -What the system can do +What the system can do - -Disk Images +Disk Images - -Building Disk Images +Building Disk Images - -How to use it +How to use it @@ -289,9 +289,9 @@ for the JavaScript code in this tag. Mesh networks are useful as a quick way to make a fully decentralised communications system which is not connected to or reliant upon the internet. Think festivals, hacker conferences, onboard ships at sea, disaster/war zones, small business internal office communications, protests, remote areas of the world, temporary "digital blackouts", scientific expeditions and off-world space colonies. The down side is that you can't access any internet content. The upside is that you can securely communicate with anyone on the local mesh. No ISPs. No payments or subscriptions beyond the cost of obtaining the hardware. Systems need to be within wifi range of each other for the mesh to be created. It can be an ultra-convenient way to do purely local communications.

-
-

What the system can do

-
+
+

What the system can do

+
  • Discovery of other users on the network
  • Text based chat, one-to-one and in groups
    • @@ -312,13 +312,13 @@ This system should be quite scalable. Both qTox and IPFS are based upon distribu
-
-

Disk Images

-
+
+

Disk Images

+
-
-

Client images

-
+
+

Client images

+
@@ -365,16 +365,16 @@ sudo dd bs=1M -

Router images

-
+
+

Router images

+

Routers are intended to build network coverage for an area using small and low cost hardware. You can bolt them to walls or leave them on window ledges. They don't have any user interface and their only job is to haul network traffic across the mesh and to enable peers to find each other via running bootstrap nodes for Tox and IPFS. Copy the image to a microSD card and insert it into the router, plug in an Atheros wifi dongle and power on. That should be all you need to do.

-
-

Beaglebone Black

-
+
+

Beaglebone Black

+
@@ -411,9 +411,9 @@ There is still a software freedom issue with the Beaglebone Black, but it doesn'
-
-

Building Disk Images

-
+
+

Building Disk Images

+

It's better not to trust images downloaded from random places on the interwebs. Chances are that unless you are in the web of trust of the above GPG signatures then they don't mean very much to you. If you actually want something trustworthy then build the images from scratch. It will take some time. Here's how to do it.

@@ -428,15 +428,16 @@ First you will need to create an image. On a Debian based system (tested on Debi vmdebootstrap xz-utils dosfstools btrfs-tools extlinux \ python-distro-info mbr qemu-user-static binfmt-support \ u-boot-tools qemu -wget https://freedombone.net/downloads/freedombone-mesh-13-09-2016.tar.gz -wget https://freedombone.net/downloads/freedombone-mesh-13-09-2016.tar.gz.sig -gpg --verify freedombone-mesh-13-09-2016.tar.gz.sig -sha256sum freedombone-mesh-13-09-2016.tar.gz -3e279f8ed762afb682bec6bd463830087354dd2f24020f3b0de51143585ab0ed -tar -xzvf freedombone-mesh-13-09-2016.tar.gz +wget https://freedombone.net/downloads/v3/freedombone-3.tar.gz +wget https://freedombone.net/downloads/freedombone-3.tar.gz.sig +gpg --verify freedombone-3.tar.gz.sig +sha256sum freedombone-3.tar.gz + +tar -xzvf freedombone-3.tar.gz cd freedombone git checkout stretch sudo make install +freedombone-image --setup debian freedombone-image -t i386 -v meshclient
@@ -503,9 +504,9 @@ The resulting image can be copied to a microSD card, inserted into a Beaglebone
-
-

Customisation

-
+
+

Customisation

+

If you want to make your own specially branded version, such as for a particular event, then to change the default desktop backgrounds edit the images within img/backgrounds and to change the available avatars and desktop icons edit the images within img/avatars. Re-create disk images using the instructions shown previously.

@@ -515,9 +516,9 @@ If you need particular dconf commands to alter desktop appearance or beha

-
-

How to use it

-
+
+

How to use it

+

When you first boot from the USB drive the system will create some encryption keys, assign a unique network address to the system and then reboot itself. When that's done you should see a prompt asking for a username. This username just makes it easy for others to initially find you on the mesh and will appear in the list of users.

@@ -527,9 +528,9 @@ After a minute or two if you are within wifi range and there is at least one oth

-
-

Set the Date

-
+
+

Set the Date

+

On the ordinary internet the date and time of your system would be set automatically via NTP. But this is not the internet and so you will need to manually ensure that your date and time settings are correct. You might need to periodically do this if your clock drifts. It's not essential that the time on your system be highly accurate, but if it drifts too far or goes back to epoch then things could become a little confusing in regard to the order of blog posts.

@@ -539,9 +540,9 @@ On the ordinary internet the date and time of your system would be set automatic

-
-

Check network status

-
+
+

Check network status

+

Unlike with ordinary wifi, on the mesh you don't get a signal strength icon and so it's not simple to see if you have a good connection.

@@ -565,9 +566,9 @@ When you are finished close the window and then select the Network Restart
-
-

Chat System

-
+
+

Chat System

+

Ensure that you're within wifi range of at least one other mesh peer (could be a router or client) and then you should see that the Chat and Other Users icons appear. Select the users icon and you should see a list of users on the mesh. Select the Chat icon and once you are connected you should see the status light turn green. If after a few minutes you don't get the green status light then try closing and re-opening the Tox chat application. Select the plus button to add a friend and then copy and paste in a Tox ID from the users list.

@@ -626,9 +627,9 @@ At present video doesn't work reliably, but text and voice chat do work well.
-
-

Sharing Files

-
+
+

Sharing Files

+

You can make files publicly available on the network simply by dragging and dropping them into the Public folder on the desktop. To view the files belonging to another user select the desktop icon called Visit a site and enter the username or Tox ID of the other user.

@@ -643,9 +644,9 @@ You can make files publicly available on the network simply by dragging and drop
-
-

Blogging

-
+
+

Blogging

+

To create a blog post select the Blog icon on the desktop and then use the up and down cursor keys, space bar and enter key to add a new entry. Edit the title of the entry and add your text. You can also include photos if you wish - just copy them to the CreateBlog/content/images directory and then link to them as shown.