From b430a77db2765962723fbcc037e9e53f5ce01fe8 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Sun, 17 Apr 2016 19:23:14 +0100 Subject: [PATCH] Documentation on irc --- doc/EN/usage.org | 16 +-- website/EN/usage.html | 250 ++++++++++++++++++++---------------------- 2 files changed, 124 insertions(+), 142 deletions(-) diff --git a/doc/EN/usage.org b/doc/EN/usage.org index e960e026..a4be386d 100644 --- a/doc/EN/usage.org +++ b/doc/EN/usage.org @@ -190,19 +190,11 @@ The easiest way to use irssi is to connect to your system, like this: ssh myusername@mydomain -p 2222 #+END_SRC -Then select *IRC* from the menu. Irssi is automatically set up to connect to your server and route its messages through the Tor network. Some popular systems such as *Freenode* reject connections coming from Tor (as a very crude attempt to stop trolls) and so if you want to use those you can exit to the command line from the menu and then just type "irssi" to use the system without Tor. - -To connect manually: - -#+BEGIN_SRC bash -irssi -/server add -auto -ssl yourdomainname 6697 -/connect yourdomainname -/join #freedombone -/save -#+END_SRC +Then select *IRC* from the menu. However, other than via this method using ssh, irssi isn't a very good IRC client because it doesn't have the capability to onion route messages, and therefore leaks metadata. For the best security when using your IRC server, use XChat or client which supports Tor. *** XChat -First install xchat and set up its configuration file. +XChat is compatible with proxying via Tor and so provides the best security when connecting to your IRC server. It will allow you to connect to your IRC server's onion address. + +First install XChat and set up its configuration file. #+BEGIN_SRC bash sudo apt-get install tor xchat diff --git a/website/EN/usage.html b/website/EN/usage.html index 8620e6b6..fd2566bd 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"> - + @@ -170,15 +170,15 @@ for the JavaScript code in this tag. -Readme +Readme -Improving ssh security +Improving ssh security -Administrating the system via an onion address (Tor) +Administrating the system via an onion address (Tor) @@ -190,38 +190,38 @@ for the JavaScript code in this tag. -Syncing to the Cloud +Syncing to the Cloud -Play Music +Play Music -Microblogging (GNU Social) +Microblogging (GNU Social) -Social Network +Social Network -Chat Services +Chat Services -RSS Reader +RSS Reader -Adding or removing users +Adding or removing users -
-

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:

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

-
-

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.

@@ -297,9 +297,9 @@ If you wish to only use ssh keys then log in to the Freedombone, become the root
-
-

Administrating the system via an onion address (Tor)

-
+
+

Administrating the system via an onion address (Tor)

+

You can also access your system via the Tor system using an onion address. To find out what the onion address for ssh access is you can do the following:

@@ -328,9 +328,9 @@ Subsequently even if dynamic DNS isn't working you may still be able to administ

-
-

Syncing to the Cloud

-
+
+

Syncing to the Cloud

+

Syncthing provides a similar capability to proprietary systems such as Dropbox, and also is well suited for use with low power single board computers. You can have one or more directories which are synchronized across your various laptops/desktops/devices, and this makes it hard for you to ever lose important files. The manner in which the synchronization is done is pretty secure, such that it would be difficult for passive adversaries (mass surveillance, "men in the middle", etc) to know what files you're sharing. Of course, you don't necessarily need to be running a server in order to use Syncthing, but if you do have a server which is always running then there's always at least one place to synchronize your files to or from.

@@ -340,9 +340,9 @@ Freedombone provides Syncthing shared directories for each user on the system, p

-
-

On a laptop

-
+
+

On a laptop

+

Install syncthing:

@@ -397,9 +397,9 @@ Now wait for a few minutes. Eventually you will see two messages appear within t

-
-

On Android

-
+
+

On Android

+

Install Syncthing and Connectbot from F-droid.

@@ -430,12 +430,12 @@ Now wait for a few minutes or more. Eventually you should receive two notificati
-
-

Play Music

-
-
-

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.

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

Microblogging (GNU Social)

-
+
+

Microblogging (GNU Social)

+

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

@@ -507,20 +507,20 @@ GNU Social has a clutter-free mobile user interface which can be accessed via a
-
-

