freedomboneeee/doc/EN/usage.org

293 lines
16 KiB
Org Mode
Raw Normal View History

2014-10-25 20:09:46 +02:00
#+TITLE:
#+AUTHOR: Bob Mottram
2016-10-31 17:24:49 +01:00
#+EMAIL: bob@freedombone.net
#+KEYWORDS: freedombox, debian, beaglebone, hubzilla, email, web server, home server, internet, censorship, surveillance, social network, irc, jabber
2014-10-25 20:09:46 +02:00
#+DESCRIPTION: Turn the Beaglebone Black into a personal communications server
2015-07-05 20:58:40 +02:00
#+OPTIONS: ^:nil toc:nil
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="freedombone.css" />
2016-01-07 15:51:37 +01:00
#+BEGIN_CENTER
[[file:images/logo.png]]
#+END_CENTER
2014-10-25 20:09:46 +02:00
#+BEGIN_EXPORT html
2015-12-16 20:56:29 +01:00
<center>
2016-01-07 16:00:30 +01:00
<h1>Usage</h1>
2015-12-16 20:56:29 +01:00
</center>
#+END_EXPORT
2015-12-16 20:56:29 +01:00
2016-01-08 15:22:58 +01:00
| [[Readme]] |
| [[Improving ssh security]] |
2016-01-08 15:09:24 +01:00
| [[Administrating the system via an onion address (Tor)]] |
2016-05-12 22:35:35 +02:00
| [[./mobile.html][Mobile advice]] |
2016-03-28 12:05:46 +02:00
| [[./usage_email.html][Using Email]] |
2016-11-12 19:00:38 +01:00
| [[./app_syncthing.html][Syncing to the Cloud]] |
2016-11-12 21:19:58 +01:00
| [[./app_dlna.html][Play Music]] |
2016-11-12 19:38:02 +01:00
| [[./app_gnusocial.html][Microblogging (GNU Social)]] |
2016-11-12 20:07:24 +01:00
| [[./app_hubzilla.html][Social Network]] |
2016-11-12 21:28:55 +01:00
| [[./app_irc.html][Multi-user chat with IRC]] |
2016-11-12 22:10:41 +01:00
| [[./app_xmpp.html][XMPP/Jabber]] |
2016-11-12 23:21:12 +01:00
| [[./app_tox.html][Tox]] |
2016-01-08 15:22:58 +01:00
| [[Chat Services]] |
2016-02-08 16:52:38 +01:00
| [[RSS Reader]] |
2016-05-12 22:35:35 +02:00
| [[Git Projects]] |
| [[Adding or removing users]] |
2016-10-19 15:18:37 +02:00
| [[Blocking Ads]] |
2014-10-26 00:10:49 +02:00
2014-10-26 09:54:57 +01:00
* 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:
#+BEGIN_SRC bash
ssh username@domainname -p 2222
emacs ~/README
#+END_SRC
2016-08-08 18:21:03 +02:00
You should transfer any passwords to a password manager such as [[https://www.keepassx.org/][KeepassX]] and then delete them from the README file. To save the file after removing passwords use *CTRL-x CTRL-s*.
2014-10-26 09:54:57 +01:00
To exit you can either just close the terminal or use *CTRL-x CTRL-c* followed by the *exit* command.
2014-12-08 19:43:32 +01:00
* 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.
On your local machine:
#+BEGIN_SRC bash
ssh-keygen
#+END_SRC
For extra security you may also want to add a passphrase to the ssh private key. You can show the generated public key with:
#+BEGIN_SRC bash
cat ~/.ssh/id_rsa.pub
#+END_SRC
Log into your system and open the control panel.
2014-12-08 19:43:32 +01:00
#+BEGIN_SRC bash
ssh username@domain -p 2222
#+END_SRC
Select /Administrator controls/ then /Manage Users/ then /Change user ssh public key/. Copy and paste the public key here, then exit.
It's a good idea to also copy the contents of *~/.ssh/id_rsa* and *~/.ssh/id_rsa.pub* to you password manager, together with the private key password if you created one.
2014-12-08 19:43:32 +01:00
There are advantages and disadvantages to using ssh keys for logins. The advantage is that this is much more secure than a memorised password, but the disadvantage is that you need to carry your ssh keys around and be able to install them on any computer of mobile device that you use. In high security or hostile infosec environments it may not be possible to carry or use USB thumb drives containing your keys and so memorised passwords may be the only available choice.
If you wish to only use ssh keys then log in to the Freedombone, become the root user and open the control panel with the 'control' command. Select /Security Settings/ then keep hitting enter until you reach the question about allowing password logins. Select "no" for that, then apply the settings. Any subsequent attempts to log in via a password will then be denied.
2014-12-08 19:43:32 +01:00
2016-01-08 15:09:24 +01:00
* 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:
#+BEGIN_SRC bash
ssh username@freedombone.local -p 2222
#+END_SRC
Select /Administrator controls/ then select "About this system" and look for the onion address for ssh. You can then close the terminal and open another, then do the following on your local system:
#+BEGIN_SRC bash
freedombone-client
#+END_SRC
This will set up your ssh environment to be able to handle onion addresses. In addition if you use monkeysphere then you can do:
#+BEGIN_SRC bash
freedombone-client --ms yes
#+END_SRC
Then you can test ssh with:
2016-01-08 15:09:24 +01:00
#+BEGIN_SRC bash
ssh username@address.onion -p 2222
#+END_SRC
Subsequently even if dynamic DNS isn't working you may still be able to administer your system. Using the onion address also gives you some degree of protection against corporate or government metadata analysis, since it becomes more difficult to passively detect which systems are communicating.
2014-10-25 23:32:36 +02:00
* Chat Services
2016-05-08 11:57:17 +02:00
** VoIP (Voice and text chat)
*** Text chat
In addition to voice it is also possible to do text chat via mumble. The security of this is pretty good provided that you do it via Plumble and Orbot on mobile, but compared to other options such as XMPP/Conversations or Tox the security is not as good, since the mumble server currently doesn't support forward secrecy.
*** Using with Ubuntu
Within the software center search for "mumble" and install the client then run it. Skip through the audio setup wizard.
Click on "add new" to add a new server and enter the default domain name for the Freedombone, your username (which can be anything) and the VoIP server password which can be found in the README file on the Freedombone. Accept the self-signed SSL certificate. You are now ready to chat.
*** Using with Android
Install [[https://f-droid.org/][F-Droid]]
2016-05-08 11:57:17 +02:00
If you don't have Orbot installed then enable The Guardian Project repository from the drop down menu and install it.
Search for and install Plumble.
Press the plus button to add a Mumble server.
Enter a label (which can be any name you choose for the server), the default domain name of the Freedombone, your username (which can also be anything) and the VoIP server password which can be found in the README file on the Freedombone.
2016-05-08 11:57:17 +02:00
Open the settings. Select General, then Connect via Tor. This will provide better protection, making it more difficult for adversaries to know who is talking to who.
Selecting the server by pressing on it then connects you to the server so that you can chat with other connected users.
/Note: if you don't know the default domain name and you did a full installation then it will be the same as the wiki domain name./
2015-11-02 18:46:23 +01:00
** SIP phones
2016-01-07 15:51:37 +01:00
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.
2016-03-22 21:03:03 +01:00
*** About ZRTP
[[https://jitsi.org/Documentation/ZrtpFAQ][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 [[https://en.wikipedia.org/wiki/Stingray_phone_tracker][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
Add an account. Under *General Wizards* choose *Expert* and enter the following details:
| Account name | Your username |
| Account ID | sip:username@yourdomain |
| Registration URI | sip:yourdefaultdomain |
| Realm | * |
| Username | Your username |
| Data (Password) | Your SIP password |
| ZRTP Mode | Create ZRTP |
If everything is working the account should appear in green with a status of *Registered*.
*** Using with Ring
From the menu select *Manage accounts*.
Add an account with the following details:
| Alias | Your full name or nickname |
| Protocol | SIP |
| Hostname | yourdefaultdomain |
| Username | Your username |
| Password | Your SIP password |
Select the *Security* tab. Under *SRTP Key Exchange* select *ZRTP*. Unde *SRTP Preferences* select *Not supported warning* and *Display SAS Once*.
2016-01-07 20:26:08 +01:00
2016-02-08 16:52:38 +01:00
* RSS Reader
2016-02-23 12:45:39 +01:00
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.
2016-04-02 14:53:09 +02:00
[[file:images/rss_reader_mobile.jpg]]
2016-04-02 14:49:39 +02:00
2016-05-31 10:54:46 +02:00
** Finding the onion address
2016-02-23 12:45:39 +01:00
See the control panel for the RSS reader onion address.
2016-02-08 16:52:38 +01:00
#+BEGIN_SRC bash
ssh username@domainname -p 2222
#+END_SRC
Select /Administrator controls/ then select the *About* screen.
2016-02-08 16:52:38 +01:00
2016-03-20 16:24:25 +01:00
The RSS reader is accessible only via an onion address. This provides a reasonable degree of reading privacy, making it difficult for passive adversaries such as governments, corporations or criminals to create lists of sites which you are subscribed to.
2016-02-08 16:52:38 +01:00
2016-08-08 18:21:03 +02:00
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.
2016-02-08 16:52:38 +01:00
2016-05-31 10:54:46 +02:00
** On mobile
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. Remember to add the site to the NoScript whitelist, and you may also need to turn HTTPS Everywhere off.
2016-03-20 16:24:25 +01:00
#+BEGIN_QUOTE
A note for the paranoid is that on mobile devices you get redirected to a different onion address which is specially set up for the mobile interface, so don't be alarmed that it looks like your connection is being hijacked.
#+END_QUOTE
2016-05-31 10:54:46 +02:00
** With Emacs
If you are an Emacs user then you can also read your RSS feeds via the [[https://github.com/dk87/avandu][Avandu]] mode.
Add the following to your configuration, changing the address and password as appropriate.
#+begin_src emacs-lisp :tangle no
(setq avandu-tt-rss-api-url "http://rss_reader_onion_address/api/"
2016-08-08 18:21:03 +02:00
avandu-user "admin"
avandu-password "mypassword")
2016-05-31 10:54:46 +02:00
#+end_src
2016-05-31 10:58:14 +02:00
If you don't already have Emacs set up to route through Tor then also add the following:
#+begin_src emacs-lisp :tangle no
(setq socks-noproxy '("localhost"))
(require 'socks)
(require 'tls)
(setq socks-server (list "Tor socks" "localhost" 9050 5))
2016-06-02 23:56:32 +02:00
#+end_src
2016-05-31 10:58:14 +02:00
And ensure that the Tor daemon is installed:
#+begin_src bash :tangle no
sudo apt-get install tor
#+end_src
2016-05-12 22:35:35 +02:00
* Git Projects
Github is ok, but it's proprietary and funded by venture capital. If you been around on the internet for long enough then you know how this story eventually works itself out - i.e. badly for the users. It's really only a question of time. If you're a software developer or do things which involve the Git version control system then it's a good idea to become accustomed to hosting your own repositories, before the inevitable Github shitstorm happens.
A Git hosting system called [[https://gogs.io][Gogs]] can optionally be installed. This is very similar to Github in appearance and use. It's lightweight and so well suited for use on low power ARM servers.
Navigate to your git site and click the *Register* button. The first user registered on the system becomes the administrator. Once you've done that then it's a good idea to disable further registrations. Currently that's a little complicated, but you can do it as follows:
#+begin_src bash :tangle no
sudo username@domainname -p 2222
#+end_src
Select *Exit to the comand line*.
#+begin_src bash :tangle no
sudo su
2016-10-29 19:09:48 +02:00
sed -i "s|DISABLE_REGISTRATION =.*|DISABLE_REGISTRATION = true|g" /home/gogs/custom/conf/app.ini
2016-11-02 22:32:47 +01:00
sed -i "s|SHOW_REGISTRATION_BUTTON =.*|SHOW_REGISTRATION_BUTTON = false|g" /home/gogs/custom/conf/app.ini
2016-05-12 22:35:35 +02:00
systemctl restart gogs
exit; exit
#+end_src
This will stop any spam accounts being created by random strangers or bots. You might want to mirror existing repos, and at any time a mirror can be converted into the main repo.
* 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
2016-02-08 16:56:57 +01:00
2016-04-02 17:54:40 +02:00
[[file:images/controlpanel/control_panel_manage_users.jpg]]
2016-10-19 15:18:37 +02:00
* Blocking Ads
2016-11-02 12:03:44 +01:00
Everyone except for advertisers hates adverts. Not only are they annoying, but they can consume a lot of bandwidth, be a privacy problem in terms of allowing companies to track your browsing habits and also any badly written scripts they contain may introduce exploitable security holes. Also if you're poor then adverts often make you want things that you can't have.
2016-10-19 15:18:37 +02:00
You can block ads for any devices connected to your local network by installing the *pihole* app from *Add/Remove Apps* on the administrator control panel. This may help to improve overall performance of your devices by not wasting time downloading unwanted images or scripts.
2016-11-02 12:03:44 +01:00
Also don't expect perfection. Though many ads may be blocked by this system some will still get through. It's a constant cat and mouse game between advertisers and blockers.
2016-10-19 15:18:37 +02:00
** Set a static IP address
2016-10-19 16:20:27 +02:00
Ensure that your system has a static local IP address (typically 192.168..) using the option on the control panel. You will also need to know the IP address of your internet router, which is usually *192.168.1.1* or *192.168.1.254*.
2016-10-19 15:18:37 +02:00
2016-10-19 16:20:27 +02:00
When that's done select *About this system* from the control panel and see the IPv4 address. You can use this as a DNS address in two ways:
2016-10-19 15:18:37 +02:00
** On each client system within your local network
#+begin_src bash
sudo chattr -i /etc/resolv.conf
sudo nano /etc/resolv.conf
#+end_src
Comment out any existing entries with a # character and add:
#+begin_src bash
nameserver [IPv4 address from the About screen]
#+end_src
Normally /resolv.conf/ will be overwritten every time your reboot, but you can prevent this with:
#+begin_src bash
sudo chattr +i /etc/resolv.conf
#+end_src
** On your internet router
2016-11-02 12:03:44 +01:00
If you can access the settings on your local internet router then this is the simplest way to provide ad blocking for all devices which connect to it. Unfortunately some router models don't let you edit the DNS settings and if that's the case you might want to consider getting a different router.
2016-10-19 15:18:37 +02:00
Edit the DNS settings and add the IPv4 address which you got from the control panel About screen. Exactly how you do this will just depend upon your particular router model. You may also need to set the same address twice, because two addresses are conventional.
2016-11-02 12:03:44 +01:00
*** LibreCMC
On a router running LibreCMC from the *Network* menu select *DHCP and DNS*. Enter the static IP address of your Freedombone system within *DNS Forwardings*, then at the bottom of the page click on *Save & Apply*. Any devices which connect to your router will now have ad blocking.
2016-10-19 15:18:37 +02:00
** Configuring block lists
You can configure the block lists which the system uses by going to the *administrator control panel*, selecting *App Settings* then choosing *pihole*. You can also add any extra domain names to the whitelist if they're being wrongly blocked or to the blacklist if they're not blocked by the current lists.
2016-10-19 15:31:01 +02:00
#+BEGIN_EXPORT html
<center>
Return to the <a href="index.html">home page</a>
</center>
#+END_EXPORT