Dokumentation

Conflicts:

	doc/INSTALL.fcgi

diff --git a/doc/INSTALL.fcgi b/doc/INSTALL.fcgi
index 6ec640d..b326ffc 100644 (file)
--- a/doc/INSTALL.fcgi
+++ b/doc/INSTALL.fcgi
@@ -1,21 +1,51 @@
 
-1. Was ist FCGI?
+Diese Datei ist in Plain Old Documentation geschrieben. Mit
 
+> perldoc INSTALL.fcgi
 
+ist sie deutlich leichter zu lesen.
 
-2. Kombinationen aus Webservern und Plugin.
+=head1 FastCGI für Lx-Office
+
+=head2 Was ist FastCGI?
+
+Direkt aus L<http://de.wikipedia.org/wiki/FastCGI> kopiert:
+
+  FastCGI ist ein Standard für die Einbindung externer Software zur Generierung
+  dynamischer Webseiten in einem Webserver. FastCGI ist vergleichbar zum Common
+  Gateway Interface (CGI), wurde jedoch entwickelt, um dessen
+  Performance-Probleme zu umgehen.
+
+
+=head2 Warum FastCGI?
+
+Perl Programme (wie Lx-Office eines ist) werden nicht statisch kompiliert.
+Stattdessen werden die Quelldateien bei jedem Start übersetzt, was bei kurzen
+Laufzeiten einen Großteil der Laufzeit ausmacht. Während SQL Ledger einen
+Großteil der Funktionalität in einzelne Module kapselt, um immer nur einen
+kleinen Teil laden zu müssen, ist die Funktionalität von Lx-Office soweit
+gewachsen, dass immer mehr Module auf den Rest des Programms zugreifen.
+Zusätzlich benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
+entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies führt dazu dass
+ein Lx-Office Aufruf der Kernmasken mittlerweile deutlich länger dauert als
+früher, und dass davon 90% für das Laden der Module verwendet wird.
+
+Mit FastCGI werden nun die Module einmal geladen, und danach wird nur die
+eigentliche Programmlogik ausgeführt.
+
+=head2 Kombinationen aus Webservern und Plugin.
 
 Folgende Kombinationen sind getestet:
 
-- Apache 2.2.11 (Ubuntu) und mod_fastcgi.
+ * Apache 2.2.11 (Ubuntu) und mod_fastcgi.
 
 Folgende Kombinationen funktionieren nicht:
 
-- Apacje 2.2.11 (Ubuntu) + mod_fcgid:
+ * Apache 2.2.11 (Ubuntu) + mod_fcgid:
 
 
 
-3. Konfiguration des Webservers.
+=head2 Konfiguration des Webservers.
 
 Variante 1:
 
@@ -23,29 +53,58 @@ Variante 1:
 
 Variante 2:
 
-AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
+  AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
+
+  <Directory /path/to/lx-office-erp>
+    AllowOverride All
+    AddHandler fastcgi-script .fpl
+    Options ExecCGI Includes FollowSymlinks
+    Order Allow,Deny
+    Allow from All
+  </Directory>
+
+  <DirectoryMatch //.*/users>
+    Order Deny,Allow
+    Deny from All
+  </DirectoryMatch>
+
+
+Variante 1 startet einfach jeden Lx-Office Request als fcgi Prozess. Für sehr
+große Installationen ist das die schnellste Version, benötigt aber sehr viel
+Arbeitspseicher (ca. 2GB).
+
+Variante 2 startet nur einen zentralen Dispatcher und lenkt alle Scripte auf
+diesen. Dadurch dass zur Laufzeit öfter mal Scripte neu geladen werden gibt es
+hier kleine Performance Einbußen.
+
 
-<Directory /path/to/lx-office-erp>
-  AllowOverride All
-  AddHandler fastcgi-script .fpl
-  Options ExecCGI Includes FollowSymlinks
-  Order Allow,Deny
-  Allow from All
-</Directory>
+=head2 Mögliche Fallstricke
 
-<DirectoryMatch //.*/users>
-  Order Deny,Allow
-  Deny from All
-</DirectoryMatch>
+Die AddHandler Direktive vom Apache ist entgegen der Dokumentation
+anscheinend nicht lokal auf das Verzeichnis beschränkt sondern global im
+vhost.
 
+Wenn Änderungen in der Konfiguration von Lx-Office gemacht werden, oder wenn
+Templates editiert werden muss der Server neu gestartet werden.
 
 
 
-Variante 1 startet einfach jeden Lx-Office Request als fcgi Prozess. Für sehr große Installationen ist das die schnellste Version, benötigt aber sehr viel Arbeitspseicher (ca. 2GB).
+=head2 Performance und Statistiken
 
-Variante 2 startet nur einen zentralen Dispatcher und lenkt alle Scripte auf diesen. Dadurch dass zur Laufzeit öfter mal Scripte neu geladen werden gibt es hier kleine Performance Einbußen.
+Die kritischen Pfade des Programms sind die Belegmasken, und unter diesen ganz
+besonders die Verkaufsrechnungsmaske. Ein Aufruf der Rechnungsmaske in
+Lx-Office 2.4.3 stable dauert auf einem Core2duo mit 2GB Arbeitsspeicher und
+Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0 sind es je nach Menge der
+definierten Variablen 1-2s. Ab der Moose/Rose::DB Version sind es 5-6s.
 
+Mit FastCGI ist die neuste Version auf 0,4 Sekunden selbst in den kritischen
+Pfaden, unter 0,15 sonst.
 
+=head2 Bekannte Probleme
 
-4. TODO
+Bei mehreren Benutzern scheint ab und zu eine Datenbankverbidung von Rose::DB
+in den falschen Benutzer zu geraten. Das ist ein kritischer Bug und muss gefixt
+werden.
 
+Bei Administrativen Tätigkeiten werden in seltenen Fällen die Locales nicht
+richtig geladen und die Maske erscheint in Englisch.