From ed79c29bfecd865e9195f18b789a1c14f1797416 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Sun, 26 Oct 2014 20:55:12 +0000 Subject: [PATCH] Web content --- website/code.html | 242 ++++++++ website/index.html | 250 ++++++++ website/installation.html | 447 +++++++++++++++ website/related.html | 244 ++++++++ website/usage.html | 1135 +++++++++++++++++++++++++++++++++++++ website/variants.html | 259 +++++++++ 6 files changed, 2577 insertions(+) create mode 100644 website/code.html create mode 100644 website/index.html create mode 100644 website/installation.html create mode 100644 website/related.html create mode 100644 website/usage.html create mode 100644 website/variants.html diff --git a/website/code.html b/website/code.html new file mode 100644 index 00000000..99690ade --- /dev/null +++ b/website/code.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + +
+ +
+
+

+
+ +
+

logo.png +

+
+
+ + + + +++ + + + + + +
Home
+ +

+Freedombone is really just a couple of bash scripts which install and configure software on a Debian GNU/Linux system. If you're a system administrator, software engineer or Linux hobbyist you'll probably be familiar with command line scripting and be able to make your own modifications or custom variants to suit your needs. Freedombone is licensed under the GNU General Public License version 3. +

+ + + + +++ ++ + + + + + + + + + + + +
initial_setup.shConfigures a microSD Debian image for use with the Beaglebone Black
install-freedombone.shThe main installation script which can run on any system with Debian Jessie
+ +

+You can find the source code for this project on Github. +

+ +

+Bugs or feature requests should be entered here. +

+
+
+ + + +
+Back to top | E-mail me +
+ + +
+ + diff --git a/website/index.html b/website/index.html new file mode 100644 index 00000000..82625adb --- /dev/null +++ b/website/index.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + +
+ +
+
+

+
+ +
+

logo.png +

+
+
+ +
+ + + +++ ++ ++ ++ ++ ++ + + + + + + + + + + +
VariantsInstallationHow to use itCodeRelated ProjectsLicense
+
+ +

+Today everyone is concerned about privacy on the internet. At the same time there's a problem with the companies who have traditionally provided most of the web services. The people running those companies may be well-intentioned - as in the famous motto "don't be evil" - but the advertising based business model which currently dominates, combined with an increasing level of political pressure to insert backdoors means that it is usually impossible for companies operating within both their own business models and the framework of national laws to provide you with services which don't intentionally leak your private communications to advertisers, insurers or governments. +

+ +

+Another problem is the precariousness of the terms of service. Except in rare cases such terms are not easy to read, so many people end up clicking through terms which if explained more clearly they would never agree to. Over the past decade many internet users have had the unpleasant experience of having their blogs, videos or other web content inexplicably removed, typically due to some ill-defined terms of service violation or a false accusation of copyright infringement. +

+ +

+You can bypass all of these dilemmas and take back ownership of your internet content with Freedombone. Based upon the Beaglebone Black, Freedombone is a small and cheap home server which enables you to use email, have your own web site and do social networking without any built-in spying and without having to agree to any legal terms of service other than those of your ISP. It provides independence and security in an era where those things are in short supply. +

+ +
+ +
+

surveillance.png +

+
+
+ +

+An emphasis of the Freedombone project is the protection of private communications from indiscriminate mass surveillance, otherwise known as "bulk intercept" or "warrantless wiretapping". With only a few exceptions data entering and leaving the system is encrypted using settings recommended by bettercrypto.org. Stored emails are encrypted such that only someone knowing your GPG password can read them and a GPG key is created automatically if you don't already have one. The system is firewalled with only the necessary ports being opened. Exclusively free software is used so that all of it can potentially be security audited and proprietary repositaries are disabled by default. There are still numerous security problems with the internet in general and software always contains bugs, but a best attempt has been made to ensure that the Freedombone is at least more secure than average. A limitation is that this system will not protect you from metadata analysis, although it is hoped that new types of email system may be able to do that in future. +

+
+
+ + + +
+Back to top | E-mail me +
+ + +
+ + diff --git a/website/installation.html b/website/installation.html new file mode 100644 index 00000000..d88e2798 --- /dev/null +++ b/website/installation.html @@ -0,0 +1,447 @@ + + + + + + + + + + + + + + + + + + +
+ +
+
+