Social Network

-
-
-

Domains

-
+
+

Social Network

+
+
+

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.

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

Chat Services

-
-
-

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.

-
-

Irssi

-
+
+

Irssi

+

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

@@ -558,29 +558,19 @@ The easiest way to use irssi is to connect to your system, like this:

-Then select IRC from the menu. Irssi is automatically set up to connect to your server and route its messages through the Tor network. Some popular systems such as Freenode reject connections coming from Tor (as a very crude attempt to stop trolls) and so if you want to use those you can exit to the command line from the menu and then just type "irssi" to use the system without Tor. +Then select IRC from the menu. However, other than via this method using ssh, irssi isn't a very good IRC client because it doesn't have the capability to onion route messages, and therefore leaks metadata. For the best security when using your IRC server, use XChat or client which supports Tor. +

+
+
+
+

XChat

+
+

+XChat is compatible with proxying via Tor and so provides the best security when connecting to your IRC server. It will allow you to connect to your IRC server's onion address.

-To connect manually: -

- -
- -
irssi
-/server add -auto -ssl yourdomainname 6697
-/connect yourdomainname
-/join #freedombone
-/save
-
-
-
-
-
-

XChat

-
-

-First install xchat and set up its configuration file. +First install XChat and set up its configuration file.

@@ -752,9 +742,9 @@ Click close and then connect.
-
-

Changing or removing the IRC password

-
+
+

Changing or removing the IRC password

+

By default the IRC server is set up to require a password for users to log in. The password is the same for all users. If you want to change or remove the password:

@@ -772,12 +762,12 @@ Select Administrator controls then IRC Menu and then change the pa
-
-

XMPP/Jabber

-
-
-

Using with Profanity

-
+
+

XMPP/Jabber

+
+
+

Using with Profanity

+

The Profanity shell based user interface and is perhaps the simplest way to use XMPP from a laptop. It's also a good way to ensure that your OTR keys are the same even when logging in from different laptops or devices, and it also means that if those devices later become compomised then there are no locally stored OTR keys to be found.

@@ -867,9 +857,9 @@ When accessed via the user control panel the client is automatically routed thro

-
-

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.

@@ -899,9 +889,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.

@@ -919,17 +909,17 @@ Click on Advanced and make sure that Encryption required and Ig

-
-

Using Tor Messenger

-
+ -
-

Using with Android

-
+
+

Using with Android

+

Install F-Droid

@@ -965,16 +955,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:

@@ -998,12 +988,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.

@@ -1017,9 +1007,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

@@ -1046,24 +1036,24 @@ 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.

-
-

About ZRTP

-
+
+

About ZRTP

+

ZRTP appears to be the current best standard to end-to-end encrypted voice calls, combining good security with simplicity of use. When the initial cryptographic negotiation between phones is done at the start of a call a short authentication string (SAS) is calculated and displayed at both ends. To check that there isn't anyone intercepting the call and acting as a man in the middle - as stingray type devices try to do - the short authentication string can be read out and verbally confirmed between the callers. If it's the same then you can be pretty confident that the call is secure.

-
-

Using with CSIPSimple

-
+
+

Using with CSIPSimple

+

Add an account. Under General Wizards choose Expert and enter the following details:

@@ -1119,9 +1109,9 @@ If everything is working the account should appear in green with a status of

-
-

Using with Ring

-
+
+

Using with Ring

+

From the menu select Manage accounts.

@@ -1174,9 +1164,9 @@ Select the Security tab. Under SRTP Key Exchange select ZRTP
-
-

RSS Reader

-
+
+

RSS Reader

+

The way that RSS reading is set up on Freedombone gives you strong reading privacy. Not only is there onion routing between you and the server but also between the server and the source of the RSS feed. The only down side is that many RSS feeds are still http only, and so could be vulnerable to injection attacks, but it's expected that more of this will go to https in the foreseeable future due to a combination of growing recognition of security issues and systems like Let's Encrypt which make obtaining certificates much easier.

@@ -1220,9 +1210,9 @@ A note for the paranoid is that on mobile devices you get redirected to a differ
-
-

Adding or removing users

-
+
+

Adding or removing users

+

Log into the system with: