freedombone/README.md

The Freedombone system can be installed onto a Beaglebone Black, or any system capable of running Debian Jessie, and allows you to host your own email and web services. With Freedombone you can enjoy true freedom and independence in the cloud. It comes in a variety of flavours.

• Full install: Installs eveything
• Mailbox: An email server with GPG encryption and mailing list
• Cloud: Share files, maintain a calendar and collaborate on document editing
• Social: Social networking with Red Matrix and GNU Social
• Media: Runs media services such as DLNA to play music or videos on your devices
• Writer: Host your blog and wiki
• Chat: Encrypted IRC and XMPP services for one-to-one and many-to-many chat
• Nonmailbox: Installs eveything except for the email server

Freedombone has an emphasis on security and privacy, and when installed on a Beaglebone Black it uses the built-in hardware random number generator as an entropy source. All communications with the box are encrypted by default using the recommendations from https://bettercrypto.org. The firewall is configured to only allow communications on the necessary ports and to drop all other packets, icmp is disabled by default, emails are stored in encrypted form using your public key and time synchronisation occurs via TLS only. Backups are also encrypted and can be local or remote.

Freedombone is, and shall remain, 100% free software. Non-free repositories are removed automatically upon installation.

Installation

To get started you will need:

• A Beaglebone Black
• A MicroSD card
• Ethernet cable
• Optionally a 5V 2A power supply for the Beaglebone Black
• Access to the internet via a router with ethernet sockets
• USB thumb drive (for backups or storing media)
• One or more domains available via a dynamic DNS provider, such as https://freedns.afraid.org
• A purchased domain name and SSL certificate (only needed for Red Matrix)
• A laptop or desktop machine with the ability to write to a microSD card (might need an adaptor)

You will also need to know, or find out, the IP address of your internet router and have a suitable static IP address for the Beaglebone on your local network. The router should allow you to forward ports to the Beaglebone (often this is under firewall or "advanced" settings).

You can either install from a debian package or manually as follows:

sudo apt-get install git
git clone https://github.com/bashrc/freedombone
cd freedombone
sudo make install

Plug the microSD card into your laptop/desktop and then run the freedombone-prep command. For example:

freedombone-prep -d /dev/sdX --ip <static LAN IP> --iprouter <router LAN IP>

where /dev/sdX is the device name for the microSD card. Often it's /dev/sdb or /dev/sdc, depending upon how many drives there are on your system. The script will download the Debian installer and update the microSD card. It can take a while, so be patient.

When the initial setup is done follow the instructions on screen to run the main freedombone command.

On the system where freedombone is to be installed create a configuration file.

ssh username@freedombone_IP_address
su
apt-get install git
git clone https://github.com/bashrc/freedombone
cd freedombone
make install
nano /home/username/freedombone/freedombone.cfg

Add the following, and set the values as needed.

MY_EMAIL_ADDRESS=
MY_NAME=
MY_BLOG_TITLE=
MY_BLOG_SUBTITLE=
FULLBLOG_DOMAIN_NAME=
MICROBLOG_DOMAIN_NAME=
REDMATRIX_DOMAIN_NAME=
OWNCLOUD_DOMAIN_NAME=
WIKI_DOMAIN_NAME=
WIKI_TITLE=
ENABLE_CJDNS=no
LOCAL_NETWORK_STATIC_IP_ADDRESS=
ROUTER_IP_ADDRESS=

Both of the IP addresses are local IP addresses, typically of the form 192.168.x.x, with one being for the system and the other being for the internet router.

If you are using FreeDNS as a dynamic DNS provider then you can add the following to your configuration file, setting the subdomain codes as appropriate. You can find the codes on the FreeDNS site under "Dynamic DNS" followed by "quick cron example" then look for the code on the last line between the ? and = characters.

FULLBLOG_FREEDNS_SUBDOMAIN_CODE=
REDMATRIX_FREEDNS_SUBDOMAIN_CODE=
MICROBLOG_FREEDNS_SUBDOMAIN_CODE=
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=
WIKI_FREEDNS_SUBDOMAIN_CODE=

Save the configuration file and exit from your editor.

Now you can begin the installation. If you are doing this on a Beaglebone Black:

freedombone --bbb -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]

Or on any other system don't include the --bbb option.

freedombone -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]

The above command should be run in the same directory in which your configuration file exists. You can use any of your domains as the default one, but typically the default domain is the same as the one for your wiki. If you are using FreeDNS as the dynamic DNS provider then also add the -c option to specify the code corresponding to the subdomain.

Also see the manpage for additional options which can be used instead of a configuration file. If you don't specify a variant type with the final option then everything will be installed. If you have a freedombone.cfg file then it should be in the same directory from which the freedombone command is run.

Installation is not quick, and depends upon which variant you choose and your internet bandwidth. Allow about three hours for a full installation on the Beaglebone Black. On the Beaglebone installation is in two parts, since a reboot is needed to enable the hardware random number generator and zram.

When done you can ssh into the Freedombone with:

ssh username@domain -p 2222

Any manual post-installation setup instructions or passwords can be found in /home/username/README. You should remove any passwords from that file and store them within a password manager such as KeepassX.

Non-Beaglebone hardware

It's also possible to install Freedombone onto other hardware. Any system with a fresh installation of Debian Jessie will do. Just make sure that you change the variable INSTALLING_ON_BBB to "no" within freedombone.cfg or do not include the --bbb option within the freedombone command. Obviously, you don't need to run the freedombone-prep command on non-Beaglebone systems.