[SSPS] Some debug stuff out-commented, started documentation

1 files changed, 47 insertions, 0 deletions

diff --git a/satellit_installer/documentation/satellit_installer b/satellit_installer/documentation/satellit_installer
new file mode 100644
index 0000000..4096cdf
--- /dev/null
+++ b/satellit_installer/documentation/satellit_installer
@@ -0,0 +1,47 @@
+satellit_installer:
+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. 
+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.
+
+This means of course a viable sources.list including entries equal to this 
+example:
+| deb http://ftp.de.debian.org/debian/ wheezy main
+| deb-src http://ftp.de.debian.org/debian/ wheezy main
+| deb http://security.debian.org/ wheezy/updates main
+| deb-src http://security.debian.org/ wheezy/updates main
+
+While it may be wise to update the Debian base system before installing the 
+bwLehrpool satellite server, the installation should in no way interfere with 
+any system services so you can (and should!) keep your server always up to date.
+
+Please remember that a database entry in the master server is needed for any 
+satellite server to function, as the bwSuite clients will first connect to the 
+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.
+
+
+2. Getting the satellit_installer script
+
+While this point seems a litte moot, as you are obviously reading this 
+documentation now and the documentaion here is part of the package, possibly 
+you got the script as an archive and would like to know how to get an 
+actualized git version.
+
+You may verify whether there are updates at the web interface 
+http://git.openslx.org/slx-admin.git. If you want to check out an actualized 
+git version use git://git.openslx.org/openslx-ng/slx-admin.git (or 
+git@git.openslx.org:openslx-ng/slx-admin.git, if your key is known to the 
+server).
+
+
+