added INSTALL (german installation manual) and started with crypt()ing

[aymargeddon/current.git] / INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..3df2e3c
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,56 @@
+Hier wird der Installationsvorgang eines Aymargeddon-Spiels beschrieben. Das ist leider alles noch sehr hakelig, wir entschuldigen uns für die Strapazen.
+
+
+Vorraussetzungen
+================
+
+Ihr benötigt:
+
+*    Einen Rechner mit Linux als Betriebssystem (möglicherweise läuft es auch auf anderen Systemen, aber das hat bisher noch niemand probiert)
+*    den Sourcecode (zu beziehen über "git clone http://aymargeddon.de/aymargeddon.git")
+*    einen Apache2-Webserver
+*    Embedded Perl auf diesem Server. Unter Debian squeeze tut es ein: 
+
+apt-get install libembperl-perl
+
+*    folgende Perl-Module müssen vorhanden sein: 
+
+     Date::Calc;
+     Mail::Mailer;
+     Data::Dumper;
+
+*    MySQL als DBMS 
+
+Wenn das alles läuft, könnt ihr loslegen.
+
+Eigentliche Installation
+========================
+
+*    Ihr müsst den Apache so konfigurieren, dass das Verzeichnis html/ aus dem Source zugänglich ist von außen und dort epl-Dateien ausgeführt werden können und das Embperl im src-Verzeichnis Module nachladen kann; zB via "PerlPostConfigRequire /etc/apache/startup.pl" und da dann so was in der Art: 
+     
+     use lib qw( /var/www/benni/aymargeddon.de/game/src );
+     1;
+
+*    Ihr müsst die Datei src/FROGS/Config.pm an eure Gegebenheiten anpassen. Dabei erstmal nur den oberen Abschnitt anfassen.
+
+*    Ihr müsst eine Datenbank RAGNAROEK in MySQL anlegen.
+
+*    Ihr müsst einen DB-user "aymargeddon" in MySQL anlegen, der alle Rechte auf dieser DB hat (oder alternativ den Benutzernamen zusätzlich zu Config.pm in ein paar nicht-Perl-scripten ändern)
+
+*    Ihr müsst eine lesegeschützte Datei an dem Ort anlegen, der in der Config beschrieben ist. In dieser Datei liegt das      Datenbankpasswort. 
+
+*    Ihr müsst im Verzeichnis var/ den Befehl ./do_sql < RAGNAROEK.sql sowie ./do_sql < LOCALIZE.sql eingeben. (oder evntl.: ./init_server)
+
+*    Ihr müsst im Verzeichnis src/ den Befehl create.pl <spielfeldgröße> ausführen. Dort dann den Namen des Spiels sowie die Spielgeschwindigkeit eingeben.
+
+*    Ihr müsst im Verzeichnis src/FROGS/ den Befehl ./start_scheduler ausführen. 
+
+Jetzt kanns losgehen.
+
+
+Maintainance
+============
+
+*    Das start_scheduler-script schreibt die logs in die Datei src/FROGS/++out. In der Standardkonfiguration wird noch eine Datei src/FROGS/+out mit sehr detailierten logs erzeugt. 
+
+*    Mit dem Script backup in var kann man Backups der Datenbank dumpen.