diff --git a/doc/EN/usage.org b/doc/EN/usage.org index 215c8ee8..3042a829 100644 --- a/doc/EN/usage.org +++ b/doc/EN/usage.org @@ -19,13 +19,14 @@ | [[Readme]] | | [[Improving ssh security]] | | [[Administrating the system via an onion address (Tor)]] | -| [[./usage_email.html][Using Email]] | +| [[./usage_email.html][Using Email]] | | [[Syncing to the Cloud]] | | [[Play Music]] | | [[Microblogging (GNU Social)]] | | [[Social Network]] | | [[Chat Services]] | | [[RSS Reader]] | +| [[Adding or removing users]] | * 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: @@ -188,48 +189,28 @@ Enter *#freedombone* as the channel name. Click *close* and then *connect*. ** XMPP/Jabber -*** Managing users - -To add a user: +*** using with Profanity +The [[http://profanity.im][Profanity]] shell based user interface and is perhaps the simplest way to use XMPP from a laptop. #+BEGIN_SRC bash -ssh username@domainname -p 2222 -su -freedombone-addxmpp -e newusername@newdomainname -exit -exit +ssh username@domain -p 2222 #+END_SRC -To change a user password: +Then select XMPP and enter your password (for the admin user this can also be found in the README in your home directory). + +Generate an [[https://en.wikipedia.org/wiki/Off-the-Record_Messaging][OTR]] key with: #+BEGIN_SRC bash -ssh username@domainname -p 2222 -su -freedombone-xmpp-pass -e username@domainname -exit -exit +/otr gen #+END_SRC -To remove a user: +Then to start a conversation using OTR: #+BEGIN_SRC bash -ssh username@domainname -p 2222 -su -freedombone-rmxmpp -e username@domainname -exit -exit -#+END_SRC - -Report the status of the XMPP server: - -#+BEGIN_SRC bash -ssh username@domainname -p 2222 -su -prosodyctl status -exit -exit +/otr start otherusername@otheruserdomain #+END_SRC +It's automatically routed through Tor and so if you are also using OTR then this provides protection for both message content and metadata. *** 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. @@ -322,6 +303,19 @@ The RSS reader is accessible only via an onion address. This provides a reasonab To set up the system open http://rss_reader_onion_address/ and log in with username *admin* and the password obtained either at the beginning of the install or from the README file in your home directory. You can then select the *Actions* menu and begin adding your feeds. To access the RSS reader from a mobile device you can install a Tor compatible browser such as [[https://f-droid.org/wiki/page/info.guardianproject.orfox][OrFox]]. It will try to automatically change to the mobile version of the user interface, but if that doesn't work then navigate to http://rss_reader_onion_address/mobile. Remember to add the site to the NoScript whitelist, and you may also need to turn HTTPS Everywhere off. +* Adding or removing users +Log into the system with: + +#+BEGIN_SRC bash +ssh username@domainname -p 2222 +#+END_SRC + +Select *Administrator controls* then *User Management*. Depending upon the type of installation after selecting administrator controls you might need to enter: + +#+BEGIN_SRC bash +sudo su +control +#+END_SRC #+BEGIN_EXPORT html
diff --git a/website/EN/usage.html b/website/EN/usage.html index 10903719..af23ac8c 100644 --- a/website/EN/usage.html +++ b/website/EN/usage.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -208,6 +208,10 @@ for the JavaScript code in this tag. RSS Reader + + +Adding or removing users + @@ -325,9 +329,9 @@ Subsequently even if dynamic DNS isn't working you may still be able to administ

Syncing to the Cloud

-
-

Initial install

-
+
+

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.

@@ -371,9 +375,9 @@ Log out from the administrator account and then log back in as the user you just

-
-

On Android

-
+
+

On Android

+

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

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

-
-

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.

@@ -413,9 +417,9 @@ You can now drag files into the ~/owncloud directory and they will automa

Play Music

-
-

With the DLNA service

-
+
+

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.

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

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.

@@ -472,9 +476,9 @@ By default a music player is installed into Owncloud, so all you need to do is t

Microblogging (GNU Social)

-
-

Initial configuration

-
+
+

Initial configuration

+

To log into your GNU Social site first obtain your username and password from the "microblogging" section of the readme file.

@@ -496,17 +500,17 @@ Navigate to your site and log in. You may then want to select Admin and c

Social Network

-
-

Domains

-
+
+

Domains

+

Both Hubzilla and GNU Social try to obtain certificates automatically at the time of installation via Let's Encrypt. This will likely mean that in order for this to work you'll need to have obtained at least one "official" domain via a domain selling service, since Let's Encrypt mostly doesn't seem to work with free subdomains from sites such as freeDNS.