+
+ +
+

logo.png +

+
+
+ + + +++ ++ ++ ++ + + + + + + + + +
HomeOn a Beaglebone BlackOn other hardwareInternet Router
+ +
+

On a Beaglebone Black

+
+

+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 subdomains created on 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). +

+ +

+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: +

+ +
+ +
./initial_setup.sh /dev/sdX
+
+
+ +

+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 script. You can either edit the variables within the install-freedombone.sh script directly, or create a separate configuration file called freedombone.cfg which contains those variables. Variables which you might want to put into a freedombone.cfg file are: +

+ +
+ +
MY_EMAIL_ADDRESS=
+MY_NAME=
+MY_BLOG_TITLE=
+MY_BLOG_SUBTITLE=
+SSH_PORT=
+FULLBLOG_DOMAIN_NAME=
+FULLBLOG_FREEDNS_SUBDOMAIN_CODE=
+MICROBLOG_DOMAIN_NAME=
+MICROBLOG_FREEDNS_SUBDOMAIN_CODE=
+REDMATRIX_DOMAIN_NAME=
+OWNCLOUD_DOMAIN_NAME=
+OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=
+WIKI_TITLE=
+WIKI_DOMAIN_NAME=
+WIKI_FREEDNS_SUBDOMAIN_CODE=
+MY_GPG_PUBLIC_KEY=
+MY_GPG_PRIVATE_KEY=
+PUBLIC_MAILING_LIST=
+ROUTE_THROUGH_TOR=no
+LOCAL_NETWORK_STATIC_IP_ADDRESS=192.168.1.60
+
+
+ +

+The GPG public/private key variables are for the filenames of exported GPG keys, and if a private key filename is given then it will be automatically shredded after import. +

+ +

+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. +

+ +

+The syntax of the install-freedombone.sh script is: +

+ +
+ +
./install-freedombone.sh [domain name] [username] [FreeDNS subdomain code] [optional variant type]
+
+
+ +

+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 as install-freedombone.sh. +

+ +

+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. +

+
+
+ +
+

On other hardware

+
+

+It's also possible to install Freedombone onto other hardware, such as an old laptop or other type of single board computer. 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 the install-freedombone.sh script. Obviously, you don't need to run the initial_setup.sh script on non-Beaglebone systems. +

+
+
+
+

Internet Router

+
+

+On your internet router, typically under firewall settings, open the following ports and forward them to the Freedombone. +

+ + + + +++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ServicePorts
HTTP80
HTTPS443
SSH2222
DLNA1900
DLNA8200
XMPP5222..5223
XMPP5269
XMPP5280..5281
IRC6697
IRC9999
Git9418
Email25
Email587
Email465
Email993
+
+
+
+
+ + + +
+Back to top | E-mail me +
+ + +
+ + diff --git a/website/related.html b/website/related.html new file mode 100644 index 00000000..b0dc28b2 --- /dev/null +++ b/website/related.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + +
+ +
+
+

+
+ +
+

logo.png +

+
+
+ + + + +++ + + + + + +
Home
+ +
+

+The following projects made Freedombone possible. +

+
+ +
+

+nginx.png +openssl.png +

+
+
+

+gnupg.png +debian.png +freedombox.png +beagleboard.png +dokuwiki.png +

+
+
+

+gnusocial.png +redmatrix.png +

+
+
+

+prosody.png +owncloud.png +bettercrypto.png +

+
+
+
+ + + +
+Back to top | E-mail me +
+ + +
+ + diff --git a/website/usage.html b/website/usage.html new file mode 100644 index 00000000..8c806510 --- /dev/null +++ b/website/usage.html @@ -0,0 +1,1135 @@ + + + + + + + + + + + + + + + + + + +
+ +
+
+

+
+ +
+

logo.png +

+
+
+ + + + +++ ++ ++ ++ ++ ++ ++ ++ ++ ++ + + + + + + + + + + + + + + +
HomeReadmeOperating SystemsUsing EmailMailing ListSyncing to the CloudPlay MusicMicrobloggingSocial NetworkChat Services
+ +
+

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: +

+ +
+ +
ssh username@domainname -p 2222
+emacs ~/README
+
+
+ +

+You should transfer any passwords to a password manager such as KeepassX and then delete them from the README file. To save the file after removing passwords use CTRL-x CTRL-s. +

