From 0a0d5302050acba72f62b2599132a500514e6af8 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Sun, 18 Jan 2015 20:19:09 +0000 Subject: [PATCH] Updating the documentation for menuconfig --- README.md | 72 +++++++- doc/installation.org | 208 ++++++++++++----------- man/freedombone.1.gz | Bin 3528 -> 3721 bytes src/freedombone-prep | 2 +- website/installation.html | 346 +++++++++++++++++++++----------------- 5 files changed, 369 insertions(+), 259 deletions(-) diff --git a/README.md b/README.md index 25d63fcb..8f1e1173 100644 --- a/README.md +++ b/README.md @@ -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 --iprouter + 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 | diff --git a/doc/installation.org b/doc/installation.org index ac5b8837..b544309c 100644 --- a/doc/installation.org +++ b/doc/installation.org @@ -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 --iprouter +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= -MY_NAME= -MY_BLOG_TITLE= -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 | |---------+------------| diff --git a/man/freedombone.1.gz b/man/freedombone.1.gz index 1a35cfb905f953a33b57756a36ee47565450426b..fc6c8d7573a15fb292250675abe6f7d568bf0f44 100644 GIT binary patch literal 3721 zcmV;44tDV$iwFR761-FZ1Lay<b0WtTe&<(o@v_NApw)VJEve$fAh8l&1Qa04n~h5~ zmj=dyX*}H{gv*uRp6{IQndw1jotIRlDwJ(OU(e+`*LHh$E#{e&v08^JmEuG+PremD z1gUuY=Hz`-H1W?zZ~j)x?3ETbL7E4vW~0%bUW?|ibJJ@!{A2#v5*@KrYbmh)QD!1i z={#BFSzr>Cx^2_X!_j!!pEer;AAfr*7GLl^NYbB0D;HmKoRS7>iC<cL(K~JATA1BN z{`{)Jn_ElKYAxkzBmB>FskVYf8*X4N)7(;0uIUAOCz902EQn0<DDhpJV70P@x<##4 z7>2c@Mc*z<(uGi|=*nQRl1zJd6+{n~s2m%K^x8&}pfIYqN0=pqWH}17-4|n@W#8L( zDd$1HGQv%eIP7YT)$Ra~^-4w+6G>e>SY^OwBnF+K=#NDZ$C=bxsJTa!zdKX8@whp> zjb)iiBkbyGe;lW}cKhWHOyK&<;Z)%4$0Ww#mc9C}nhX!_DgaX7w+XcV`aW8*Raxv% z6k%heVp%7%E_kvAI)m0#*Wu($g)6lvw%-&3FKpN*4@vE+I}E(AR&CR0rSiC3KXL;v ztj}b;4osFj6&ohSzzZ9E!uivEM)(0%3y4;%?qjp$w1#Hp^x#te)QXOSOADEl%S)LY zTwaQ#SYL_cnL!z>H_3Vr1$GsH7Q;?OAZCN9;8j}XS>#=%^|H28(7;AzMx^;V^etkQ zXj5A`&chWTiksN6@O+(*NWs?pEkiz&jPGK6D|otEO?zt>d<Lz1CrY~Q*%~|QOuJf~ z>peF(4$M-_RmP@&JMD@%BPaSNxoC^ySUw)>I6V2YNB=K-UZ9r-;Yx~&AAmF$7cP6# zi%EYx>yL)b#%w7Y?XDjk8j)JBgETIzSo7UM2$`9k?^y$gW4&2PBe7JriVy?^`jN@G zPL*P3knSM-Xqmu|Zxe79(8W-n9~4N|moiKcBY%K!64@4gBenpA%92HrV%<(enG6hW zBGCXd6eEbr{Wu|}-HRg;=0+qsePy8Wbwb-fi&+K+{wafl&R0PumO&P8gABJpBpDc{ zf5lvGfh|x$LVOG|P-S$Rto60{m_rDT^7A5KX(1ow&Va=QFS>!AL-lknI;m5-lMC~I zHNFxujk4W_IVY+6;N%l7$m-4!Y>A?IvXc6U7Nv&l1v&^;GL69iZH^R#7%HRzERtA7 zIbyOAGEPiE(NslA0D|pbflvYu{XkbTNibXx&6Z0iUJY;EO3MyT3eLqO2g=s;o!Lnu zphV}<l1%q<Fzk?kH>&{J&NU1UN+KjFO+@Vo|9~!S;xq3u=p;KA*9zvyv+V5XcJggj z2+-C!z|5ioh5g9|FZk(ZJg!I}G(h()qgn(3E6#LBzv-`ta0(wcROz}<%yY#F`4q{G zDecbJTchEpYfJFEhEKqf4ZbJLpq5ddk*!!GN*;q~cVyXF%CtZXm>`Wmhiqa9(bnq1 zJXx6*^jx4*WH?8yovRZInIf?=pp$$i5SE%uZFbIQwuR^bqGZo`nnY|}+G?2(S5J&` zSxPnBK`}NOLvIiSEz2YwKp3<8=Nax_8ne;o$H$>G&>inrZIvz9dVtbQZplSJAf8(Q zC{zmL#S9Y1J+hnyrxJ?PLAGO;u32o@7lSR@ClnS@UJ*S=14Brn^@eVV6HR{3XW_`| zO*4-gGQw<<dfY<2YsV*}ZeydvgS48n!Dp97%S@#>-uk8py466l4N$~RTXaE9zOfet zE3K+KtlA@JCX`~OV5?*cnOrL);YB)oPO^dqU0_~z&CoMMOnwlegQMW=kQPGob7S2Y zFy7*!Ou~aD5I`a=jdcGb#o62->cRoCOU*YbtvTX044;U=4oEm<#~)?6VPDAU%r;=R zLJA5ACFC(n^lvC>k?XdLI{o2v))@>sHth80By+$T!Hm=%TZd124Hi7aj)Fz^ORmki zO_1Wv!$PzYUnciY?Wd<U_BR?Mn8Av&<A5p+uvDB7Bb!;NAm*#UoP?uc21u4gI7>|1 zUb27%BGn=Db|}ZlG7sC}@Hh<gGK-FVrO=)z7W+f%;GwK`oD4d*m;G6@F-_8lc!X3F zErLA|Y?lcf={5mLA;~#~Nt7|m%l}&zrKF!Zxgec~zmzN4RBXYp0oDK)KyMlR1~;PJ z4IBU^g%Q|D3+$urOx9#|h;de>f^!Fajg}IgX-hl2dMZ}Z87NI8h6gCjf@m9^QZglz z%n__}N~{3>Chk~K6m3G>U&%gfz(&!SGdcqiBJ^iFN(MkEVS>h>4FOOl8^dUY^^=|n zlgGKvj<LsA6$uZr5k@}Qm<W0bjCd?A;95Lev>>rlTK<|#(w=kY?2YIM3LFnMT2%2| z!#jc&=G*vw(fzJf?TiI27D{mjOdwSG3LdRYNvsvZz%r=cxp;@H@uWBIOxU=@$I(P| zd!4I6uR9v{M0e1+_*7WjD;$$5Q*dX?YnI8gI8?Ji{ea?@5sT}sa~Kit+eA~QXN?$o z+mQ7Fj(b{dAwk?UEbbPtO*m|6fd`OM7lHBxEU`%!S3uKCT%5%PgBRDmi%*086z0>l zc+c`QEn<|f;{rfLI$KdHNr{}wad<ECw`+1fn!J`RQ4mg`7no7`Gm{HAS4ok>rK_=5 z<+`-PCRNUM?Wz=4eKn=!Jv|a2S+cWnTF6QAfg1lc<-m}BnTui}qySGJyFkfd`9Oo9 z@Ec{j0Y_QqyLEOBl*0LwAF5@9B#g2at<X@3bUGb~NFsrrQxKOF>N6NQ!bt3bf>|nE zO4pM)j5dfU&hHUtRZU6pr{3pjJxa(YsDjR=X~bx4Ns1`lp(EOhG~b|@g^5M5>z&1Q zb+~ixI@*X<CjNEo))$?P@BNU{AK$yu?EIK&nd7qmQN*%YZ_>G#^?&S%X>WEr<~pj@ z<~r1uBT46+u9P{ID`D1@`qCvDc9r@*cFUGu^I_UK=gLFbYKRLm|2irb3brBgKVa3a z%lS{RF)et(GBzRr{`W%TknEovClY9i%-dl1LIW?+MPjrkYlzh`>PxC>M>ZOt3r8kb zz=sQguAp<chKT&?)&^J3sb%Jp6zj7BQXt|0Xe#~Fa5QWkfQ3VFtSFcj23KYr6%VVO zy^N!<Z{%z41eX=>K^+r8b45wDMxONlh94S80|dspsru*m-`mj~aOlJ~8MI=9Td|os zxk4I#3|6^hMU$svEz>nOpYMA&o&Mmyb9p)GO{d=#qtu}<e{=_<tNU4hHrN}Q-gdpw zkGF#X4_}UO<j_B&e=!*yo|^P7Z#uI{|EK3uqr2h7V03%=eCDqIssF;LM^A6q=?;4L z+$j1kRXjErU33Qb!`|#}H2HLo{C(EHAdT19pNwt+``U1$i!!aqKdTnDD?e-<<PRTF zBi)rDZWkA4CueWlCm&ARNb!$sY$fP~lEOeyoEN=)Yp$+7tS{M%h)||8OQOaWfJHBs zTaWRfR(35N3ijbcCdEbMa|=2u(m+dYkzQ~C!Vn8KxMTxQgqlzkerldLhU_v|9T#Mx zoCD=4(be=C?@dRLt%IAt<_YpRL~uB<r+`{@P0PkgsfSWJTnM@ISAnJ`84KBLrL?1e zXX$=N?GtiW6r~z<41b*Tdbpn;?tpeNx_pM&udS*;|Fu;m$iKFTk^Rzw#<VCo5BX6l zt)JkdIGJL7+A5)Kqg0{(5P4zhpyk)g9;{+zHEvr%&(rJk=i$n}g7Mqj^S7vH4|Vpv z=gUE?mT!C2^G<Ey{xSTJQ$NZ*-2BW{wX&t0wXL%FqmYJ5c9qAn=v6Qa4aL>Zfq?u! z$J>lM+v>5Z8uZc?T~uEPr)5oj{wlNNVvzEO7cAc9s=6{}>QJ))=dSx{Gh#A+n^#zo zKt#4#U3o))+DR<Y6;18{lI`5qvKjYGYfyaV;rP%OeH?eN3J2GUgw-Y&3L6<E^IhdN z4kY}ZhpYUo#Y(X~DDy6QKCSwZbL#Dv*Kz8F6xy|9i+)I%w3IAzbr6WxdoljCRfWr{ zJiQ*)DO-He7?HKpUW=+HL8vHe?$LDCa(UjAGyCFY*XI6SbE&KXi-a~q8u~~ga2+pg zi+dy3XWL{XmK#(E+BW8%C#=y@DQ$fg>%EL}A%?a|Y?f_m|H5qn;RLEBH3K1r%r?qV z5ql39j>5ywC}mONP1N>LCkrdKieFR^&o#HW0`M6s#g(f~qzEL^K1tDef85pvcfVx; zRd08s$(XJ#n-ctTRIBnBP3H%4R%bk|jd+U>5<q^6qTHI&ZR)Xm?6^7&Ls=fV_H^}_ zt&4{4T;;Ykw3m5KdY#Lgo;81mJKJ()Cr};ZO7_51(TDrg#E<2KUwDcQL@%I{l`k!y zq@=l@+MM*)L10rIKe4juLfL{UdQ(TRI2Y%uY^LhH7fl8xsYr4xz@3BtT}*8w1mEnN zC2#)SPPU5AUs~SBO^WN;Y;3<3pVK$OpPc%W@7{e=PEKKg{!Y?rImu5@-sH*In>Q~` zp1$=a`8|ohy~ly=Hvap~fl2#$|MtV#!JVgXXy@rkIZ4k|{>~2{&c1zd@(iDH@+vX) z$#*BG<z&yjEmz`u`~Kz0_ov^!Jo)a!S9YGAkr15M>rAI82QH`0#<)VV%1W=d*{sS( zoyxQUKxfsiqgt~ehxLPYB!YQSfIAzfS2yxqJ3ktD#>S>*dry_Ixz_K#F&!PUCT6sI zdj%dRlK<C&FkgThLpjcWRJk4}TBCw2`~I`*(WHs8C=@r!7&tWX*HDGuXDU=CiF7-E zXdCsnMmx+J<E!!U)%faM^g3s!Z+qXI@@O|PYkC-4$aB%XX}yi^^5wew_+vcJu9pM# nk6ElY7Z0CgGE>>D)YAd)x|88K6AXImcQyVEDDBk@nkE1Mq2D8x literal 3528 zcmV;(4L9;1iwFQs*1J>y1I=1na~jDNe&<(o@#4fKQ0!EaT~#(&5ZGpoKm};Ej^lFm z%rr2oVS0ADM~HpMZ_js5_uK$^Q>jYID!T+dr@PPfJC{*^^-ipFr6RoxbgINF(S7w7 z@q<jo>p#5uQ&)8H?@i<Rol*G<BW`3`$fVop^q22McQ&{gcRS5v{@D`)vDG^zK>w(6 z5$bduZ;D*nSf_s5^22O?yPPb$9f6<b_Fg1D;<Jp?Poh_dj|EOi<xb(75g*OLShW-O zkf~2EI=s2J6}{e8C7EdcEVp_uXtm=Pb}B6#Cl$?DnuCZ_t8y9I_)+1ru`)><qn@bO z3xc3^w3s-uINb=HilLI5L^1EfM1~KJsRA2`_0~qxps>2UN7yZt<Rp^D?TfI_iQm{a zQfpZxR`>^`4o7W3?GI>(UhAk9B5tb(R2E`}Vmg?K$*qu4lq+L|UN@L(?#^{#8`7NL z#=1<E6^^>zA4REY-99=%2wXp!Ed|bgj3XTG#B1+r>G15X(m~q$GHJ}0_YuWj=aKiK z5F0}ssWzK!#ZxrU8AMlKhm&(1BzjYBzbO}<*|3iv;?`C7Sa^n3@6#~RMO4wx{lYW! zxr%nu=J8XxVNotTv!Tg2{|rwUKO<`CqP3{UzFA4y@@AIwENS!9nvb)jrA{jHN+)N@ zE0vV=wMtF`%7Wg;yCW}fRB*HiaVn%(O_zeHj4tx9ag{OK)=ohSna-_9i(Sx+h$J?) zMR{8U30xF6F|hFSwj7~GtTngH_)H4E>)SiQk85h$+q&Qbcs)8%(QPL*Zq<i&O<b5G z7`&BsE7m&a(7#&_MU)eW{!VTB;xbZ?mnI5c{l3Bf&qpXQPGyiNas2~4&F6*DczL~; z+^#0`S+}#=s!o5{%nqGU?{+ec$|yE`w+x^&duSr7ggSOvqO1a`>Xj)725e>~51l&2 zPMIE{{BRos$M-QLlXNl6*Gvke>yZj#<j5bOoLKe6#ELzfLg(=&PC<7NVXmabO{5z5 z4CM&o@;Fb3<?#AK1ceo`Nnco4d>7L;@M5>p0-tgKbdkthY-JwpWscjRk{kllf3a43 z_!hVzB|gd=Tv^knXniT(6i|Za{Hjb?MyN-1un=*>L^rT=pr5Y9AoWJ~dSUtB-o6zo z4f8|Bl9Se(&dDcSQ`B7{*%C+VI8o+;h*C@O0vpIgr4a<6&7p=81C26(RTAm2Ku)$o zMX@b8TIw*CVA%Z@NF_k%2fC73Lg0dFj$AtN?d;A|I&pB4yb_B7UbdspEKVH4OH2`N zDRf8E*?<(BB@)&y3<3^DB2UtWm^zUE!*yvBpLw6dCi#_krxA|)l);W}Cv0;{fVHmR z%&aPKI9XgX!B020w>1mo4X}OB>K?g(Q)hah@AO-QIE9a!>2y~b=G1UPJ%uW>Ropf0 z*6B3MwJqe`0TV!y;d9Ia8Wk2f#fl4}_)&(33n$K2rKQI}2(tL8%f^;G+C^PZ#EI>} z&ZT#X9OvkrhdQxQDGDnKJ_$47VX4h^cJP?l7h(VxrFbsVIOOOu&dPkaeqt|Il~#iT z4CAsf>;^>;S+3{+@-er6o#XzkwVAoPybP3u?RdZL>wLq}124_ho*)7WX}|)ULZ=8` zJVD`j#FmfXRKbu&<_Cs!!)n962x8Gbp+Q7-MfjjB0wE4}8Ql`ahH$Pa!iBS&VHpi{ zgr{-ZkQV0Mc{$nZGM615l(U>mK8G~i<~qgk4x2*Q*1(%xf+BJHVhC=E%v~fCqw71I z*+W<+P$JQYRf>gN?X*=uk--s2)~-Pp*yo`cc7}=x2cbFu1y_ee2+OangE9DckC$=< z1dE}7SUDc){zuBQg+<l{05YT&nNC|k+(+OO6W9R_rwsgIURcILE@$?VVTBA7ke3i* zR^Fdc(V}*JpLHg)<!UgU4qV!qtV!o^Ya}x=d*lG0>?$|B#6ZES`?)ao$`wda_OKDX zxT%xRPyMH-KK6GybA&-c)v=^b10t0tM5tyGEhD}P!YKd^3qZOo(^+i$?vf265Ty=< zxA$_aY>S`|2`>X_wt0BjGz#qrBXPX6lMhw5<8?5&8%<W-&N5Czk`Y>sjgUu9u;0c2 z(tQk;0@8Dekf?H2qyFzXFD3h|34%-!{9I9TsJMn9gRj9|;Cfs6D`3R<8#n<fN+XDo z9>hoA8Sg0SkmH<51=kMv7;Y7iX-_*E{Zyot4^Vm#TV9|v3#MImN-30VyhgGvsIY?b zcX3BTS+omvf1&zt2^&pg!QLrFfYhHKs2BjF<P)?8YX~@HoLTl(L_gV?eDbm|`6c!= zO-0IsZiH1&E+>MY(nlI1ZU8NfSaeR}9vSsZp~!k3&KZs92ud6eE?d<3+yEWH3(IYr zxahyPx_0&jBQ{!d1x!w;iv);Pl_V|-5nwsY?;+lM*6m_^J6LdVi8u3w7>);Tr{m## zHWtI_;QD<TaW8O8s%<HqYp+=+CwZt9gXRIvEqg4kci=E5+4r%bO3wu`?3PjV!X1yS z+Czbub)4UA5SsvO<s1)AN>c=?7eL~QF7AMqBV3$ErGVG(#@FwslO@7u==?n|(zMJ` zrPC0*966~X!*Th>DZQ-O-Vxv!LMqpmAcepd2%YL{t~LNvMcKlas8OS{^`(X@q<p+O zsuWj!v5e(CV^SJLua9dY<ihw&U;mQoUTD0kKS2n|f$ot{j+~0m3<XN8s74Gp$^q`) z$2L3@fKS-dssc$FRsUIgK&{f{aw<ZFqIpe;TTyz?5!gr_kxvA6t4*cdhRzYFGNjyo z#GErP6~gbwAC~RRpq^j~I+q?JFB`{FNF@#((ch#+h6Wa46(W`o&X?=MJ)oN~6TMvg z>(bMg(~R$%X=HNy*|%d?m(;&pRx=OB;hVeZRJ4=WJZ+-ko@2CyHpatfjU}#c;nt}c z`c&4J%tBGW!Jwln_?OIV4|r8&F{G;hSrVg#R04w93TmFy{M--M8`L<FOS@}LRUeG$ zY9ew#T7HyCp&0nczf|P4aP#5w_+~JfejbcQi}7;#UAaoL(CW)@I)D3lHCauMmX>$J z#wuBkmq&9PIcpv<xn9iAKU$1OH-pt;^3&;~`TgvAI=>s8KDnQ~pFFeL;AcD=45#DI z+>(EnYF?YpuLsl5v+?SFzIgu`PPUp{lf_%&FXnfv@uIcd8KNLAGkrZQ^o5?QIGf8C zG_v#spWnr0@T+fM_h0?_n?8!E3x{arI)S3#E8C!Qit4HkUx~L#j&KOZ^x;h0xKg{E zdhw7aIyW?IB_4U~J`_@1uAfHGMVW9NyCtY|smCrRGhBj>3?bO3ISk*hj=eyR%=aNB zn<$*Yc}jeB8zauHXUKIN-Cv3r856jP{^Ci}P^9a`NVI;aw8JH*KR=O%#u2P!yI0Ds z{++e^9W|;nFITzo@lg5jo5gsH`^m+<qg~HOCqDZns@mzlL{&NYmx$Q2pCjlj%i{jj zQY<FW-MSRU_H^|a<ei}&D9s-r8>im2nw?3*ts?C#?waq@LdLfat@j`NzJcF@oKF2u zUWvHL`p2`rTD?W72k9-s<70Sa-ag8Y$UkxaqFvGKVyh~%sS-xdkQ9+ByFwPBqq)xP zpONrulWoN_M6{h%t!B2qyroJ`cq<#4sMh(M%Wf(fpNV)^A(%RtX%@%|T>Ckbt3xRG zU7P7t0u{NjV2y^&$6jNxsd@4TkZ#wmYsh&z)pErXgyTb>#W<c7lmOQYg|jA?XPFA) z^`S<MGi6o-;cA?9zEW<N<;ap>RMnH8HBC{g>xdPF2GkF~%FeSYS}GB_CX?djQI3D< zOu^?MqHDXJw<$+_*@CLpX)i_H{gGFYT+Nc28z3tfZCx1=sZ6D4X?b|z4lPAy2-#|F z9NMtOs{9mSX&*;++ous300+KF?y#kS2?WU9FcBR@W6104`tze^G(;y4;v?osA$!eJ zXJlf-V*rVcBhZ>FeOCgJd6gU6(|Nx=`h#@8=8~%2d$K`9S67W2PuE*jG5f*QnQGI! zeJ>NQ@q^Nh$My6kntBkLLpH=gszn1qOL-Cc5nlbm&y+*2wJu!yd{i?o#)Hw#*afcl z7&n&U@U4&WEe=}mDsS*CkK}QZ@D#k<K>VTw&8unjd!^{vPh}rD=2`BK&PTePCT?(K zG%&REMVfz<Lrm(Jnq!*k9f@oXI$MK&Is#tn2Fr;-<$;EXzM%X;&I|cHMr+4T9$c&$ z_a3DjCr6Lq8PYjNQu&VCXL<<(hoU*ZO#Ga(286Gvk6O8kXmjF_%`x0FR`~k6BPU+t z{n&p|jeH?f8{ywrxIZ-bXwLm@!Kdcm5q$K&k4R4I3{DR4Bxj9t9RB}!`#Q3zo2d<! zOSEI7Ww&!%;}MOEd|+o;QoX*Y0UEW0$7Vk}Y$2gXtg~n+<l3rMuSM^dC<7gu*|-6j z447`>QbVR6avnqC#j}_=yn7277m8n^2gL@`SgJAqqu98NjX?)rO}JO@=8G=c(m>p3 zYmt`3UjrR{pX)%wCrrP1=v)1_PCv*yw{LGRfk;<kJoxsT*W*8a!>hv>SY`}Zz7oTm z-s|wb*zSgpKSt~P-FB+~v5HJ~{qSDJE1lmdvz+p-dlg(U!{E1lSLfej{mvDHB>(^e C)!tkH diff --git a/src/freedombone-prep b/src/freedombone-prep index 8073ceb6..d314173d 100755 --- a/src/freedombone-prep +++ b/src/freedombone-prep @@ -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 diff --git a/website/installation.html b/website/installation.html index fce28439..759deb9c 100644 --- a/website/installation.html +++ b/website/installation.html @@ -4,7 +4,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> <title> - + @@ -167,38 +167,33 @@ for the JavaScript code in this tag. + + + + Home -Download the code -On a Beaglebone Black -On a laptop/PC/netbook -Internet Router +Preparation for the Beaglebone Black +Checklist +GPG Keys +Interactive Setup +Non-Interactive Setup +Post-Setup +
-

Download the code

+

Preparation for the Beaglebone Black

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

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

On a Beaglebone Black

-

To get started you will need:

@@ -216,7 +211,7 @@ To get started you will need:
  • 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)
    • @@ -229,77 +224,213 @@ You will also need to know, or find out, the IP address of your internet router

    -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: +You can either install from a debian package or manually as follows:

    -
    ./initial_setup.sh /dev/sdX
+
    sudo apt-get install git
+git clone https://github.com/bashrc/freedombone
+cd freedombone
+sudo make install

    -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: +Plug the microSD card into your laptop/desktop and then run the freedombone-prep command. For example:

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

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

    -
    ./install-freedombone.sh <your wiki domain name> <your username> <your wiki FreeDNS domain code> [optional variant type]
+
    FULLBLOG_FREEDNS_SUBDOMAIN_CODE=
+REDMATRIX_FREEDNS_SUBDOMAIN_CODE=
+MICROBLOG_FREEDNS_SUBDOMAIN_CODE=
+OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=
+WIKI_FREEDNS_SUBDOMAIN_CODE=

    -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. +Save the configuration file and exit from your editor.

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

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

    +
    +
    + +
    +

    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.

    @@ -313,102 +444,11 @@ 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. -

    -
    - - -
    -

    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 the install-freedombone.sh script. Obviously, you don't need to run the initial_setup.sh 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.

    -
      -
    • Download the Debian Jessie "netinst" installer -
      • -
    • Use Startup Disk Creator or 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 -
      • -
    -
    - -
    ssh username@192.168.1.60
-su
-
    -
    -
      -
    • 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: -
      • -
    -
    - -
    cd /home/<username>
-apt-get install git
-git clone https://github.com/bashrc/freedombone
-cd freedombone
-nano freedombone.cfg
-
    -
    - -
      -
    • Now create a configuration file, such as the following, filling in the details for your FreeDNS subdomains. -
      • -
    -
    - -
    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_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
-ENABLE_CJDNS=no
-
    -
    - -
      -
    • Save and exit, then run: -
      • -
    -
    - -
    ./install-freedombone.sh <your wiki domain name> <your username> <your wiki FreeDNS domain code>
-
    -
    -
    -
    - -
    -

    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.