free
/
freedomboneeee
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updating the documentation for menuconfig

This commit is contained in:
Bob Mottram 2015-01-18 20:19:09 +00:00
parent 7ef9f6651f
commit 0a0d530205
5 changed files with 369 additions and 259 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -15,8 +15,10 @@ Freedombone has an emphasis on security and privacy, and when installed on a Bea
Freedombone is, and shall remain, 100% free software. Non-free repositories are removed automatically upon installation.
Installation
============
Preparation for the Beaglebone Black
====================================
This section is specific to the Beaglebone Black hardware. If you're not using that hardware then just skip to the next section.
To get started you will need:
- A Beaglebone Black
@ -40,12 +42,50 @@ You can either install from a debian package or manually as follows:
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>
freedombone-prep -d /dev/sdX --ip freedombone_IP_address --iprouter router_IP_address
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.
Checklist
=========
Before running the freedombone command you will need a few things.
* Have some domains, or subdomains, registered with a dynamic DNS service
* System with a new installation of Debian Jessie
* Ethernet connection to an internet router
* It is possible to forward ports from the internet router to the system
* If you want to set up a social network or microblog then you will need SSL certificates corresponding to those domains
* Have ssh access to the system
GPG Keys
========
If you have existing GPG keys then copy the .gnupg directory onto the system.
scp -r ~/.gnupg username@freedombone_IP_address:/home/username
Interactive Setup
=================
The interactive server configuration setup is recommended for most users. 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
Now the easiest way to install the system is via the interactive setup.
freedombone menuconfig
You can select which variant you wish to install and then enter the details as requested.
Non-Interactive Setup
=====================
If you don't want to install interactively then it's possible to manually create a configuration file as follows:
On the system where freedombone is to be installed create a configuration file.
ssh username@freedombone_IP_address
@ -96,7 +136,9 @@ The above command should be run in the same directory in which your configuratio
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.
Post-Setup
==========
Setup of the server and installation of all the relevant packages 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:
@ -104,6 +146,22 @@ When done you can ssh into the Freedombone with:
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.
On your internet router, typically under firewall settings, open the following ports and forward them to your server.
| Service | Ports |
|---------+------------|
| HTTP | 80 |
| HTTPS | 443 |
| SSH | 2222 |
| DLNA | 1900 |
| DLNA | 8200 |
| XMPP | 5222..5223 |
| XMPP | 5269 |
| XMPP | 5280..5281 |
| IRC | 6697 |
| IRC | 9999 |
| Git | 9418 |
| Email | 25 |
| Email | 587 |
| Email | 465 |
| Email | 993 |

208
doc/installation.org
View File

