From b9d40014064d597cf46bb20d54cc22d8cb87528f Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Wed, 17 Dec 2014 20:08:32 +0000 Subject: [PATCH] Usage web page --- website/usage.html | 414 ++++++++++++++++++++------------------------- 1 file changed, 187 insertions(+), 227 deletions(-) diff --git a/website/usage.html b/website/usage.html index 99dcb42b..3c809e41 100644 --- a/website/usage.html +++ b/website/usage.html @@ -4,7 +4,7 @@ - + @@ -91,6 +91,10 @@ { background-color: #ffff00; color: #000000; font-weight: bold; } /*]]>*/--> + + + +
+ +

-
@@ -251,21 +181,21 @@ for the JavaScript code in this tag. Home -1 -3 -4 -5 -6 -7 -8 -9 +Readme +Using Email +Mailing List +Syncing to the Cloud +Play Music +Microblogging +Social Network +Chat Services -
-

1 Readme

-
+
+

Readme

+

After the system has installed a README file will be generated which contains passwords and some brief advice on using the installed systems. You can read this with the following commands:

@@ -286,9 +216,9 @@ To exit you can either just close the terminal or use CTRL-x CTRL-c follo

-
-

2 Improving ssh security

-
+
+

Improving ssh security

+

To improve ssh security you can generate an ssh key pair on your system and then upload the public key to the Freedombone.

@@ -342,20 +272,20 @@ If you wish to only use ssh keys then log in to the Freedombone and edit /etc
-
-

3 Using Email

-
-
-

3.1 A technical note about email transport security

-
+
+

Using Email

+
+
+

A technical note about email transport security

+

Port 465 is used for SMTP and this is supposedly deprecated for secure email. However, using TLS from the start of the communications seems far more secure than starting off with insecure communications and then trying to upgrade it with a command to begin TLS, as happens with STARTTLS. There are possible attacks against STARTTLS in which the command to begin secure communications is removed or overwritten which could then result in email being transferred in plain text over the internet and be readable by third parties.

-
-

3.2 Add a password to your GPG key

-
+
+

Add a password to your GPG key

+

If you didn't use existing GPG keys during the Freedombone installation then you'll need to add a password to your newly generated private key. This is highly recommended. Go through the following sequence of commands to ssh into the Freedombone and then change your GPG password.

@@ -367,7 +297,7 @@ gpg --edit-key username@domain passwd save quit -exit +exit
@@ -377,9 +307,9 @@ Having a password on your GPG key will prevent someone from reading your email <
-
-

3.3 Publishing your GPG public key

-
+
+

Publishing your GPG public key

+

If you havn't already then you should publish your GPG public key so that others can find it.

@@ -388,14 +318,14 @@ If you havn't already then you should publish your GPG public key so that others 
ssh username@domainname -p 2222
 gpg --send-keys username@domainname
-exit
+exit
-
-

3.4 Mutt email client

-
+
+

Mutt email client

+

Mutt is a terminal based email client which comes already installed onto the Freedombone. To access it you'll need to access it via ssh with:

@@ -538,9 +468,9 @@ When reading emails you will initially need to enter your GPG password. It will
-
-

3.5 Thunderbird

-
+
+

Thunderbird

+

Another common way in which you may want to access email is via Thunderbird. This may be especially useful if you're trying to convert former Windows users who may previously have been using some version of Outlook.

@@ -550,9 +480,9 @@ The following instructions should be carried out on the client machines (laptop,

-
-

3.5.1 Initial setup

-
+
+

Initial setup

+

Install Thunderbird and Enigmail. How you do this just depends upon your distro and software manager or "app store".

@@ -611,9 +541,9 @@ Select "yes" to change default settings.

-
-

3.5.2 Import your GPG keys

-
+
+

Import your GPG keys

+

On the Freedombone export your GPG public and private keys.

@@ -662,9 +592,9 @@ shred -zu ~/private_key.gpg
-
-

3.5.3 Using for the first time

-
+
+

Using for the first time

+

Click on the Thunderbird menu, which looks like three horizontal bars on the right hand side.

@@ -699,9 +629,9 @@ Get into the habit of using email encryption and encourage others to do so. Rem
-
-

3.5.4 Making folders visible

-
+
+

Making folders visible

+

By default you won't be able to see any folders which you may have created earlier using the mailinglistrule script. To make folders visible select:

@@ -717,17 +647,17 @@ Make sure that "show only subscribed folders" is not checked. Then click
-
-

3.6 K9 Android client

-
+
+

K9 Android client

+

NOTE: Currently the K9 email client will not work with the Freedombone since it doesn't support PGP/MIME encoding. However, there is development work taking place on that feature and it is hoped that K9 may be usable in the near future.

-
-

3.6.1 Incoming server settings

-
+
+

Incoming server settings

+
  • Select settings/account settings
    • @@ -746,9 +676,9 @@ Make sure that "show only subscribed folders" is not checked. Then click
-
-

3.6.2 Outgoing (SMTP) server settings

-
+
+

Outgoing (SMTP) server settings

+
  • Select settings/account settings
    • @@ -769,9 +699,9 @@ Make sure that "show only subscribed folders" is not checked. Then click
-
-

3.6.3 Folders

-
+
+

Folders

+

To view any new folders which you may have created using the mailinglistrule script from your inbox press the K9 icon at the top left to access folders, then press the menu button and select refresh folder list.

@@ -783,9 +713,9 @@ If your folder still doesn't show up then press the menu button, select <
-
-

3.7 Subscribing to mailing lists

-
+
+

Subscribing to mailing lists

+

To subscribe to a mailing list so that it appears within Mutt or Thunderbird.

@@ -794,7 +724,7 @@ To subscribe to a mailing list so that it appears within Mutt or Thunderbird. 
ssh username@domainname -p 2222
 addmailinglist <username> <mailinglistname> <subjecttag>
-exit
+exit
@@ -803,9 +733,9 @@ The subject tag should be the word or phrase which appears within the brackets i

-
-

3.8 Adding email addresses to a group/folder

-
+
+

Adding email addresses to a group/folder

+

Similar to adding mailing list folders you can also add specified email addresses into a folder.

@@ -814,7 +744,7 @@ Similar to adding mailing list folders you can also add specified email addresse 
ssh username@domainname -p 2222
 addemailtofolder <username> <emailaddress> <mailinglistname>
-exit
+exit
@@ -825,9 +755,9 @@ The mailing list name should be something short so that it is readable within th
-
-

4 Mailing List

-
+
+

Mailing List

+

If you want to set up a public mailing list then when installing the system remember to set the PUBLIC_MAILING_LIST variable within freedombone.cfg to the name of your list. The name should have no spaces in it. Public mailing lists are unencrypted so anyone will be able to read the contents, including non subscribers.

@@ -847,12 +777,12 @@ Tip: When using the Mutt email client if you want to send an email in cleartext

-
-

5 Syncing to the Cloud

-
-
-

5.1 Initial install

-
+
+

Syncing to the Cloud

+
+
+

Initial install

+

Within a browser go to your owncloud domain, then create an administrator account. The username and password can be anything, and ideally should be generated from a password manager.

@@ -877,7 +807,7 @@ You will also need to enter database details: Owncloud database password -See the 1 file +See the Readme file @@ -896,9 +826,9 @@ Log out from the administrator account and then log back in as the user you just

-
-

5.2 On Android

-
+
+

On Android

+

Within F-droid search for owncloud and install the client. Also install CalDAV Sync Adapter.

@@ -922,9 +852,9 @@ You will also be prompted to enter login details. Your Android and Owncloud cale

-
-

5.3 On Linux

-
+
+

On Linux

+

Open your software center and search for "owncloud client". Enter your owncloud domain name (with the https prefix) and login details.

@@ -935,12 +865,12 @@ You can now drag files into the ~/owncloud directory and they will automa
-
-

6 Play Music

-
-
-

6.1 With the DLNA service

-
+
+

Play Music

+
+
+

With the DLNA service

+

An easy way to play music on any mobile device in your home is to use the DLNA service. Copy your music into a directory called "Music" on a USB thumb drive and then insert it into from socket on the Beaglebone.

@@ -980,9 +910,9 @@ The DLNA service will only work within your local home network, and isn't remote
-
-

6.2 With Owncloud

-
+
+

With Owncloud

+

The main advantage of playing music via Owncloud is that you can do that from anywhere - not only within your home network.

@@ -994,12 +924,12 @@ By default a music player is installed into Owncloud, so all you need to do is t
-
-

7 Microblogging

-
-
-

7.1 Initial configuration

-
+
+

Microblogging

+
+
+

Initial configuration

+

To set up your microblog go to:

@@ -1050,7 +980,7 @@ and enter the following settings: DB Password -See the MariaDB password in the 1 file +See the MariaDB password in the Readme file @@ -1060,7 +990,7 @@ and enter the following settings: Administrator password -See the 1 file +See the Readme file @@ -1107,12 +1037,12 @@ When the install is complete you will see a lot of warnings but just ignore thos
-
-

8 Social Network

-
-
-

8.1 Certificates

-
+
+

Social Network

+
+
+

Certificates

+

You will need to have a non self-signed SSL certificate in order to use Red Matrix. Put the public certificate in /etc/ssl/certs/yourredmatrixdomainname.crt and the private certificate in /etc/ssl/private/yourredmatrixdomainname.key. If there is an intermediate certificate needed (such as with StartSSL) then this will need to be concatenated onto the end of the crt file, like this:

@@ -1129,9 +1059,9 @@ Then change ssl_certificate to /etc/ssl/certs/yourredmatrixdomainname.bundle.

-
-

8.2 Initial install

-
+
+

Initial install

+

Visit the URL of your Red Matrix site and you should be taken through the rest of the installation procedure. Note that this may take a few minutes so don't be concerned if it looks as if it has crashed - just leave it running.

@@ -1142,21 +1072,21 @@ When installation is complete you can register a new user.
-
-

9 Chat Services

-
-
-

9.1 IRC

-
+
+

Chat Services

+
+
+

IRC

+

IRC is useful for multi-user chat. The classic use case is for software development where many engineers might need to coordinate their activities, but it's also useful for meetings, parties and general socialising.

-
-

9.1.1 Irssi

-
+
+

Irssi

+

-If you are using the irssi IRC client then you can use the following commands to connect to your IRC server. +If you are using the irssi IRC client then you can use the following commands to connect to your IRC server.

@@ -1168,9 +1098,9 @@ If you are using the irssi IRC client then yo
-
-

9.1.2 XChat

-
+
+

XChat

+

If you are using the XChat client:

@@ -1206,12 +1136,12 @@ Click close and then connect.
-
-

9.2 XMPP/Jabber

-
-
-

9.2.1 Managing users

-
+
+

XMPP/Jabber

+
+
+

Managing users

+

To add a user:

@@ -1221,8 +1151,8 @@ To add a user: 
ssh username@domainname -p 2222
 su
 prosodyctl adduser newusername@newdomainname
-exit
-exit
+exit
+exit
@@ -1235,8 +1165,8 @@ To change a user password: 
ssh username@domainname -p 2222
 su
 prosodyctl passwd username@domainname
-exit
-exit
+exit
+exit
@@ -1249,8 +1179,8 @@ To remove a user: 
ssh username@domainname -p 2222
 su
 prosodyctl deluser username@domainname.com
-exit
-exit
+exit
+exit
@@ -1263,22 +1193,22 @@ Report the status of the XMPP server: 
ssh username@domainname -p 2222
 su
 prosodyctl status
-exit
-exit
+exit
+exit
-
-

9.2.2 Using with Jitsi

-
+
+

Using with Jitsi

+

Jitsi is the recommended communications client for desktop or laptop systems, since it includes the off the record (OTR) feature which provides some additional security beyond the usual SSL certificates.

-Jitsi can be downloaded from https://jitsi.org +Jitsi can be downloaded from https://jitsi.org/

@@ -1302,9 +1232,9 @@ You can also see this vide

-
-

9.2.3 Using with Ubuntu

-
+
+

Using with Ubuntu

+

The default XMPP client in Ubuntu is Empathy. Using Empathy isn't as secure as using Jitsi, since it doesn't include the off the record feature, but since it's the default it's what many users will have easy access to.

@@ -1322,9 +1252,9 @@ Click on Advanced and make sure that Encryption required and Ig

-
-

9.2.4 Using with Android

-
+
+

Using with Android

+

Install F-Droid

@@ -1354,10 +1284,40 @@ Go back to the initial screen and then using the menu you can add contacts and b
-

Author: Bob Mottram

-

Created: 2014-12-08 Mon 15:20

-

Emacs 24.4.1 (Org mode 8.2.10)

-

Validate

+ + + +
+Back to top | E-mail me +
+ +