From 775374f260b3382a1ccdfdbd28dbc12bf068d8d8 Mon Sep 17 00:00:00 2001
From: Christian Rößler
Date: Fri, 22 Aug 2014 16:44:44 +0200
Subject: [SSPS] Some more documentation

---
 .../documentation/satellit_installer               | 52 ++++++++++++++++++++--
 1 file changed, 48 insertions(+), 4 deletions(-)

(limited to 'satellit_installer/documentation')

diff --git a/satellit_installer/documentation/satellit_installer b/satellit_installer/documentation/satellit_installer
index 9283de4..e92b728 100644
--- a/satellit_installer/documentation/satellit_installer
+++ b/satellit_installer/documentation/satellit_installer
@@ -5,9 +5,17 @@ An automated installation script for bwLehrpool satellite server
 1. Preface 
 
 The satellite_installer script automatically installs a bwLehrpool satellite 
-server on top of a naked Linux OS. Currently supported is Debian 7.5 wheezy; 
-it may work also on other Debian based Linux systems as long as packages 
-(especially Mysql better or equal to Mysql 5.5) are installable via apt-get. 
+server on top of a naked Linux OS. Currently supported is Debian 7.5 wheezy. 
+
+It may also work on other Debian based Linux systems as long as packages 
+(especially Mysql better or equal to Mysql 5.5) are installable via apt-get.
+We have tested the script under Debian testing 8.x, but your mileage may vary 
+- we have not tested intensive enough to give any guarantee. By the way: We 
+do not give any guarantee in any way.
+
+So at least now it would be wise perhaps to use the way better tested Debian 
+7.x branch.
+
 Please keep in mind that several packages will be installed via internet and 
 some more data files will be fetched via http, so an internet connection is 
 vital.
@@ -29,6 +37,9 @@ master server which will forward connecting clients via username resoltuion to
 an appropriate satellite server. Or, in other words: If this master server 
 database entry is missing, your satellite server will never see any connect.
 
+IMPORTANT NOTICE: This script may interfere with server functions, so do NOT 
+execute in on any production servers!
+
 
 2. Getting the satellit_installer script
 
@@ -47,4 +58,37 @@ server).
 3. Using the script
 
 Using the script should be pretty straight forward. Just change into the 
-script directory, and start it without options. It 
+script directory, and start it without options. It will download and install 
+any needed system packages and helper files needed to function.
+
+So:
+
+1. change into the script directory (.../setup-scripts/satellit_installer).
+2. Start the script: ./satellite-installer
+3. Read script output for eventual warnings.
+4. Log out and re-log in to trigger the dropped script, or simply reboot
+   and re-login (a reboot is not quite necessary, but will not hurt either)
+5. At the end of the dropped script choose 'y' to reboot, or do some other 
+   stuff, as long as you do not forget to reboot prior using the Satellite.
+
+
+4. What to do if the script has thrown any errors?
+
+Well, the error handling and especially the re-entry features are somewhat 
+rudimentary. If you use a virtual machine it would be perhaps fastest to just 
+reset the machine and try again. Please let us know about any errors 
+encountered.
+
+If resetting the machine to the prior state is not feasible, take following 
+steps in a terminal (commands to enter are denoted between '': 'command'):
+
+1. 'source includes/00-variables.inc'
+2. 'source includes/10-uninstall_packages.inc'
+3. 'source includes/10-purge_install.inc'
+4. call the function purge_install: 'purge_install' (CAUTION: This will purge 
+   the packets given in 00-variables.inc: PACKAGELIST_SERVER and 
+   PACKAGELIST_SCRIPT without regard whether they were installed prior the 
+   first script run and it will kill/delete any Mysql databases / Mysql 
+   installation most brutally).
+5. re-run the script.
+6. As said: Let us know about any errors.
-- 
cgit v1.2.3-55-g7522