+ +

+To exit you can either just close the terminal or use CTRL-x CTRL-c followed by the exit command. +

+
+
+
+

Operating Systems

+
+

+Since many of the systems on the Freedombone are web based your choice of operating system for laptops or desktop machines doesn't matter all that much, but some version of GNU/Linux or on mobile devices Android/Cyanogenmod is recommended. Microsoft Windows may be fine for playing games and other trivia but do not use it for any serious private communications or data storage purpose. If you are a journalist, political activist, systems administrator or other professional with a need for confidentiality then using Microsoft Windows will put yourself and your sources, colleages or other group members at heightened risk of surveillance. +

+
+
+
+

Using Email

+
+
+

A technical note about email transport security

+
+

+Port 465 is used for SMTP and this is supposedly deprecated for secure email. However, using TLS from the start of the communications seems far more secure than starting off with insecure communications and then trying to upgrade it with a command to begin TLS, as happens with STARTTLS. There are possible attacks against STARTTLS in which the command to begin secure communications is removed or overwritten which could then result in email being transferred in plain text over the internet and be readable by third parties. +

+
+
+
+

Add a password to your GPG key

+
+

+If you didn't use existing GPG keys during the Freedombone installation then you'll need to add a password to your newly generated private key. This is highly recommended. Go through the following sequence of commands to ssh into the Freedombone and then change your GPG password. +

+ +
+ +
ssh username@domainname -p 2222
+gpg --edit-key username@domain
+passwd
+save
+quit
+exit
+
+
+ +

+Having a password on your GPG key will prevent someone from reading your email even if your server gets lost or stolen or if someone else has physical access to it. Make the password something long and unlikely to be guessable or vulnerable to a brute force dictionary attack. +

+
+
+ +
+

Publishing your GPG public key

+
+

+If you havn't already then you should publish your GPG public key so that others can find it. +

+ +
+ +
ssh username@domainname -p 2222
+gpg --send-keys username@domainname
+exit
+
+
+
+
+
+

Mutt email client

+
+

+Mutt is a terminal based email client which comes already installed onto the Freedombone. To access it you'll need to access it via ssh with: +

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

+If you're using Windows there is an ssh client called putty, on Linux just open a terminal and enter the above command with your username and domain name. On Android you can use the ConnectBot app with the hostname username@domain:2222 +

+ +

+Once you have logged in via ssh then just type mutt. Like most terminal programs mutt is quite easy once you've learned the main keys. +

+ +

+Some useful keys to know are: +

