diff options
| -rw-r--r-- | .homeinstall/README.md | 101 | ||||
| -rw-r--r-- | .homeinstall/hubzilla-config.txt.template | 47 |
2 files changed, 87 insertions, 61 deletions
diff --git a/.homeinstall/README.md b/.homeinstall/README.md index c0de914a1..3c2673ec1 100644 --- a/.homeinstall/README.md +++ b/.homeinstall/README.md @@ -2,10 +2,19 @@ Run hubzilla-setup.sh for an unattended installation of hubzilla. -The script is known to work with Debian 8.3 stable (Jessie) +The script is known to work without adjustments with -+ Home-PC (Debian-8.3.0-amd64) -+ DigitalOcean droplet (Debian 8.3 x64 / 512 MB Memory / 20 GB Disk / NYC3) ++ Hardware + - Mini-PC with Debian-9.2-amd64, or + - Rapberry 3 with Raspbian, Debian-9.3 ++ DynDNS + - selfHOST.de + - freedns.afraid.org + +## Disclaimers + +- This script does work with Debian 9 only. +- This script has to be used on a fresh debian install only (it does not take account for a possibly already installed and configured webserver or sql implementation). # Step-by-Step Overwiew @@ -14,25 +23,28 @@ The script is known to work with Debian 8.3 stable (Jessie) Hardware + Internet connection and router at home -+ Mini-pc connected to your router ++ Mini-pc connected to your router (a Raspberry 3 will do for very small Hubs) + USB drive for backups Software -+ Fresh installation of Debian on your mini-pc ++ Fresh installation of Debian 9 (Stretch) on your mini-pc + Router with open ports 80 and 443 for your Debian ## The basic steps (quick overview) + Register your own domain (for example at selfHOST) or a free subdomain (for example at freeDNS) -+ Log on to your new debian (server) ++ Install Debian 9 ++ On your router: Open the ports 80 and 443 ++ Log on to your fresh Debian - apt-get install git - mkdir -p /var/www - cd /var/www - git clone https://github.com/redmatrix/hubzilla.git html - cp .homeinstall/hubzilla-config.txt.template .homeinstall/hubzilla-config.txt - nano .homeinstall/hubzilla-config.txt - - Enter your values there: db pass, domain, values for dyn DNS + - Read the comments carefully + - Enter your values: db pass, domain, values for dyn DNS - hubzilla-setup.sh as root - ... wait, wait, wait until the script is finised - reboot @@ -51,18 +63,36 @@ The installation will create a daily backup. If the backup process does not find an external device than the backup goes to the internal disk. -The USB drive must be compatible with an encrpyted filesystem LUKS + ext4. +The USB drive must be compatible with the filesystems + +- ext4 (if you do not want to encrypt the USB) +- LUKS + ext4 (if you want to encrypt the USB) ## Preparations Software ### Install Debian Linux on the Mini-PC -Download the stable Debian at https://www.debian.org/ +Download the stable Debian 9 at https://www.debian.org/ +(Debian 8 is no longer supported.) + +Create bootable USB drive with Debian on it. You could use + +- unetbootin, https://en.wikipedia.org/wiki/UNetbootin +- or simply the linux command "dd" + +Example for command dd... -Create bootable USB drive with Debian on it. You could use the programm -unetbootin, https://en.wikipedia.org/wiki/UNetbootin + su - + dd if=2017-11-29-raspbian-stretch.img of=/dev/mmcblk0 -Switch of your mini pc, plug in your USB drive and start the mini pc from the +Do not forget to unmount the SD card before and check if unmounted like in this example... + + su - + umount /dev/mmcblk0* + df -h + + +Switch off your mini pc, plug in your USB drive and start the mini pc from the stick. Install Debian. Follow the instructions of the installation. ### Configure your Router @@ -79,32 +109,27 @@ You can use subdomains as well my.cooldomain.org -There are two way to get a domain +There are two ways to get a domain -- buy a domain (recommended) or +- buy a domain, or - register a free subdomain -### Method 1: Get yourself an own Domain (recommended) +### Method 1: Buy an own Domain -...for example at selfHOST.de +...for example buy at selfHOST.de -### Method 2 Register a (free) Subdomain +The cost are around 10,- € once and 1,50 € per month (2017). -Register a free subdomain for example at +### Method 2 Register a (free) Subdomain -- freeDNS -- selfHOST +...for example register at freeDNS -WATCH THIS: A free subdomain is not the prefered way to get a domain name. Why? +Follow the instructions in .homeinstall/hubzilla-config.txt. -Let's encrpyt issues a limited number of certificates each -day. Possibly other users of this domain will try to issue a certificate -at the same day as you do. So make sure you choose a domain with as less subdomains as -possible. ## Install Hubzilla on your Debian -Login to your debian +Login to your Debian (Provided your username is "you" and the name of the mini pc is "debian". You could take the IP address instead of "debian") @@ -135,7 +160,7 @@ Copy the template file cp hubzilla-config.txt.template hubzilla-config.txt -Change the file "hubzilla-config.txt". Read the instructions there and enter your values. +Modify the file "hubzilla-config.txt". Read the instructions there carefully and enter your values. nano hubzilla-config.txt @@ -146,7 +171,7 @@ Run the script Wait... The script should not finish with an error message. In a webbrowser open your domain. -Expected: A test page of hubzilla is shown. All checks there shoulg be +Expected: A test page of hubzilla is shown. All checks there should be successfull. Go on... Expected: A page for the Hubzilla server configuration shows up. @@ -162,3 +187,23 @@ Leave db type "MySQL" untouched. Follow the instructions in the next pages. +## Note for the Rasperry + +The script was tested with an Raspberry 3 under Raspian (Debian 9.3, 2017-11-29-raspbian-stretch.img). + +Be patient when a page is loaded by your Raspi-Hub for the very first time. Especially the config pages after the install will load very slowly. + +It is recommended to deinstall these programms to avoid endless updates. Use... + + sudo apt-get purge wolfram-engine sonic-pi + sudo apt-get autoremove + +It is recommended to run the Raspi without graphical frontend (X-Server). Use... + + sudo raspi-config + +to boot the Rapsi to the client console. + +DO NOT FORGET TO CHANGE THE DEFAULT PASSWORD FOR USER PI! + + diff --git a/.homeinstall/hubzilla-config.txt.template b/.homeinstall/hubzilla-config.txt.template index 040b0f2f4..089917c68 100644 --- a/.homeinstall/hubzilla-config.txt.template +++ b/.homeinstall/hubzilla-config.txt.template @@ -13,10 +13,10 @@ db_pass= # This script automates installation of an SSL certificate from # Let's Encrypt (https://letsencrypt.org) # -# Please give the domain name of your hub +# Please give the domain name of your hub. Examples: # -# Example: my.cooldomain.org -# Example: cooldomain.org +# le_domain=my.cooldomain.org +# le_domain=cooldomain.org # # Email is optional # @@ -25,7 +25,7 @@ le_domain= le_email= ############################################### -### OPTIONAL - selfHOST - dynamic IP address ## +### OPTIONAL - dynamic IP address - selfHOST ## # # 1. Register a domain at selfhost.de # - choose offer "DOMAIN dynamisch" 1,50€/mon at 08.01.2016 @@ -42,7 +42,7 @@ selfhost_user= selfhost_pass= ############################################### -### OPTIONAL - FreeDNS - dynamic IP address ### +### OPTIONAL - dynamic IP address - FreeDNS ### # # Please give the alpha-numeric-key of freedns # @@ -70,15 +70,17 @@ selfhost_pass= # freedns_key=U1Z6aGt2R0NzMFNPNWRjbWxxZGpsd093OjE1Mzg5NDE5 # # -#freedns_key= +freedns_key= ############################################### ### OPTIONAL - Backup to external device ###### # # The script can use an external device for the daily backup. -# The file system of the device (USB stick for example) must be compatible -# with encrypted LUKS + ext4 +# The file system of the device (USB stick for example) must be compatible with +# +# - encrypted LUKS + ext4, or +# - ext4 # # You should test to mount the device befor you run the script # (hubzilla-setup.sh). @@ -113,28 +115,22 @@ selfhost_pass= # lsof /media/hubzilla_backup # # If you leave the following parameters +# # - "backup_device_name" and # - "backup_device_pass" +# # empty the script will create daily backups on the internal disk (which could # save you as well). # # Example: backup_device_name=/dev/sdc1 # +# Leave "backup_device_pass=" empty if the external device is not encrypted. +# backup_device_name= backup_device_pass= ############################################### -### OPTIONAL - Owncloud - deprecated ########## -# -# To install owncloud: owncloud=y -# Leave empty if you don't want to install owncloud -# -#owncloud= - - - -############################################### ### OPTIONAL - do not mess with things below ## # (...if you are not certain) # @@ -160,18 +156,3 @@ mysqlpass=$db_pass # Example: phpmyadminpass="aber hallo has blanks in it" phpmyadminpass=$db_pass -# TODO Prepare hubzilla for programmers -# - install eclipse and plugins -# - install xdebug to debug the php with eclipse -# - weaken permissions on /var/www/html -# - manual steps after this script -# * in eclipse: install plugins for php git hub -# * in eclipse: configure firefox (chrome,...) as browser to run with the php debuger -# * in eclipse: switch php debugger from zend to xdebug -# * in eclipse: add local hubzilla github repository -# -# Which user will use eclipse? -# Leave this empty if you do not want to prepare hubzilla for debugging -# -#developer_name= - |