-
-

Initial install

-
+
+

Initial install

+

On first visiting your Hubzilla site you'll see the login screen. The first thing you need to do is register a new user. The first user on the system then becomes its administrator.

@@ -516,16 +520,16 @@ On first visiting your Hubzilla site you'll see the login screen. The first thin

Chat Services

-
-

IRC

-
+
+

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.

-
-

Irssi

-
+
+

Irssi

+

The easiest way to use irssi is to connect to your system, like this:

@@ -541,9 +545,9 @@ Then select IRC from the menu. Irssi is automatically set up to connect t

-
-

XChat

-
+
+

XChat

+

If you are using the XChat client:

@@ -579,74 +583,55 @@ Click close and then connect.
-
-

XMPP/Jabber

-
-
-

Managing users

-
-

-To add a user: -

- -
- -
ssh username@domainname -p 2222
-su
-freedombone-addxmpp -e newusername@newdomainname
-exit
-exit
-
-
- -

-To change a user password: -

- -
- -
ssh username@domainname -p 2222
-su
-freedombone-xmpp-pass -e username@domainname
-exit
-exit
-
-
- -

-To remove a user: -

- -
- -
ssh username@domainname -p 2222
-su
-freedombone-rmxmpp -e username@domainname
-exit
-exit
-
-
- -

-Report the status of the XMPP server: -

- -
- -
ssh username@domainname -p 2222
-su
-prosodyctl status
-exit
-exit
-
-
-
-
- -
-

Using with Jitsi

+
+

XMPP/Jabber

+
+
+

using with Profanity

+The Profanity shell based user interface and is perhaps the simplest way to use XMPP from a laptop. +

+ +
+ +
ssh username@domain -p 2222
+
+
+ +

+Then select XMPP and enter your password (for the admin user this can also be found in the README in your home directory). +

+ +

+Generate an OTR key with: +

+ +
+ +
/otr gen
+
+
+ +

+Then to start a conversation using OTR: +

+ +
+ +
/otr start otherusername@otheruserdomain
+
+
+ +

+It's automatically routed through Tor and so if you are also using OTR then this provides protection for both message content and metadata. +

+
+
+
+

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.

@@ -675,9 +660,9 @@ You can also see this vide

-
-

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.

@@ -695,17 +680,17 @@ Click on Advanced and make sure that Encryption required and Ig

-
-

Using Tor Messenger

-
+ -
-

Using with Android

-
+
+

Using with Android

+

Install F-Droid

@@ -741,16 +726,16 @@ Then select Next. When chatting you can use the lock icon to encrypt your
-
-

Tox

-
+
+

Tox

+

Tox is an encrypted peer-to-peer messaging system and so should work without Freedombone. It uses a system of nodes which act as a sort of directory service allowing users to find and connect to each other. The Tox node ID on the Freedombone can be found within the README within your home directory. If you have other users connect to your node then you will be able to continue chatting even when no other nodes are available.

-
-

Using the Toxic client

-
+
+

Using the Toxic client

+

Log into your system with:

@@ -767,12 +752,12 @@ Then from the menu select Tox Chat. Tox is encrypted by default and also
-
-

VoIP (Voice chat)

-
-
-

Using with Ubuntu

-
+
+

VoIP (Voice chat)

+
+
+

Using with Ubuntu

+

Within the software center search for "mumble" and install the client then run it. Skip through the audio setup wizard.

@@ -786,9 +771,9 @@ Click on "add new" to add a new server and enter the default domain name for the

-
-

Using with Android

-
+
+

Using with Android

+

Install F-Droid

@@ -815,9 +800,9 @@ Selecting the server by pressing on it then connects you to the server so that y
-
-

SIP phones

-
+
+

SIP phones

+

Freedombone also supports SIP phones The username and domain is the same as for your email address, and the SIP password and extension number will appear within the README file in your home directory. Various SIP client options are available, such as CSipSimple on Android and Jitsi on desktop or laptop machines. Ideally use clients which support ZRTP, which will provide the best level of security.

@@ -858,6 +843,31 @@ To set up the system open http://rss_

To access the RSS reader from a mobile device you can install a Tor compatible browser such as OrFox. It will try to automatically change to the mobile version of the user interface, but if that doesn't work then navigate to http://rss_reader_onion_address/mobile. Remember to add the site to the NoScript whitelist, and you may also need to turn HTTPS Everywhere off.

+
+
+
+

Adding or removing users

+
+

+Log into the system with: +

+ +
+ +
ssh username@domainname -p 2222
+
+
+ +

+Select Administrator controls then User Management. Depending upon the type of installation after selecting administrator controls you might need to enter: +

+ +
+ +
sudo su
+control
+
+
Return to the home page