diff options
Diffstat (limited to '.homeinstall/README.md')
| -rw-r--r-- | .homeinstall/README.md | 110 |
1 files changed, 50 insertions, 60 deletions
diff --git a/.homeinstall/README.md b/.homeinstall/README.md index d4613afce..1ed2e07d2 100644 --- a/.homeinstall/README.md +++ b/.homeinstall/README.md @@ -1,50 +1,10 @@ -# Hubzilla at Home next to your Router - -This readme will show you how to install and run Hubzilla (or Zap) at home. - -The installation is done by a script. - -What the script will do for you... - -+ install everything required by Hubzilla, basically a web server (Apache), PHP, a database (MySQL), certbot,... -+ create a database -+ run certbot to have everything for a secure connection (httpS) -+ create a script for daily maintenance - - backup to external disk (certificates, database, /var/www/) - - renew certfificate (letsencrypt) - - update of Hubzilla - - update of Debian - - restart -+ create cron jobs for - - DynDNS (selfHOST.de or freedns.afraid.org) every 5 minutes - - Master.php for Zap/Hubzilla every 10 minutes - - daily maintenance script every day at 05:30 - -The script is known to work without adjustments with - -+ Hardware - - Mini-PC with Debian 10 (stretch), or - - Rapberry 3 with Raspbian, Debian 10 -+ DynDNS - - selfHOST.de - - freedns.afraid.org - -The script can install both [Hubzilla](https://zotlabs.org/page/hubzilla/hubzilla-project) and [Zap](https://zotlabs.com/zap/). Make sure to use the correct GIT repositories. - -+ Hubzilla - - core: git clone https://framagit.org/hubzilla/core.git html (in this readme) - - addons: util/add_addon_repo https://framagit.org/hubzilla/addons.git hzaddons (in hubzilla-setup.sh) -+ Zap - - core: git clone https://framagit.org/zot/zap.git html (in this readme) - - addons: util/add_addon_repo https://framagit.org/zot/zap-addons.git zaddons (in hubzilla-setup.sh) +# How to use ## Disclaimers - This script does work with Debian 10 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 - ## Preconditions Hardware @@ -58,7 +18,7 @@ Software + Fresh installation of Debian 10 (Stretch) + Router with open ports 80 and 443 for your web server -## The basic steps (quick overview) +## How to run the script + Register your own domain (for example at selfHOST) or a free subdomain (for example at freeDNS) + Log on to your fresh Debian @@ -76,31 +36,68 @@ Software - ... wait, wait, wait until the script is finised + Open your domain with a browser and step throught the initial configuration of hubzilla. -## Troubleshooting +## Optional - Set path to imagemagick -If the check of the mail address fails when you try to register the very first user in the browser. Do... +In Admin settings of hubzilla or via terminal cd /var/www/html - util/config system.do_not_check_dns 1 + util/config system.imagick_convert_path /usr/bin/convert -## Optional - Set path to imagemagick +## Optional - Switch verification of email on/off + +Do this just befor you register the user. In Admin settings of hubzilla or via terminal cd /var/www/html - util/config system.imagick_convert_path /usr/bin/convert -# Step-by-Step in Detail +Check the current setting + + util/config system verify_email + +Switch the verification on/off (1/0) + + util/config system verify_email 0 + +## What the script will do for you... + ++ install everything required by Hubzilla, basically a web server (Apache), PHP, a database (MySQL), certbot,... ++ create a database ++ run certbot to have everything for a secure connection (httpS) ++ create a script for daily maintenance + - backup to external disk (certificates, database, /var/www/) + - renew certfificate (letsencrypt) + - update of Hubzilla + - update of Debian + - restart ++ create cron jobs for + - DynDNS (selfHOST.de or freedns.afraid.org) every 5 minutes + - Master.php for Zap/Hubzilla every 10 minutes + - daily maintenance script every day at 05:30 + +The script is known to work without adjustments with + ++ Hardware + - Mini-PC with Debian 10 (stretch), or + - Rapberry 3 with Raspbian, Debian 10 ++ DynDNS + - selfHOST.de + - freedns.afraid.org + +The script can install both [Hubzilla](https://zotlabs.org/page/hubzilla/hubzilla-project) and [Zap](https://zotlabs.com/zap/). Make sure to use the correct GIT repositories. -## Preparations Software ++ Hubzilla + - core: git clone https://framagit.org/hubzilla/core.git html (in this readme) + - addons: util/add_addon_repo https://framagit.org/hubzilla/addons.git hzaddons (in hubzilla-setup.sh) ++ Zap + - core: git clone https://framagit.org/zot/zap.git html (in this readme) + - addons: util/add_addon_repo https://framagit.org/zot/zap-addons.git zaddons (in hubzilla-setup.sh) -## Install Debian 9 -Provided you use a Raspberry Pi 3... -Download the OS Raspbian from https://www.raspberrypi.org/downloads/raspbian/ +# Step-by-Step - some Details -Follow the installation instruction there. +## Preparations ## Configure your Router @@ -146,12 +143,5 @@ to boot the Rapsi to the client console. DO NOT FORGET TO CHANGE THE DEFAULT PASSWORD FOR USER PI! -On a Raspian Stretch (Debian 10) the validation of the mail address fails for the very first user. -This used to happen on some *bsd distros but there was some work to fix that a year ago (2017). - -So if your system isn't registered in DNS or DNS isn't active do - - cd /var/www/html - util/config system.do_not_check_dns 1 |