freedomboneeee/README.md

64 lines
4.1 KiB
Markdown
Raw Normal View History

2014-09-30 12:43:42 +02:00
Freedombone
===========
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.
2014-03-19 21:46:47 +01:00
2014-09-30 13:18:04 +02:00
- **Full install**: Installs eveything
- **Mailbox**: An email server with GPG encryption enabled by default
- **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
- **Notmailbox**: Installs eveything except for the email server
2014-04-09 20:06:29 +02:00
2014-10-01 00:01:16 +02:00
Unlike certain other self-hosting projects Freedombone has more emphasis on security and privacy. When installed on a Beaglebone Black it uses the built-in hardware random number generator as an entropy source and 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.
2014-01-01 13:33:57 +01:00
2014-09-30 13:38:07 +02:00
Freedombone is, and shall remain, 100% free software. Non-free repositories are removed automatically upon installation.
2014-09-30 12:43:42 +02:00
Installation
============
To get started you will need:
2014-01-01 13:38:21 +01:00
2014-09-30 12:43:42 +02:00
- 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)
- A subdomain created on https://freedns.afraid.org
- A purchased domain name and SSL certificate (only needed for Red Matrix)
2014-02-20 19:48:06 +01:00
2014-09-30 12:43:42 +02:00
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).
2014-02-20 19:48:06 +01:00
2014-09-30 13:18:04 +02:00
Check that within *initial_setup.sh* the router IP address and static IP for the Beaglebone are set correctly.
Plug the microSD card into your laptop/desktop and then run the *initial_setup.sh* script. For example:
2014-02-20 19:48:06 +01:00
2014-09-30 12:43:42 +02:00
./initial_setup.sh /dev/sdX
2014-02-20 19:48:06 +01:00
2014-09-30 12:43:42 +02:00
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.
2014-02-20 19:48:06 +01:00
2014-09-30 13:18:04 +02:00
When the initial setup is done follow the instructions on screen to run the main Freedombone script. Edit the *install-freedombone.sh* script and change the following as needed. If you don't want those services then just leave them as they are.
2014-02-20 20:22:29 +01:00
2014-09-30 12:43:42 +02:00
MICROBLOG_DOMAIN_NAME
MICROBLOG_FREEDNS_SUBDOMAIN_CODE
OWNCLOUD_DOMAIN_NAME
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE
WIKI_DOMAIN_NAME
WIKI_FREEDNS_SUBDOMAIN_CODE
REDMATRIX_DOMAIN_NAME
2014-02-20 20:22:29 +01:00
2014-09-30 12:43:42 +02:00
The FreeDNS subdomain codes can be found under "Dynamic DNS" and "quick cron example". On the last line it will be the string located between the '?' and the '==' characters.
2014-02-20 19:48:06 +01:00
2014-09-30 12:43:42 +02:00
Installation is not quick, and depends upon which variant you choose and your internet bandwidth. Allow at least a couple of hours for it to finish.
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
=======================
2014-09-30 13:18:04 +02:00
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 the *install-freedombone.sh* script. Obviously, you don't need to run the *initial_setup.sh* script on non-Beaglebone systems.