@ -7,18 +7,12 @@
#+BEGIN_CENTER
[[./images/logo.png]]
#+END_CENTER
| [[file:index.html][Home]] | [[Download the code]] | [[On a Beaglebone Black]] | [[On a laptop/PC/netbook]] | [[Internet Router]] |
| [[file:index.html][Home]] | [[Preparation for the Beaglebone Black]] | [[Checklist]] | [[GPG Keys]] | [[Interactive Setup]] | [[Non-Interactive Setup]] | [[Post-Setup]] |
* Download and install the code
Firstly you'll need to download the code as follows:
#+BEGIN_SRC bash
sudo apt-get install git
git clone https://github.com/bashrc/freedombone
cd freedombone
make install
#+END_SRC
* On a Beaglebone Black
* Preparation for the Beaglebone Black
This section is specific to the Beaglebone Black hardware. If you're not using that hardware then just skip to the next section.
To get started you will need:
- A Beaglebone Black
@ -27,59 +21,133 @@ To get started you will need:
- 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
- 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:
#+BEGIN_SRC bash
sudo apt-get install git
git clone https://github.com/bashrc/freedombone
cd freedombone
sudo make install
#+END_SRC
Plug the microSD card into your laptop/desktop and then run the *freedombone-prep* command. For example:
#+BEGIN_SRC bash
freedombone-prep -d /dev/sdX --ip <static LAN IP> --iprouter <router LAN IP>
freedombone-prep -d /dev/sdX --ip freedombone_IP_address --iprouter router_IP_address
#+END_SRC
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.
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 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:
When the initial setup is done follow the instructions on screen to run the main freedombone command.
* Checklist
Before running the freedombone command you will need a few things.
* Have some domains, or subdomains, registered with a dynamic DNS service
* System with a new installation of Debian Jessie
* Ethernet connection to an internet router
* It is possible to forward ports from the internet router to the system
* If you want to set up a social network or microblog then you will need SSL certificates corresponding to those domains
* Have ssh access to the system
* GPG Keys
If you have existing GPG keys then copy the .gnupg directory onto the system.
#+BEGIN_SRC bash
MY_EMAIL_ADDRESS=<your email address>
MY_NAME=<your name/nick/pseudonym>
MY_BLOG_TITLE=<title of your blog>
MY_BLOG_SUBTITLE=<subtitle of your blog>
SSH_PORT=2222
FULLBLOG_DOMAIN_NAME=<freedns subdomain for your blog>
FULLBLOG_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your blog>
MICROBLOG_DOMAIN_NAME=<domain name for your microblog>
MICROBLOG_FREEDNS_SUBDOMAIN_CODE=1234
REDMATRIX_DOMAIN_NAME=<domain name for your Red Matrix site>
OWNCLOUD_DOMAIN_NAME=<freedns subdomain for your Owncloud site>
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your Owncloud site>
WIKI_TITLE=<title of your wiki>
WIKI_DOMAIN_NAME=<freedns subdomain for your wiki>
WIKI_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your wiki>
MY_GPG_PUBLIC_KEY=<exported public key filename>
MY_GPG_PRIVATE_KE=<exported private key filename>
PUBLIC_MAILING_LIST=<name of your mailing list>
LOCAL_NETWORK_STATIC_IP_ADDRESS=192.168.1.60
ROUTER_IP_ADDRESS=192.168.1.254
scp -r ~/.gnupg username@freedombone_IP_address:/home/username
#+END_SRC
* Interactive Setup
The interactive server configuration setup is recommended for most users. On the system where freedombone is to be installed create a configuration file.
#+BEGIN_SRC bash
ssh username@freedombone_IP_address
su
apt-get install git
git clone https://github.com/bashrc/freedombone
cd freedombone
make install
#+END_SRC
Now the easiest way to install the system is via the interactive setup.
#+BEGIN_SRC bash
freedombone menuconfig
#+END_SRC
You can select which variant you wish to install and then enter the details as requested.
* Non-Interactive Setup
If you don't want to install interactively then it's possible to manually create a configuration file as follows:
On the system where freedombone is to be installed create a configuration file.
#+BEGIN_SRC bash
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
#+END_SRC
Add the following, and set the values as needed.
#+BEGIN_SRC bash
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=
#+END_SRC
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.
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.
The [[https://freedns.afraid.org/][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 *freedombone* command is:
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.
#+BEGIN_SRC bash
freedombone --bbb -d [domain name] -u [username] -c [FreeDNS subdomain code] --ddnsuser [FreeDNS username] --ddnspass [FreeDNS password] -s [optional variant type]
FULLBLOG_FREEDNS_SUBDOMAIN_CODE=
REDMATRIX_FREEDNS_SUBDOMAIN_CODE=
MICROBLOG_FREEDNS_SUBDOMAIN_CODE=
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=
WIKI_FREEDNS_SUBDOMAIN_CODE=
#+END_SRC
Save the configuration file and exit from your editor.
Now you can begin the installation. If you are doing this on a Beaglebone Black:
#+BEGIN_SRC bash
freedombone --bbb -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]
#+END_SRC
Or on any other system don't include the *--bbb* option.
#+BEGIN_SRC bash
freedombone -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]
#+END_SRC
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.
* Post-Setup
Setup of the server and installation of all the relevant packages 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:
@ -87,65 +155,9 @@ When done you can ssh into the Freedombone with:
ssh username@domain -p 2222
#+END_SRC
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.
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 a laptop/PC/netbook
It's also possible to install Freedombone onto other hardware, including other types 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 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.
* Download the [[https://www.debian.org/devel/debian-installer][Debian Jessie "netinst" installer]]
* Use [[https://apps.ubuntu.com/cat/applications/usb-creator-gtk/][Startup Disk Creator]] or [[https://en.wikipedia.org/wiki/UNetbootin][Unetbootin]] to copy the netinst image to a USB thumb drive
* Connect the machine to your internet router using an ethernet patch lead. Freedombone is a fully free (as in freedom) system and so wifi drivers may not work. A wired network connection will give better performance anyway.
* On the target machine boot from the USB drive and go through the installation. It's a good idea to use LVM and disk encryption together with a long passphrase which will be hard to crack by brute force methods. Keep a note of the passphrase in your password manager.
* Within the installer unselect the *print server* and select the *ssh server*
* After installation use ssh to access the machine and become the root user
#+BEGIN_SRC bash
ssh username@192.168.1.60
su
#+END_SRC
* If you have GPG keys you may wish to transfer them to the */home/usernname* directory. If the machine has a second USB socket or an SD card slot then that may be the most secure way to do it.
* Run the following commands:
#+BEGIN_SRC bash
cd /home/<username>
apt-get install git
git clone https://github.com/bashrc/freedombone
cd freedombone
make install
nano freedombone.cfg
#+END_SRC
* Now create a configuration file, such as the following, filling in the details for your [[https://freedns.afraid.org/][FreeDNS subdomains]].
#+BEGIN_SRC bash
INSTALLING_ON_BBB=no
MY_EMAIL_ADDRESS=<your email address>
MY_NAME=<your name/nick/pseudonym>
MY_BLOG_TITLE=<title of your blog>
MY_BLOG_SUBTITLE=<subtitle of your blog>
SSH_PORT=2222
FULLBLOG_DOMAIN_NAME=<freedns subdomain for your blog>
FULLBLOG_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your blog>
MICROBLOG_DOMAIN_NAME=<domain name for your microblog>
MICROBLOG_FREEDNS_SUBDOMAIN_CODE=1234
REDMATRIX_DOMAIN_NAME=<domain name for your Red Matrix site>
OWNCLOUD_DOMAIN_NAME=<freedns subdomain for your Owncloud site>
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your Owncloud site>
WIKI_TITLE=<title of your wiki>
WIKI_DOMAIN_NAME=<freedns subdomain for your wiki>
WIKI_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your wiki>
MY_GPG_PUBLIC_KEY=<exported public key filename>
MY_GPG_PRIVATE_KEY=<exported private key filename>
PUBLIC_MAILING_LIST=<name of your mailing list>
LOCAL_NETWORK_STATIC_IP_ADDRESS=192.168.1.60
ROUTER_IP_ADDRESS=192.168.1.254
ENABLE_CJDNS=no
#+END_SRC
* Save and exit, then run:
#+BEGIN_SRC bash
freedombone -d [your wiki domain name] -u [your username] -c [your wiki FreeDNS domain code] --ddnsuser [FreeDNS username] --ddnspass [FreeDNS password]
#+END_SRC
* Internet Router
On your internet router, typically under firewall settings, open the following ports and forward them to the Freedombone.
On your internet router, typically under firewall settings, open the following ports and forward them to your server.
| Service | Ports |
|---------+------------|

BIN
man/freedombone.1.gz
View File

Binary file not shown.

2
src/freedombone-prep
View File

@ -183,7 +183,7 @@ echo ' cd freedombone'
echo ''
echo 'Finally you can use the freedombone command to install a server configuration:'
echo ''
echo " freedombone --bbb -d [domain] -u [username] --ip $BBB_FIXED_IP_ADDRESS --iprouter $ROUTER_IP_ADDRESS --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]"
echo ' freedombone menuconfig'
echo ''
echo 'See the manpage for more information on how to use the freedombone command.'
exit 0

346
website/installation.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title></title>
<!-- 2015-01-11 Sun 11:19 -->
<!-- 2015-01-18 Sun 20:16 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="generator" content="Org-mode" />
<meta name="author" content="Bob Mottram" />
@ -167,38 +167,33 @@ for the JavaScript code in this tag.
<col class="left" />
<col class="left" />
<col class="left" />
<col class="left" />
</colgroup>
<tbody>
<tr>
<td class="left"><a href="index.html">Home</a></td>
<td class="left"><a href="#unnumbered-1">Download the code</a></td>
<td class="left"><a href="#unnumbered-2">On a Beaglebone Black</a></td>
<td class="left"><a href="#unnumbered-3">On a laptop/PC/netbook</a></td>
<td class="left"><a href="#unnumbered-4">Internet Router</a></td>
<td class="left"><a href="#unnumbered-1">Preparation for the Beaglebone Black</a></td>
<td class="left"><a href="#unnumbered-2">Checklist</a></td>
<td class="left"><a href="#unnumbered-3">GPG Keys</a></td>
<td class="left"><a href="#unnumbered-4">Interactive Setup</a></td>
<td class="left"><a href="#unnumbered-5">Non-Interactive Setup</a></td>
<td class="left"><a href="#unnumbered-6">Post-Setup</a></td>
</tr>
</tbody>
</table>
<div id="outline-container-unnumbered-1" class="outline-2">
<h2 id="unnumbered-1">Download the code</h2>
<h2 id="unnumbered-1">Preparation for the Beaglebone Black</h2>
<div class="outline-text-2" id="text-unnumbered-1">
<p>
Firstly you'll need to download the code as follows:
This section is specific to the Beaglebone Black hardware. If you're not using that hardware then just skip to the next section.
</p>
<div class="org-src-container">
<pre class="src src-bash">sudo apt-get install git
git clone https://github.com/bashrc/freedombone
<span class="org-builtin">cd</span> freedombone
</pre>
</div>
</div>
</div>
<div id="outline-container-unnumbered-2" class="outline-2">
<h2 id="unnumbered-2">On a Beaglebone Black</h2>
<div class="outline-text-2" id="text-unnumbered-2">
<p>
To get started you will need:
</p>
@ -216,7 +211,7 @@ To get started you will need:
</li>
<li>USB thumb drive (for backups or storing media)
</li>
<li>One or more subdomains created on <a href="https://freedns.afraid.org/">https://freedns.afraid.org/</a>
<li>One or more domains available via a dynamic DNS provider, such as <a href="https://freedns.afraid.org/">https://freedns.afraid.org/</a>
</li>
<li>A purchased domain name and SSL certificate (only needed for Red Matrix)
</li>
@ -229,77 +224,213 @@ You will also need to know, or find out, the IP address of your internet router
</p>
<p>
Check that within <b>initial_setup.sh</b> the router IP address and static IP for the Beaglebone are set correctly.
</p>
<p>
Plug the microSD card into your laptop/desktop and then run the <b>initial_setup.sh</b> script. For example:
You can either install from a debian package or manually as follows:
</p>
<div class="org-src-container">
<pre class="src src-bash">./initial_setup.sh /dev/sdX
<pre class="src src-bash">sudo apt-get install git
git clone https://github.com/bashrc/freedombone
<span class="org-builtin">cd</span> freedombone
sudo make install
</pre>
</div>
<p>
where <b>/dev/sdX</b> is the device name for the microSD card. Often it's <b>/dev/sdb</b> or <b>/dev/sdc</b>, 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.
</p>
<p>
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 <b>install-freedombone.sh</b> script directly, or create a separate configuration file called <b>freedombone.cfg</b> which contains those variables. Variables which you might want to put into a <b>freedombone.cfg</b> file are:
Plug the microSD card into your laptop/desktop and then run the <b>freedombone-prep</b> command. For example:
</p>
<div class="org-src-container">
<pre class="src src-bash"><span class="org-variable-name">MY_EMAIL_ADDRESS</span>=&lt;your email address&gt;
<span class="org-variable-name">MY_NAME</span>=&lt;your name/nick/pseudonym&gt;
<span class="org-variable-name">MY_BLOG_TITLE</span>=&lt;title of your blog&gt;
<span class="org-variable-name">MY_BLOG_SUBTITLE</span>=&lt;subtitle of your blog&gt;
<span class="org-variable-name">SSH_PORT</span>=2222
<span class="org-variable-name">FULLBLOG_DOMAIN_NAME</span>=&lt;freedns subdomain for your blog&gt;
<span class="org-variable-name">FULLBLOG_FREEDNS_SUBDOMAIN_CODE</span>=&lt;freedns subdomain code for your blog&gt;
<span class="org-variable-name">MICROBLOG_DOMAIN_NAME</span>=&lt;domain name for your microblog&gt;
<span class="org-variable-name">MICROBLOG_FREEDNS_SUBDOMAIN_CODE</span>=1234
<span class="org-variable-name">REDMATRIX_DOMAIN_NAME</span>=&lt;domain name for your Red Matrix site&gt;
<span class="org-variable-name">OWNCLOUD_DOMAIN_NAME</span>=&lt;freedns subdomain for your Owncloud site&gt;
<span class="org-variable-name">OWNCLOUD_FREEDNS_SUBDOMAIN_CODE</span>=&lt;freedns subdomain code for your Owncloud site&gt;
<span class="org-variable-name">WIKI_TITLE</span>=&lt;title of your wiki&gt;
<span class="org-variable-name">WIKI_DOMAIN_NAME</span>=&lt;freedns subdomain for your wiki&gt;
<span class="org-variable-name">WIKI_FREEDNS_SUBDOMAIN_CODE</span>=&lt;freedns subdomain code for your wiki&gt;
<span class="org-variable-name">MY_GPG_PUBLIC_KEY</span>=&lt;exported public key filename&gt;
<span class="org-variable-name">MY_GPG_PRIVATE_KE</span>=&lt;exported private key filename&gt;
<span class="org-variable-name">PUBLIC_MAILING_LIST</span>=&lt;name of your mailing list&gt;
<span class="org-variable-name">LOCAL_NETWORK_STATIC_IP_ADDRESS</span>=192.168.1.60
<span class="org-variable-name">ROUTER_IP_ADDRESS</span>=192.168.1.254
<pre class="src src-bash">freedombone-prep -d /dev/sdX --ip freedombone_IP_address --iprouter router_IP_address
</pre>
</div>
<p>
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.
</p>
<p>
When the initial setup is done follow the instructions on screen to run the main freedombone command.
</p>
</div>
</div>
<div id="outline-container-unnumbered-2" class="outline-2">
<h2 id="unnumbered-2">Checklist</h2>
<div class="outline-text-2" id="text-unnumbered-2">
<p>
Before running the freedombone command you will need a few things.
</p>
<ul class="org-ul">
<li>Have some domains, or subdomains, registered with a dynamic DNS service
</li>
<li>System with a new installation of Debian Jessie
</li>
<li>Ethernet connection to an internet router
</li>
<li>It is possible to forward ports from the internet router to the system
</li>
<li>If you want to set up a social network or microblog then you will need SSL certificates corresponding to those domains
</li>
<li>Have ssh access to the system
</li>
</ul>
</div>
</div>
<div id="outline-container-unnumbered-3" class="outline-2">
<h2 id="unnumbered-3">GPG Keys</h2>
<div class="outline-text-2" id="text-unnumbered-3">
<p>
If you have existing GPG keys then copy the .gnupg directory onto the system.
</p>
<div class="org-src-container">
<pre class="src src-bash">scp -r ~/.gnupg username@freedombone_IP_address:/home/username
</pre>
</div>
</div>
</div>
<div id="outline-container-unnumbered-4" class="outline-2">
<h2 id="unnumbered-4">Interactive Setup</h2>
<div class="outline-text-2" id="text-unnumbered-4">
<p>
The interactive server configuration setup is recommended for most users. On the system where freedombone is to be installed create a configuration file.
</p>
<div class="org-src-container">
<pre class="src src-bash">ssh username@freedombone_IP_address
su
apt-get install git
git clone https://github.com/bashrc/freedombone
<span class="org-builtin">cd</span> freedombone
make install
</pre>
</div>
<p>
Now the easiest way to install the system is via the interactive setup.
</p>
<div class="org-src-container">
<pre class="src src-bash">freedombone menuconfig
</pre>
</div>
<p>
You can select which variant you wish to install and then enter the details as requested.
</p>
</div>
</div>
<div id="outline-container-unnumbered-5" class="outline-2">
<h2 id="unnumbered-5">Non-Interactive Setup</h2>
<div class="outline-text-2" id="text-unnumbered-5">
<p>
If you don't want to install interactively then it's possible to manually create a configuration file as follows:
</p>
<p>
On the system where freedombone is to be installed create a configuration file.
</p>
<div class="org-src-container">
<pre class="src src-bash">ssh username@freedombone_IP_address
su
apt-get install git
git clone https://github.com/bashrc/freedombone
<span class="org-builtin">cd</span> freedombone
make install
nano /home/username/freedombone/freedombone.cfg
</pre>
</div>
<p>
Add the following, and set the values as needed.
</p>
<div class="org-src-container">
<pre class="src src-bash"><span class="org-variable-name">MY_EMAIL_ADDRESS</span>=
<span class="org-variable-name">MY_NAME</span>=
<span class="org-variable-name">MY_BLOG_TITLE</span>=
<span class="org-variable-name">MY_BLOG_SUBTITLE</span>=
<span class="org-variable-name">FULLBLOG_DOMAIN_NAME</span>=
<span class="org-variable-name">MICROBLOG_DOMAIN_NAME</span>=
<span class="org-variable-name">REDMATRIX_DOMAIN_NAME</span>=
<span class="org-variable-name">OWNCLOUD_DOMAIN_NAME</span>=
<span class="org-variable-name">WIKI_DOMAIN_NAME</span>=
<span class="org-variable-name">WIKI_TITLE</span>=
<span class="org-variable-name">ENABLE_CJDNS</span>=no
<span class="org-variable-name">LOCAL_NETWORK_STATIC_IP_ADDRESS</span>=
<span class="org-variable-name">ROUTER_IP_ADDRESS</span>=
</pre>
</div>
<p>
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.
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.
</p>
<p>
The <a href="https://freedns.afraid.org/">FreeDNS</a> 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.
</p>
<p>
The syntax of the <b>install-freedombone.sh</b> script is:
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.
</p>
<div class="org-src-container">
<pre class="src src-bash">./install-freedombone.sh &lt;your wiki domain name&gt; &lt;your username&gt; &lt;your wiki FreeDNS domain code&gt; [optional variant type]
<pre class="src src-bash"><span class="org-variable-name">FULLBLOG_FREEDNS_SUBDOMAIN_CODE</span>=
<span class="org-variable-name">REDMATRIX_FREEDNS_SUBDOMAIN_CODE</span>=
<span class="org-variable-name">MICROBLOG_FREEDNS_SUBDOMAIN_CODE</span>=
<span class="org-variable-name">OWNCLOUD_FREEDNS_SUBDOMAIN_CODE</span>=
<span class="org-variable-name">WIKI_FREEDNS_SUBDOMAIN_CODE</span>=
</pre>
</div>
<p>
If you don't specify a variant type with the final option then everything will be installed. If you have a <b>freedombone.cfg</b> file then it should be in the same directory as <b>install-freedombone.sh</b>.
Save the configuration file and exit from your editor.
</p>
<p>
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.
Now you can begin the installation. If you are doing this on a Beaglebone Black:
</p>
<div class="org-src-container">
<pre class="src src-bash">freedombone --bbb -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]
</pre>
</div>
<p>
Or on any other system don't include the <b>&#x2013;bbb</b> option.
</p>
<div class="org-src-container">
<pre class="src src-bash">freedombone -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]
</pre>
</div>
<p>
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.
</p>
<p>
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 <b>freedombone.cfg</b> file then it should be in the same directory from which the <b>freedombone</b> command is run.
</p>
</div>
</div>
<div id="outline-container-unnumbered-6" class="outline-2">
<h2 id="unnumbered-6">Post-Setup</h2>
<div class="outline-text-2" id="text-unnumbered-6">
<p>
Setup of the server and installation of all the relevant packages 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.
</p>
<p>
@ -313,102 +444,11 @@ When done you can ssh into the Freedombone with:
</div>
<p>
Any manual post-installation setup instructions or passwords can be found in <b>/home/username/README</b>. You should remove any passwords from that file and store them within a password manager such as KeepassX.
</p>
</div>
</div>
<div id="outline-container-unnumbered-3" class="outline-2">
<h2 id="unnumbered-3">On a laptop/PC/netbook</h2>
<div class="outline-text-2" id="text-unnumbered-3">
<p>
It's also possible to install Freedombone onto other hardware, including other types 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 <b>freedombone.cfg</b> or the <b>install-freedombone.sh</b> script. Obviously, you don't need to run the <b>initial_setup.sh</b> script on non-Beaglebone systems.
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.
</p>
<ul class="org-ul">
<li>Download the <a href="https://www.debian.org/devel/debian-installer">Debian Jessie "netinst" installer</a>
</li>
<li>Use <a href="https://apps.ubuntu.com/cat/applications/usb-creator-gtk/">Startup Disk Creator</a> or <a href="https://en.wikipedia.org/wiki/UNetbootin">Unetbootin</a> to copy the netinst image to a USB thumb drive
</li>
<li>Connect the machine to your internet router using an ethernet patch lead. Freedombone is a fully free (as in freedom) system and so wifi drivers may not work. A wired network connection will give better performance anyway.
</li>
<li>On the target machine boot from the USB drive and go through the installation. It's a good idea to use LVM and disk encryption together with a long passphrase which will be hard to crack by brute force methods. Keep a note of the passphrase in your password manager.
</li>
<li>Within the installer unselect the <b>print server</b> and select the <b>ssh server</b>
</li>
<li>After installation use ssh to access the machine and become the root user
</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">ssh username@192.168.1.60
su
</pre>
</div>
<ul class="org-ul">
<li>If you have GPG keys you may wish to transfer them to the <b>/home/usernname</b> directory. If the machine has a second USB socket or an SD card slot then that may be the most secure way to do it.
</li>
<li>Run the following commands:
</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash"><span class="org-builtin">cd</span> /home/&lt;username&gt;
apt-get install git
git clone https://github.com/bashrc/freedombone
<span class="org-builtin">cd</span> freedombone
nano freedombone.cfg
</pre>
</div>
<ul class="org-ul">
<li>Now create a configuration file, such as the following, filling in the details for your <a href="https://freedns.afraid.org/">FreeDNS subdomains</a>.
</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash"><span class="org-variable-name">INSTALLING_ON_BBB</span>=no
<span class="org-variable-name">MY_EMAIL_ADDRESS</span>=&lt;your email address&gt;
<span class="org-variable-name">MY_NAME</span>=&lt;your name/nick/pseudonym&gt;
<span class="org-variable-name">MY_BLOG_TITLE</span>=&lt;title of your blog&gt;
<span class="org-variable-name">MY_BLOG_SUBTITLE</span>=&lt;subtitle of your blog&gt;
<span class="org-variable-name">SSH_PORT</span>=2222
<span class="org-variable-name">FULLBLOG_DOMAIN_NAME</span>=&lt;freedns subdomain for your blog&gt;
<span class="org-variable-name">FULLBLOG_FREEDNS_SUBDOMAIN_CODE</span>=&lt;freedns subdomain code for your blog&gt;
<span class="org-variable-name">MICROBLOG_DOMAIN_NAME</span>=&lt;domain name for your microblog&gt;
<span class="org-variable-name">MICROBLOG_FREEDNS_SUBDOMAIN_CODE</span>=1234
<span class="org-variable-name">REDMATRIX_DOMAIN_NAME</span>=&lt;domain name for your Red Matrix site&gt;
<span class="org-variable-name">OWNCLOUD_DOMAIN_NAME</span>=&lt;freedns subdomain for your Owncloud site&gt;
<span class="org-variable-name">OWNCLOUD_FREEDNS_SUBDOMAIN_CODE</span>=&lt;freedns subdomain code for your Owncloud site&gt;
<span class="org-variable-name">WIKI_TITLE</span>=&lt;title of your wiki&gt;
<span class="org-variable-name">WIKI_DOMAIN_NAME</span>=&lt;freedns subdomain for your wiki&gt;
<span class="org-variable-name">WIKI_FREEDNS_SUBDOMAIN_CODE</span>=&lt;freedns subdomain code for your wiki&gt;
<span class="org-variable-name">MY_GPG_PUBLIC_KEY</span>=&lt;exported public key filename&gt;
<span class="org-variable-name">MY_GPG_PRIVATE_KE</span>=&lt;exported private key filename&gt;
<span class="org-variable-name">PUBLIC_MAILING_LIST</span>=&lt;name of your mailing list&gt;
<span class="org-variable-name">LOCAL_NETWORK_STATIC_IP_ADDRESS</span>=192.168.1.60
<span class="org-variable-name">ROUTER_IP_ADDRESS</span>=192.168.1.254
<span class="org-variable-name">ENABLE_CJDNS</span>=no
</pre>
</div>
<ul class="org-ul">
<li>Save and exit, then run:
</li>
</ul>
<div class="org-src-container">
<pre class="src src-bash">./install-freedombone.sh &lt;your wiki domain name&gt; &lt;your username&gt; &lt;your wiki FreeDNS domain code&gt;
</pre>
</div>
</div>
</div>
<div id="outline-container-unnumbered-4" class="outline-2">
<h2 id="unnumbered-4">Internet Router</h2>
<div class="outline-text-2" id="text-unnumbered-4">
<p>
On your internet router, typically under firewall settings, open the following ports and forward them to the Freedombone.
On your internet router, typically under firewall settings, open the following ports and forward them to your server.
</p>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">