+ + + + +++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
"/"Search for text within headers
*Move to the last message
TABMove to the next unread message
dDelete a message
uUndelete a mail which is pending deletion
$Delete all messages selected and check for new messages
aAdd to the address book
mSend a new mail
ESC-mMark all messages as having been read
SMark a message as spam
HMark a message as ham
CTRL-bToggle side bar on/off
CTRL-nNext mailbox (on side bar)
CTRL-pPrevious mailbox (on side bar)
CTRL-oOpen mailbox (on side bar)
]Expand or collapse all threads
[Expand of collapse the current thread
CTRL-kImport a PGP/GPG public key
qQuit
+ +

+To use the address book system open an email by pressing the enter key on it and then to add the sender to the address list press the A key. It will ask you for an alias which may be used the next time you want to send a mail. Alternatively you may just edit the ~/.mutt-alias file directly to add email addresses. +

+ +

+One of the most common things which you might wish to do is to send an email. To do this first press m to create a new message. Enter the address to send to and the subject, then after a few seconds the Emacs editor will appear with a blank document. Type your email then press CTRL-x CTRL-s to save it and CTRL-x CTRL-c to exit. You will then see a summary of the email to be sent out. Press y to send it and then enter your GPG key passphrase (the one you gave when creating a PGP/GPG key). The purpose of that is to add a signature which is a strong proof that the email was written by you and not by someone else. +

+ +

+When reading emails you will initially need to enter your GPG password. It will be retained in RAM for a while afterwards. +

+
+
+ +
+

Thunderbird

+
+

+Another common way in which you may want to access email is via Thunderbird. This may be especially useful if you're trying to convert former Windows users who may previously have been using some version of Outlook. +

+ +

+The following instructions should be carried out on the client machines (laptop, etc), not on the BBB itself. +

+
+ +
+

Initial setup

+
+

+Install Thunderbird and Enigmail. How you do this just depends upon your distro and software manager or "app store". +

+ +

+Open Thinderbird +

+ +

+Select "Skip this and use existing email" +

+ +

+Enter your name, email address (myusername@mydomainname.com) and the password for your user (the one from Add a user). +

+ +

+You'll get a message saying "Thunderbird failed to find the settings" +

+ +

+The settings should be as follows, substituting mydomainname.com for your domain name and myusername for the username given previously in Add a user. +

+ +
    +
  • Incoming: IMAP, mydomainname.com, 993, SSL/TLS, Normal Password +
    • +
  • Outgoing: SMTP, mydomainname.com, 465, SSL/TLS, Normal Password +
    • +
  • Username: myusername +
    • +
+ +

+Click Done. +

+ +

+Click Get Certificate and make sure "permanently store this exception" is selected", then click Store Security Exception. +

+ +

+From OpenPGP setup select "Yes, I would like the wizard to get me started". If the wizard doesn't start automatically then "setup wizard" can be selected from OpenPGP on the menu bar. +

+ +

+Select "Yes, I want to sign all of my email" +

+ +

+Select "No, I will create per-recipient rules" +

+ +

+Select "yes" to change default settings. +

+
+
+ +
+

Import your GPG keys

+
+

+On the Freedombone export your GPG public and private keys. +

+ +
+ +
gpg --output ~/public_key.gpg --armor --export KEY_ID
+gpg --output ~/private_key.gpg --armor --export-secret-key KEY_ID
+
+
+ +

+On your laptop or desktop you can import the keys with: +

+ +
+ +
scp -P 2222 username@domain:/home/username/*.gpg ~/
+
+
+ +

+Select "I have existing public and private keys". +

+ +

+Select your public and private GPG exported key files. +

+ +

+Select the account which you want to use and click Next, Next and Finish. +

+ +

+Remove your exported key files, both on your laptop/desktop and also on the Freedombone. +

+ +
+ +
shred -zu ~/public_key.gpg
+shred -zu ~/private_key.gpg
+
+
+
+
+ +
+

Using for the first time

+
+

+Click on the Thunderbird menu, which looks like three horizontal bars on the right hand side. +

+ +

+Hover over preferences and then Account settings. +

+ +

+Select OpenPGP Security and make sure that use PGP/MIME by default is ticked. This will enable you to sign/encrypt attachments, HTML bodies and UTF-8 without any problems. +

+ +

+Select Synchronization & Storage. +

+ +

+Make sure that Keep messages for this account on this computer is unticked, then click Ok. +

+ +

+Click on Inbox. Depending upon how much email you have it may take a while to import the subject lines. +

+ +

+Note that when sending an email for the first time you will also need to accept the SSL certificate. +

+ +

+Get into the habit of using email encryption and encourage others to do so. Remember that you may not think that your emails are very interesting but the Surveillance State is highly interested in them and will be actively trying to data mine your private life looking for "suspicious" patterns, regardless of whether you are guilty of any crime or not. +

+
+
+ +
+

Making folders visible

+
+

+By default you won't be able to see any folders which you may have created earlier using the mailinglistrule script. To make folders visible select: +

+ +

+Menu, hover over Preferences, select Account Settings, select Server Settings then click on the Advanced button. +

+ +

+Make sure that "show only subscribed folders" is not checked. Then click the ok buttons. Folders will be re-scanned, which may take some time depending upon how much email you have, but your folders will then appear. +

+
+
+
+ +
+

K9 Android client

+
+

+NOTE: Currently the K9 email client will not work with the Freedombone since it doesn't support PGP/MIME encoding. However, there is development work taking place on that feature and it is hoped that K9 may be usable in the near future. +

+
+ +
+

Incoming server settings

+
+
    +
  • Select settings/account settings +
    • +
  • Select Fetching mail/incoming server +
    • +
  • Enter your username and password +
    • +
  • IMAP server should be your domain name +
    • +
  • Security: SSL/TLS (always) +
    • +
  • Authentication: Plain +
    • +
  • Port: 993 +
    • +
+
+
+
+

Outgoing (SMTP) server settings

+
+
    +
  • Select settings/account settings +
    • +
  • Select Sending mail/outgoing server +
    • +
  • Set SMTP server to your domain name +
    • +
  • Set Security to SSL/TLS (always) +
    • +
  • Set port to 465 +
    • +
  • Set authentication to PLAIN +
    • +
  • Enter your username and password +
    • +
  • Accept the SSL certificate +
    • +
+
+
+
+

Folders

+
+

+To view any new folders which you may have created using the mailinglistrule script from your inbox press the K9 icon at the top left to access folders, then press the menu button and select refresh folder list. +

+ +

+If your folder still doesn't show up then press the menu button, select show folders and select all folders. +

+
+
+
+ +
+

Subscribing to mailing lists

+
+

+To subscribe to a mailing list so that it appears within Mutt or Thunderbird. +

+ +
+ +
ssh username@domainname -p 2222
+addmailinglist <username> <mailinglistname> <subjecttag>
+exit
+
+
+ +

+The subject tag should be the word or phrase which appears within the brackets in the subject line of emails from the mailing list. The mailing list name should be something short so that it is readable within the left side column of the mutt email client. +

+
+
+
+

Adding email addresses to a group/folder

+
+

+Similar to adding mailing list folders you can also add specified email addresses into a folder. +

+ +
+ +
ssh username@domainname -p 2222
+addemailtofolder <username> <emailaddress> <mailinglistname>
+exit
+
+
+ +

+The mailing list name should be something short so that it is readable within the left side column of the mutt email client. +

+
+
+
+ +
+

Mailing List

+
+

+If you want to set up a public mailing list then when installing the system remember to set the PUBLIC_MAILING_LIST variable within freedombone.cfg to the name of your list. The name should have no spaces in it. Public mailing lists are unencrypted so anyone will be able to read the contents, including non subscribers. +

+ +

+To subscribe to your list send a cleartext email to: +

+ +
+ +
mymailinglistname+subscribe@domainname
+
+
+ +

+Tip: When using the Mutt email client if you want to send an email in cleartext then press p (for PGP) on the sending screen and select clear. Unsecure email is treated as being the exception rather than the default. +

+
+
+
+

Syncing to the Cloud

+
+
+

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. +

+ +

+You will also need to enter database details: +

+ + + + +++ ++ + + + + + + + + + + + + + + + + +
Owncloud database userowncloudadmin
Owncloud database passwordSee the Readme file
Owncloud database nameowncloud
+ +

+After creating an administrator account then create a user account via the Users dropdown menu entry on the right hand side and log the details in a password manager. Give the user a quota suitable for the size of your microSD card or other storage. +

+ +

+Log out from the administrator account and then log back in as the user you just created. +

+
+
+
+

On Android

+
+

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

+ +

+Open the owncloud app and enter your owncloud domain name (including the https prefix) and login details for the user you created. +

+ +

+Open the calendar app and under settings add a CalDav account with the url: +

+ +
+ +
https://myownclouddomain/remote.php/caldav/principals/myowncloudusername
+
+
+ +

+You will also be prompted to enter login details. Your Android and Owncloud calendars should now be synchronised. +

+
+
+
+

On Linux

+
+

+Open your software center and search for "owncloud client". Enter your owncloud domain name (with the https prefix) and login details. +

+ +

+You can now drag files into the ~/owncloud directory and they will automatically sync to your server. It's that easy. +

+
+
+
+
+

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. +

+ +

+ssh into the system with: +

+ +
+ +
ssh myusername@mydomain.com -p 2222
+
+
+ +

+Then mount the USB drive with: +

+ +
+ +
su
+attach-music
+
+
+ +

+The system will scan the Music directory, which could take a while if there are thousands of files, but you don't need to do anything further with the Beaglebone other than perhaps to log out by typing exit a couple of times. +

+ +

+If you have an Android device then go to F-Droid (if you don't already have it installed then it can be downloaded here) and search for ControlDLNA. On running the app you should see a red Debian icon which you can press on, then you may need to select "local". After a few seconds the list of albums or tracks should then appear and you can browse and play them. +

+ +

+The DLNA service will only work within your local home network, and isn't remotely accessible from other locations via the internet. That can be both a good and a bad thing. Another consideration is that there are no access controls on DLNA services, so any music or videos on the USB drive will be playable by anyone within your home network. If you need to restrict access to certain files then it may be better to use the music player within 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. +

+ +

+By default a music player is installed into Owncloud, so all you need to do is to visit your Owncloud web site, select the music directory and then upload some music files. Afterwards you can select the music icon from the top left drop down menu and albums will then appear which can be played. If you want to share music with other users then you can select the share option from within the files view to make the tracks available. +

+
+
+
+ +
+

Microblogging

+
+
+

Initial configuration

+
+

+To set up your microblog go to: +

+ +
+ +
https://yourmicroblogdomainname/install.php
+
+
+ +

+and enter the following settings: +

+ + + + +++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Server SSLenable
Hostnamelocalhost
TypeMySql/MariaDB
Namegnusocial
DB usernameroot
DB PasswordSee the MariaDB password in the Readme file
Administrator nicknameYour username
Administrator passwordSee the Readme file
Subscribe to announcementsticked
Site profileCommunity
+ +

+When the install is complete you will see a lot of warnings but just ignore those and navigate to your microblog domain and you can then complete the configuration via the Admin section on the header bar. Some recommended admin settings are: +

+ + + + +++ ++ + + + + + + + + + + + + + + + + +
Site settingsText limit 140, Dupe Limit 60000
User settingsBio limit 1000
Access settingsInvite only ticked
+
+
+
+
+

Social Network

+
+
+

Certificates

+
+

+You will need to have a non self-signed SSL certificate in order to use Red Matrix. Put the public certificate in /etc/ssl/certs/yourredmatrixdomainname.crt and the private certificate in /etc/ssl/private/yourredmatrixdomainname.key. If there is an intermediate certificate needed (such as with StartSSL) then this will need to be concatenated onto the end of the crt file, like this: +

+ +
+ +
cat /etc/ssl/certs/yourredmatrixdomainname.crt /etc/ssl/chains/startssl-sub.class1.server.ca.pem >
+ /etc/ssl/certs/yourredmatrixdomainname.bundle.crt
+
+
+ +

+Then change ssl_certificate to /etc/ssl/certs/yourredmatrixdomainname.bundle.crt within /etc/nginx/sites-available/yourredmatrixdomainname +

+
+
+
+

Initial install

+
+

+Visit the URL of your Red Matrix site and you should be taken through the rest of the installation procedure. Note that this may take a few minutes so don't be concerned if it looks as if it has crashed - just leave it running. +

+ +

+When installation is complete you can register a new user. +

+
+
+
+
+

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

+
+

+If you are using the irssi IRC client then you can use the following commands to connect to your IRC server. +

+ +
+ +
/server add -auto -ssl yourdomainname 6697
+/connect yourdomainname
+/join freedombone
+
+
+
+
+
+

XChat

+
+

+If you are using the XChat client: +

+ +

+Within the network list click, Add and enter your domain name then click Edit. +

+ +

+Select the entry within the servers box, then enter mydomainname/6697 and press Enter. +

+ +

+Uncheck use global user information. +

+ +

+Enter first and second nicknames and check auto connect to this network on startup. +

+ +

+Check use SSL and accept invalid SSL certificate. +

+ +

+Enter #freedombone as the channel name. +

+ +

+Click close and then connect. +

+
+
+
+ +
+

XMPP/Jabber

+
+
+
+
+ + + +
+Back to top | E-mail me +
+ + +
+ + diff --git a/website/variants.html b/website/variants.html new file mode 100644 index 00000000..54dd7685 --- /dev/null +++ b/website/variants.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + +
+ +
+
+

+
+ +
+

logo.png +

+
+
+ + + + +++ + + + + + +
Home
+ +

+Freedombone may be installed either in its entirety or as different variants with a more specialised purpose. So for example if you just want to run a blog but don't care about any other services then you can do that. The following variants are available: +

+ + + + +++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MailboxAn email server with GPG encryption and mailing list
CloudShare files, maintain a calendar and collaborate on document editing
SocialSocial networking with Red Matrix and GNU Social
MediaRuns media services such as DLNA to play music or videos on your devices
WriterHost your blog and wiki
ChatEncrypted IRC and XMPP services for one-to-one and many-to-many chat
NonmailboxInstalls eveything except for the email server
+
+
+ + + +
+Back to top | E-mail me +
+ + +
+ +