X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2FINSTALL.fcgi;h=186ca33cb96f30f3a2840910cb8609f44c83b31f;hb=f99071832443000a5c927f30f8c6a0610d1309c8;hp=1eb4a1265dfe1751dd9d7266ca6c1e7edcc9f94e;hpb=37a9bb2faf1da037b768deb3206f26019fab8555;p=kivitendo-erp.git diff --git a/doc/INSTALL.fcgi b/doc/INSTALL.fcgi index 1eb4a1265..186ca33cb 100644 --- a/doc/INSTALL.fcgi +++ b/doc/INSTALL.fcgi @@ -5,13 +5,15 @@ Diese Datei ist in Plain Old Documentation geschrieben. Mit ist sie deutlich leichter zu lesen. -=head1 FastCGI für Lx-Office +=encoding utf8 + +=head1 FastCGI für Lx-Office =head2 Was ist FastCGI? Direkt aus L kopiert: - FastCGI ist ein Standard für die Einbindung externer Software zur Generierung + 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. @@ -20,44 +22,64 @@ Direkt aus L kopiert: =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 +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. +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. +eigentliche Programmlogik ausgeführt. =head2 Kombinationen aus Webservern und Plugin. Folgende Kombinationen sind getestet: + * Apache 2.2.11 (Ubuntu) und mod_fcgid. * Apache 2.2.11 (Ubuntu) und mod_fastcgi. -Folgende Kombinationen funktionieren nicht: - - * Apache 2.2.11 (Ubuntu) + mod_fcgid: +Als Perl Backend wird das Modul FCGI.pm verwendet. Vorsicht: FCGI 0.69 und +höher ist extrem strict in der Behandlung von Unicode, und verweigert bestimmte +Eingaben von Lx-Office. Solange diese Probleme nicht behoben sind, muss auf die +Vorgängerversion FCGI 0.68 ausgewichen werden. +Mit cpan lässt sie sich wie folgt installieren: + force install M/MS/MSTROUT/FCGI-0.68.tar.gz =head2 Konfiguration des Webservers. -Variante 1: +Bevor Sie versuchen eine Lx-Office Installation unter FCGI laufen zu lassen, +empfliehlt es sich die Installation ersteinmal unter CGI aufzusetzen. FCGI +macht es nicht einfach Fehler zu debuggen die beim ersten aufsetzen auftreten +können. Sollte die Installation schon funktionieren, lesen Sie weiter. - AddHandler fastcgi-script .pl +Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann unter +Debian/Ubuntu z.B. mit folgendem Befehl geschehen: -Variante 2: + a2enmod fcgid - AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl +bzw. + + a2enmod fastcgi + +Die Konfiguration für die Verwendung von Lx-Office mit FastCGI erfolgt +durch Anpassung der vorhandenen Alias- und Directory-Direktiven. Dabei +wird zwischen dem Installationspfad von Lx-Office im Dateisystem +("/path/to/lx-office-erp") und der URL unterschieden, unter der +Lx-Office im Webbrowser erreichbar ist ("/web/path/to/lx-office-erp"). + +Folgendes Template funktioniert mit mod_fcgid: + + AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi + Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/ AllowOverride All - AddHandler fastcgi-script .fpl Options ExecCGI Includes FollowSymlinks Order Allow,Deny Allow from All @@ -68,44 +90,68 @@ Variante 2: Deny from All +Für mod_fastcgi muss ein AddHandler ergänzt werden und die erste Zeile geändert 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: wurden alle Module mindestens -einmal aufgerufen, so werden dauerhaft ca. 2GB pro Installation -belegt. + AddHandler fastcgi-script .fpl + AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl -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. Trotzdem ist diese Variante vorzuziehen. +Das ganze sollte dann so aussehen: + AddHandler fastcgi-script .fpl + AliasMatch ^/web/path/to/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl + Alias /web/path/to/lx-office-erp/ /path/to/lx-office-erp/ -=head2 Entwicklungsaspekte + + AllowOverride All + Options ExecCGI Includes FollowSymlinks + Order Allow,Deny + Allow from All + -Die AddHandler Direktive vom Apache ist entgegen der Dokumentation -anscheinend nicht lokal auf das Verzeichnis beschränkt sondern global im -vhost. + + Order Deny,Allow + Deny from All + + +Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle Zugriffe +auf die einzelnen Scripte werden auf diesen umgeleitet. Dadurch, dass +zur Laufzeit öfter mal Scripte neu geladen werden, gibt es hier kleine +Performance-Einbußen. Trotzdem ist diese Variante einer globalen +Benutzung von "AddHandler fastcgi-script .pl" vorzuziehen. -Wenn Änderungen in der Konfiguration von Lx-Office gemacht werden, oder wenn -Templates editiert werden muss der Server neu gestartet werden. -Es ist möglich die gleiche Lx-Office Version parallel unter cgi und fastcgi zu -betreiben. Da nimmt man Variante 2 wie oben beschrieben, und ändert die -AliasMatch Zeile auf eine andere URL, und lässt alle anderen URLs auch -weiterleiten: +Es ist möglich die gleiche Lx-Office Version parallel unter cgi und fastcgi zu +betreiben. Dafür bleiben die Directorydirektiven wie oben beschrieben, die URLs +werden aber umgeleitet: - # Zugriff ohne FastCGI - Alias /web/path/to/lx-office-erp /path/to/lx-office-erp + # Zugriff über cgi + Alias /web/path/to/lx-office-erp /path/to/lx-office-erp - # Zugriff mit FastCGI: - AliasMatch ^/web/path/to/lx-office-erp-fcgi/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl - Alias /web/path/to/lx-office-erp-fcgi/ /path/to/lx-office-erp/ + # Zugriff mit mod_fastcgi: + AliasMatch ^/web/path/to/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi + Alias /web/path/to/lx-office-erp-fcgid/ /path/to/lx-office-erp/ + + # Zugriff mit mod_fastcgi: + AliasMatch ^/web/path/to/lx-office-erp-fastcgi/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl + Alias /web/path/to/lx-office-erp-fastcgi/ /path/to/lx-office-erp/ Dann ist unter C die normale Version erreichbar, -und unter C die FastCGI Version. +und unter C bzw. +C die FastCGI Version. + +Achtung: -Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu achten. Dadurch -dass das Programm in einer Endlosschleife läuft, müssen folgende Aspekte +Die AddHandler Direktive vom Apache ist entgegen der Dokumentation +anscheinend nicht lokal auf das Verzeichnis beschränkt sondern global im +vhost. + +=head2 Entwicklungsaspekte + +Wenn Änderungen in der Konfiguration von Lx-Office gemacht werden, muss der +Server neu gestartet werden. + +Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu achten. Dadurch +dass das Programm in einer Endlosschleife läuft, müssen folgende Aspekte geachtet werden: =head3 Programmende und Ausnahmen: C, C, C, C, C @@ -116,18 +162,23 @@ kann mit C, C oder C Fehler ausgeben, die dann vom Dispatche angezeigt werden. Die Lx-Office eigene C<$::form->error()> tut im Prinzip das Gleiche, mit ein paar Extraoptionen. C und C hingegen werden nicht abgefangen. C wird direkt nach STDERR, also in Server Log eine Nachricht -schreiben, und C wird die Ausführung beenden. +schreiben (sofern in der Konfiguration nicht die Warnungen in das Lx-Office Log +umgeleitet wurden), und C wird die Ausführung beenden. Prinzipiell ist es kein Beinbruch, wenn sich der Prozess beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die Ausnahme sein. Quintessenz: Bitte -kein C oder C benutzen, alle anderen Exceptionmechanismen sind ok. +kein C benutzen, alle anderen Exceptionmechanismen sind ok. =head3 Globale Variablen Um zu vermeiden, dass Informationen von einem Request in einen anderen gelangen, -müssen alle globalen Variablen vor einem Request sauber initialisiert werden. +müssen alle globalen Variablen vor einem Request sauber initialisiert werden. Das ist besonders wichtig im C<$::cgi> und C<$::auth> Objekt, weil diese nicht -gelöscht werden pro Instanz, sondern persistent gehalten werden. +gelöscht werden pro Instanz, sondern persistent gehalten werden. + +In C gibt es einen sauber abgetrennten Block der alle +kanonischen globalen Variablen listet und erklärt. Bitte keine anderen +einführen ohne das sauber zu dokumentieren. Datenbankverbindungen wird noch ein Guide verfasst werden, wie man sichergeht, dass man die richtige erwischt. @@ -136,27 +187,20 @@ dass man die richtige erwischt. 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 +Lx-Office 2.4.3 stable dauert auf einem Core2duo mit 4GB 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 +Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in den kritischen Pfaden, unter 0,15 sonst. =head2 Bekannte Probleme -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. - -Die bin/mozilla und SL/ Scripte haben teilweise noch globale Variablen mit our -definiert, oder haben noch startup code der bei einbinden ausgeführt wird. -Beides muss überprüft werden. - -Verkauf -> Rechnungen -> Weiter -> Neu erfassen Rechnung gibt einen Zugriffsfehler +=head3 Encoding Awareness -Template Editor funktioniert nicht +UTF-8 kodierte Installationen sind sehr anfällig gegen fehlerhfate Encodings +unter FCGI. latin9 Installationen behandeln falsch kodierte Zeichen eher +unwissend, und geben sie einfach weiter. UTF-8 verweigert bei fehlerhaften +Programmpfaden kurzerhand aus ausliefern. Es wird noch daran gearbeitet alles +Fehler da zu beseitigen.