X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentation.xml;h=25b52d39ecf6d037c0c2e32362857409cc6b3be6;hb=d00e1b28dc8b03abfebf5c7be9305f01dc968ebc;hp=c98c4e7ed1b9fdced53c3918af6315e485dcdf24;hpb=3adb0cb772af4bcdbd867b5688b3e02356a2e613;p=kivitendo-erp.git diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index c98c4e7ed..25b52d39e 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -1,8 +1,8 @@ - - Lx-Office: Installation, Konfiguration, Entwicklung + + kivitendo: Installation, Konfiguration, Entwicklung Aktuelle Hinweise @@ -11,18 +11,13 @@ - auf der Lx-Office-Homepage unter http://lx-office.org/index.php?id=dokumentation + im kivitendo-Forum: https://forum.kivitendo.org/ - im Lx-Office-Wiki unter Dokumentation (http://wiki.lx-office.org/index.php/Lx-Office_ERP) - - - - im Lx-Office-Forum: http://www.lx-office.org/forum/ + im alten Lx-Office-Wiki unter Dokumentation (http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP) @@ -36,20 +31,19 @@ Betriebssystem - Lx-Office ist für Linux konzipiert, und sollte auf jedem + kivitendo ist für Linux konzipiert, und sollte auf jedem unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es ohne große Probleme auf den derzeit aktuellen verbreiteten Distributionen läuft. - Anfang 2012 sind das folgende Systeme, von denen bekannt ist, - dass Lx-Office auf ihnen läuft: + Mitte 2012 sind das folgende Systeme, von denen bekannt ist, + dass kivitendo auf ihnen läuft: - Ubuntu 8.04 LTS Hardy Heron, 10.04 LTS Lucid Lynx bis 11.10 - Oneiric Ocelot + Ubuntu 10.04 LTS Lucid Lynx bis 12.04 Precise Pangolin @@ -65,46 +59,19 @@ - Fedora 13 bis 15 + Fedora 13 bis 16 - - Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die - Module im Archiv recht alt sind, und das viele der benötigten Module - nicht einfach zu installieren sind. Dafür sollte es kurz nach dem - Release ein eigenes .deb geben. - - Alternativ dazu kann die normale Installation durchgeführt - werden (siehe ), wenn vorher - ein Kompatibilitätspaket installiert wird, das die fehlenden Pakete - bereitstellt. Das Paket ist auf Sourceforge - unter dem Namen lx-erp-perl-libs-compat-v2.tar.gz - hinterlegt. - - Zur Installation das Paket in das entpackte Lx-Office - Verzeichnis entpacken: - - tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/ - - Zusätzlich müssen dann noch die folgenden Pakete installiert - weerden - - apt-get install libbit-vector-perl libsub-exporter-perl libclone-perl libclass-factory-util-perl - - Danach sollte der Installationscheck (siehe ) die enthaltenen Pakete erkennen. Pakete - Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist + Zum Betrieb von kivitendo werden zwingend ein Webserver (meist Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2) benötigt. - Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die + Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind: @@ -191,7 +158,7 @@ Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete hinzugekommen, URI und - XML::Writer sind notwendig. Ohne startet Lx-Office + XML::Writer sind notwendig. Ohne startet kivitendo nicht. Gegenüber Version 2.6.1 sind parent, @@ -204,7 +171,7 @@ Email::Address und List::MoreUtils sind schon länger feste - Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide + Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer zukünftigen Version aber aus dem Paket entfernt werden. Es wird empfohlen diese Module zusammen mit den anderen als Bibliotheken zu @@ -221,7 +188,7 @@ librose-object-perl librose-db-perl librose-db-object-perl \ libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \ libxml-writer-perl libyaml-perl libconfig-std-perl \ - libparams-validate-perl libjson-perl + libparams-validate-perl libjson-perl libclass-accessor-perl Für Fedora Core benötigen Sie diese Pakete: @@ -243,7 +210,7 @@ Rose::* Pakete sind derzeit nicht für SuSE gepackt, und müssen anderweitig nachinstalliert werden. - Lx-Office enthält ein Script, mit dem überprüft werden kann, ob + kivitendo enthält ein Script, mit dem überprüft werden kann, ob alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie folgt: @@ -255,70 +222,71 @@ xreflabel="Manuelle Installation des Programmpaketes"> Manuelle Installation des Programmpaketes - Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.3.tgz) wird + Die kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird im Dokumentenverzeichnis des Webservers (z.B. /var/www/html/, /srv/www/htdocs oder /var/www/) entpackt: - cd /var/www tar xvzf -lxoffice-erp-2.6.2.tgz + cd /var/www +tar xvzf kivitendo-erp-2.6.3.tgz - Verändern Sie evtl. noch den Namen des Verzeichnisses mit + Wechseln Sie in das entpackte Verzeichnis: - mv lxoffice-erp/ lx-erp/ + cd kivitendo-erp Alternativ können Sie auch einen Alias in der Webserverkonfiguration benutzen, um auf das tatsächliche Installationsverzeichnis zu verweisen. - Die Verzeichnisse users, - spool und webdav müssen für - den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die - restlichen Dateien müssen für diesen Benutzer lesbar sein. Der - Benutzername ist bei verschiedenen Distributionen unterschiedlich (z.B. - bei Debian/Ubuntu www-data, bei Fedora core - apache oder bei OpenSuSE - wwwrun). + Die Verzeichnisse users, spool und webdav müssen für den Benutzer + beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und + Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu www-data, bei Fedora + core apache oder bei OpenSuSE wwwrun). Der folgende Befehl ändert den Besitzer für die oben genannten Verzeichnisse auf einem Debian/Ubuntu-System: - chown -R www-data lx-office-erp/users lx-office-erp/spool lx-office-erp/webdav + chown -R www-data users spool webdav - Weiterhin muss der Webserver-Benutzer im Verzeichnis - templates Verzeichnisse für jeden neuen Benutzer, - der in lx-office angelegt wird, anlegen dürfen: + Weiterhin muss der Webserver-Benutzer in den Verzeichnissen templates und users + Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird: - chgrp www-data lx-office-erp/templates -chmod g+w lx-office-erp/templates + chown www-data templates users - Lx-Office-Konfigurationsdatei + kivitendo-Konfigurationsdatei Einführung - Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei - die benötigt wird: config/lx_office.conf (kurz: + In kivitendo gibt es nur noch eine Konfigurationsdatei, + die benötigt wird: config/kivitendo.conf (kurz: "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation - von Lx-Office bzw. der Migration von älteren Versionen angelegt + von kivitendo bzw. der Migration von älteren Versionen angelegt werden. Als Vorlage dient die Datei - config/lx_office.conf.default (kurz: "die + config/kivitendo.conf.default (kurz: "die Default-Datei"): - $ cp config/lx_office.conf.default config/lx_office.conf + $ cp config/kivitendo.conf.default config/kivitendo.conf Die Default-Datei wird immer zuerst eingelesen. Werte, die in der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der Default-Datei. Die Hauptkonfigurationsdatei muss also nur die - Abschintte und Werte enthalten, die von denen der Default-Datei + Abschnitte und Werte enthalten, die von denen der Default-Datei abweichen. + + + Vor der Umbenennung in kivitendo hieß diese Datei noch config/lx_office.conf. Aus Gründen der Kompatibilität + wird diese Datei eingelesen, sofern die Datei config/kivitendo.conf nicht existiert. + + + Diese Hauptkonfigurationsdatei ist dann eine installationsspezifische Datei, d.h. sie enthält bspw. lokale Passwörter und wird auch nicht im Versionsmanagement (git) @@ -397,12 +365,11 @@ admin_password = geheim [authentication/database] host = localhost port = 5432 -db = lxerp_auth +db = kivitendo_auth user = postgres password = [system] -eur = 1 dbcharset = UTF-8 Nutzt man wiederkehrende Rechnungen, kann man unter @@ -414,7 +381,7 @@ dbcharset = UTF-8 linkend="config.task-server">Taskserver für wiederkehrende Rechnungen, muss unter [task_server] ein Login eines Benutzers - angegeben werden, mit dem sich der Taskserver an Lx-Office bei der + angegeben werden, mit dem sich der Taskserver an kivitendo bei der Datenbank anmeldet, die dem Benutzer zugewiesen ist. Für Entwickler finden sich unter [debug] @@ -424,7 +391,7 @@ dbcharset = UTF-8 Versionen vor 2.6.3 - In älteren Lx-Office Versionen gab es im Verzeichnis + In älteren kivitendo Versionen gab es im Verzeichnis config die Dateien authentication.pl und lx-erp.conf, die jeweils Perl-Dateien waren. Es @@ -432,10 +399,10 @@ dbcharset = UTF-8 zu erstellen (lx-erp-local.conf). Dies ist ab 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig. - Beim Update von einer Lx-Office-Version vor 2.6.3 auf 2.6.3 oder + Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder jünger müssen die Einstellungen aus den alten Konfigurationsdateien manuell übertragen und die alten Konfigurationsdateien anschließend - gelöscht oder verschoben werden. Ansonsten zeigt Lx-Office eine + gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine entsprechende Fehlermeldung an. @@ -448,14 +415,17 @@ dbcharset = UTF-8 Zeichensätze/die Verwendung von UTF-8 - Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet - werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in - Version 8.2 oder neuer benutzt werden, und der - PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale - angelegt worden sein. + Bei aktuellen Serverinstallationen braucht man hier meist nicht + eingreifen + + Dieses kann überprüft werden: ist das Encoding der Datenbank + “template1” “UTF8”, so braucht man nichts weiteres diesbezueglich + unternehmen. Zum Testen: + + su postgres +echo '\l' | psql +exit - Dieses ist kann überprüft werden: ist das Encoding der Datenbank - “template1” “UTF8”, so kann auch Lx-Office mit UTF-8 betrieben werden. Andernfalls ist es notwendig, einen neuen Datenbankcluster mit UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl @@ -470,7 +440,7 @@ dbcharset = UTF-8 Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann - Lx-Office mit ISO-8859-15 als Encoding betrieben werden. + kivitendo mit ISO-8859-15 als Encoding betrieben werden. Das Encoding einer Datenbank kann in psql mit \l geprüft werden. @@ -485,7 +455,7 @@ dbcharset = UTF-8 /etc/postgresql/, muss sichergestellt werden, dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den Parameter listen_address gesteuert. Laufen - PostgreSQL und Lx-Office auf demselben Rechner, so kann dort der Wert + PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert localhost verwendet werden. Andernfalls müssen Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden, was mit dem Wert * geschieht. @@ -493,17 +463,12 @@ dbcharset = UTF-8 In der Datei pg_hba.conf, die im gleichen Verzeichnis wie die postgresql.conf zu finden sein sollte, müssen die Berichtigungen für den Zugriff geändert - werden. Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale - Verbindungen immer zuzulassen: - - local all all trust -host all all 127.0.0.1 255.0.0.0 trust - - Besser ist es, für eine bestimmte Datenbank Zugriff nur per - Passwort zuzulassen. Beispielsweise: + werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die + nögiten Verbindungen immer zuzulassen, für eine lokal laufenden + Datenbank zum Beispiel: - local all lxoffice password -host all lxoffice 127.0.0.1 255.255.255.255 password + local all kivitendo password +host all kivitendo 127.0.0.1 255.255.255.255 password @@ -511,10 +476,14 @@ host all lxoffice 127.0.0.1 255.255.255.255 password In der Datenbank template1 muss die Unterstützung für servergespeicherte Prozeduren eingerichet werden. - Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an, und + Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an: + su - postgres +psql template1 + führen Sie die folgenden Kommandos aus: - create language 'plpgsql'; + create language 'plpgsql'; +\q @@ -525,10 +494,12 @@ host all lxoffice 127.0.0.1 255.255.255.255 password anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen können: - su - postgres createuser -d -P lxoffice + su - postgres +createuser -d -P kivitendo +exit Wenn Sie später einen Datenbankzugriff konfigurieren, verändern - Sie den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” bzw. + Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw. den hier gewählten Benutzernamen. @@ -552,20 +523,19 @@ host all lxoffice 127.0.0.1 255.255.255.255 password wird: AddHandler cgi-script .pl -Alias /lx-erp/ /var/www/lx-erp/ +Alias /kivitendo-erp/ /var/www/kiviteno-erp/ -<Directory /var/www/lx-erp> - Options ExecCGI - Includes FollowSymlinks +<Directory /var/www/kivitendo-erp> + Options ExecCGI Includes FollowSymlinks </Directory> -<Directory /var/www/lx-erp/users> +<Directory /var/www/kivitendo-erp/users> Order Deny,Allow Deny from All </Directory> Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher - das Lx-Office-Archiv entpacket haben. + das kivitendo-Archiv entpacket haben. Vor den einzelnen Optionen muss bei einigen Distributionen ein @@ -600,16 +570,16 @@ Alias /lx-erp/ /var/www/lx-erp/ Warum FastCGI? - Perl Programme (wie Lx-Office eines ist) werden nicht statisch + Perl Programme (wie kivitendo 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 + müssen, ist die Funktionalität von kivitendo 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 + führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile deutlich länger dauert als früher, und dass davon 90% für das Laden der Module verwendet wird. @@ -641,7 +611,7 @@ Alias /lx-erp/ /var/www/lx-erp/ FCGI 0.69 und höher ist extrem strict in der Behandlung von - Unicode, und verweigert bestimmte Eingaben von Lx-Office. Falls es + Unicode, und verweigert bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss auf die Vorgängerversion FCGI 0.68 ausgewichen werden. @@ -655,7 +625,7 @@ Alias /lx-erp/ /var/www/lx-erp/ Konfiguration des Webservers - Bevor Sie versuchen, eine Lx-Office Installation unter FCGI + Bevor Sie versuchen, eine kivitendo 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 @@ -666,28 +636,28 @@ Alias /lx-erp/ /var/www/lx-erp/ a2enmod fcgid - Die Konfiguration für die Verwendung von Lx-Office mit FastCGI + Die Konfiguration für die Verwendung von kivitendo 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 - ("/url/for/lx-office-erp"). + dem Installationspfad von kivitendo im Dateisystem + ("/path/to/kivitendo-erp") und der URL + unterschieden, unter der kivitendo im Webbrowser erreichbar ist + ("/url/for/kivitendo-erp"). Folgender Konfigurationsschnipsel funktioniert mit mod_fastcgi: - AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi -Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/ + AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi +Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/ -<Directory /path/to/lx-office-erp> +<Directory /path/to/kivitendo-erp> AllowOverride All Options ExecCGI Includes FollowSymlinks Order Allow,Deny Allow from All </Directory> -<DirectoryMatch /path/to/lx-office-erp/users> +<DirectoryMatch /path/to/kivitendo-erp/users> Order Deny,Allow Deny from All </DirectoryMatch> @@ -701,18 +671,18 @@ Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/ Das ganze sollte dann so aussehen: AddHandler fcgid-script .fpl -AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl -Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/ +AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl +Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/ FcgidMaxRequestLen 10485760 -<Directory /path/to/lx-office-erp> +<Directory /path/to/kivitendo-erp> AllowOverride All Options ExecCGI Includes FollowSymlinks Order Allow,Deny Allow from All </Directory> -<DirectoryMatch /path/to/lx-office-erp/users> +<DirectoryMatch /path/to/kivitendo-erp/users> Order Deny,Allow Deny from All </DirectoryMatch> @@ -722,20 +692,20 @@ FcgidMaxRequestLen 10485760 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden, gibt es hier kleine Performance-Einbußen. - Es ist möglich, die gleiche Lx-Office Version parallel unter + Es ist möglich, die gleiche kivitendo Version parallel unter CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven wie oben beschrieben, die URLs werden aber umgeleitet: # Zugriff über CGI -Alias /url/for/lx-office-erp /path/to/lx-office-erp +Alias /url/for/kivitendo-erp /path/to/kivitendo-erp # Zugriff mit mod_fcgid: -AliasMatch ^/url/for/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl -Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/ +AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl +Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ - Dann ist unter /url/for/lx-office-erp/ + Dann ist unter /url/for/kivitendo-erp/ die normale Version erreichbar, und unter - /url/for/lx-office-erp-fcgid/ die + /url/for/kivitendo-erp-fcgid/ die FastCGI-Version. @@ -756,7 +726,7 @@ Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/Die Konfiguration erfolgt über den Abschnitt [task_server] in der Datei - config/lx_office.conf. Die dort verfügbaren + config/kivitendo.conf. Die dort verfügbaren Optionen sind: @@ -764,7 +734,7 @@ Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/login - gültiger Lx-Office-Benutzername, der benutzt wird, um die + gültiger kivitendo-Benutzername, der benutzt wird, um die zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden. @@ -801,7 +771,7 @@ Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/Der Task-Server verhält sich von seinen Optionen her wie ein reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim - Starten automatisch in das Lx-Office-Installationsverzeichnis. + Starten automatisch in das kivitendo-Installationsverzeichnis. Deshalb ist es möglich, ihn durch Setzen eines symbolischen Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess @@ -814,8 +784,8 @@ Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/ Kopieren Sie die Datei - scripts/boot/system-v/lx-office-task-server - nach /etc/init.d/lx-office-task-server. Passen + scripts/boot/system-v/kivitendo-server + nach /etc/init.d/kivitendo-server. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile DAEMON=....). Binden Sie das Script in den Boot-Prozess ein. Dies ist distributionsabhängig: @@ -824,20 +794,20 @@ Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/ Debian-basierende Systeme: - update-rc.d lx-office-task-server defaults + update-rc.d kivitendo-task-server defaults # Nur bei Debian Squeeze und neuer: -insserv lx-office-task-server +insserv kivitendo-task-server OpenSuSE und Fedora Core: - chkconfig --add lx-office-task-server + chkconfig --add kivitendo-task-server Danach kann der Task-Server mit dem folgenden Befehl gestartet - werden: /etc/init.d/lx-office-task-server + werden: /etc/init.d/kivitendo-task-server start @@ -845,13 +815,13 @@ insserv lx-office-task-server Upstart-basierende Systeme (z.B. Ubuntu) Kopieren Sie die Datei - scripts/boot/upstart/lx-office-task-server.conf - nach /etc/init/lx-office-task-server.conf. + scripts/boot/upstart/kivitendo-task-server.conf + nach /etc/init/kivitendo-task-server.conf. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile exec ....). Danach kann der Task-Server mit dem folgenden Befehl gestartet - werden: service lx-office-task-server + werden: service kivitendo-task-server start @@ -890,11 +860,27 @@ insserv lx-office-task-server Der Task-Server wechselt beim Starten automatisch in das - Lx-Office-Installationsverzeichnis. + kivitendo-Installationsverzeichnis. Dieselben Optionen können auch für die SystemV-basierenden Runlevel-Scripte benutzt werden (siehe oben). + + Task-Server mit mehreren Mandanten + + Beim Task-Server wird der Login-Name des Benutzers, unter dem der + Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat + man mehrere Mandanten muß man auch mehrere Konfigurationsdateien + anlegen. + + Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, + wo in der Kategorie [task_server] der gewünschte "login" steht. + + Der alternative Task-Server wird dann mit folgendem Befehl + gestartet: + + ./scripts/task_server.pl -c config/DATEINAME.conf + @@ -906,27 +892,27 @@ insserv lx-office-task-server Grundlagen zur Benutzerauthentifizierung - Lx-Office verwaltet die Benutzerinformationen in einer + kivitendo verwaltet die Benutzerinformationen in einer Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt wird. Für jeden Benutzer kann dort eine eigene Datenbank für die eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken können, müssen aber nicht unterschiedlich sein. - Im einfachsten Fall gibt es für Lx-Office nur eine einzige + Im einfachsten Fall gibt es für kivitendo nur eine einzige Datenbank, in der sowohl die Benutzerinformationen als auch die Daten abgelegt werden. - Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter + Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter entweder gegen die Authentifizierungsdatenbank oder gegen einen LDAP-Server überprüft werden. - Welche Art der Passwortüberprüfung Lx-Office benutzt und wie - Lx-Office die Authentifizierungsdatenbank erreichen kann, wird in der - Konfigurationsdatei config/lx_office.conf + Welche Art der Passwortüberprüfung kivitendo benutzt und wie + kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der + Konfigurationsdatei config/kivitendo.conf festgelegt. Diese muss bei der Installation und bei einem Upgrade von einer Version vor v2.6.0 angelegt werden. Eine Beispielkonfigurationsdatei - config/lx_office.conf.default existiert, die als + config/kivitendo.conf.default existiert, die als Vorlage benutzt werden kann. @@ -977,7 +963,7 @@ insserv lx-office-task-server user - Der Benutzername, mit dem sich Lx-Office beim + Der Benutzername, mit dem sich kivitendo beim Datenbankserver anmeldet (z.B. "postgres") @@ -992,14 +978,14 @@ insserv lx-office-task-server - Die Datenbank muss noch nicht existieren. Lx-Office kann sie + Die Datenbank muss noch nicht existieren. kivitendo kann sie automatisch anlegen (mehr dazu siehe unten). Passwortüberprüfung - Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen + kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen die Authentifizierungsdatenbank und gegen einen externen LDAP- oder Active-Directory-Server. Welche davon benutzt wird, regelt der Parameter module im Abschnitt @@ -1009,7 +995,7 @@ insserv lx-office-task-server gespeichert werden, so muss der Parameter module den Wert DB enthalten. In diesem Fall können sowohl der Administrator als auch die Benutzer selber ihre Psaswörter in - Lx-Office ändern. + kivitendo ändern. Soll hingegen ein externer LDAP- oder Active-Directory-Server benutzt werden, so muss der Parameter module auf @@ -1101,7 +1087,7 @@ insserv lx-office-task-server Name des Session-Cookies - Sollen auf einem Server mehrere Lx-Office-Installationen + Sollen auf einem Server mehrere kivitendo-Installationen aufgesetzt werden, so müssen die Namen der Session-Cookies für alle Installationen unterschiedlich sein. Der Name des Cookies wird mit dem Parameter cookie_name im Abschnitt @@ -1115,13 +1101,13 @@ insserv lx-office-task-server Anlegen der Authentifizierungsdatenbank Nachdem alle Einstellungen in - config/lx_office.conf vorgenommen wurden, muss - Lx-Office die Authentifizierungsdatenbank anlegen. Dieses geschieht + config/kivitendo.conf vorgenommen wurden, muss + kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter der folgenden URL erreichbar sein sollte: http://localhost/lx-erp/admin.pl + url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl @@ -1133,17 +1119,17 @@ insserv lx-office-task-server folgender URL finden: http://localhost/lx-erp/admin.pl + url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei - config/lx_office.conf eingetragen haben. + config/kivitendo.conf eingetragen haben. Zusammenhänge - Lx-Office verwendet eine Datenbank zum Speichern all seiner + kivitendo verwendet eine Datenbank zum Speichern all seiner Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um - mit Lx-Office arbeiten zu können, muss eine Person einen + mit kivitendo arbeiten zu können, muss eine Person einen Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist möglich und normal, dass mehreren Benutzern die selbe Datenbank @@ -1154,17 +1140,17 @@ insserv lx-office-task-server eingegeben werden können, werden in einer zweiten Datenbank gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet. - Pro Lx-Office-Installation gibt es nur eine + Pro kivitendo-Installation gibt es nur eine Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit Firmendaten. - Lx-Office kann seinen Benutzern Zugriff auf bestimmte + kivitendo kann seinen Benutzern Zugriff auf bestimmte Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht gestattet, so werden der entsprechenden Menüpunkte auch nicht angezeigt. Diese Rechte werden ebenfalls in der Authentifizierungsdatenbank gespeichert. - Um Rechte verteilen zu können, verwendet Lx-Office ein + Um Rechte verteilen zu können, verwendet kivitendo ein Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen @@ -1198,19 +1184,14 @@ insserv lx-office-task-server Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für den Datenbankzugriff den vorhin angelegten Benutzer (in unseren - Beispielen ist dies ‘lxoffice’). + Beispielen ist dies ‘kivitendo’). - Wenn Sie für die Lx-Office-Installation nicht den europäischen - Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so - müssen Sie vor dem Anlegen der Datenbank in der Datei - config/lx_office.conf die Variable - dbcharset im Abschnitt system - auf den Wert ‘UTF-8’ setzen. Zusätzlich muss beim - Anlegen der Datenbank ‘UTF-8 Unicode’ als - Schriftsatz ausgewählt werden. + Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen + wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei config/kivitendo.conf die Variable + dbcharset im Abschnitt system auf den Wert ‘ISO-8859-15’ setzen. Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz - verwenden müssen, da diese Einstellungen momentan global in Lx-Office + verwenden müssen, da diese Einstellungen momentan global in kivitendo vorgenommen wird und nicht nach Datenbank unterschieden werden kann. Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz angelegt worden sein. @@ -1272,31 +1253,31 @@ insserv lx-office-task-server Migration alter Installationen - Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird, + Wenn kivitendo 2.6.3 über eine ältere Version installiert wird, in der die Benutzerdaten noch im Dateisystem im Verzeichnis - users verwaltet wurden, so bietet Lx-Office die + users verwaltet wurden, so bietet kivitendo die Möglichkeit, diese Benutzerdaten automatisch in die Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man sich nach dem Update der Installation das erste Mal im - Administrationsbereich anmeldet. Findet Lx-Office die Datei + Administrationsbereich anmeldet. Findet kivitendo die Datei users/members, so wird der Migrationsprozess gestartet. Der Migrationsprozess ist nahezu vollautomatisch. Alle Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet - Lx-Office noch die Möglichkeit an, dass automatisch eine + kivitendo noch die Möglichkeit an, dass automatisch eine Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle - Funktionen von Lx-Office gewährt. Alle migrierten Benutzern werden - Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis + Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden + Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können sich sofort wieder anmelden und mit dem System arbeiten. - - Drucken mit Lx-Office + + Drucken mit kivitendo - Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen. + Das Drucksystem von kivitendo benutzt von Haus aus LaTeX Vorlagen. Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am einfachsten ist dazu eine texlive Installation. Unter Debianoiden Betriebssystemen sind das die Pakete: @@ -1344,18 +1325,18 @@ insserv lx-office-task-server OpenDocument-Vorlagen - Lx-Office unterstützt die Verwendung von Vorlagen im + kivitendo unterstützt die Verwendung von Vorlagen im OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt. - Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus + kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von OpenDocument-Vorlagen zu aktivieren muss in der Datei - config/lx_office.conf die Variable + config/kivitendo.conf die Variable opendocument im Abschnitt print_templates auf ‘1’ stehen. Dieses ist die Standardeinstellung. Weiterhin muss in der Datei - config/lx_office.conf die Variable + config/kivitendo.conf die Variable dbcharset im Abschnitt system auf die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen @@ -1369,14 +1350,14 @@ insserv lx-office-task-server Andere Distributionen enthalten ihn in anderen Paketen. Nach der Installation müssen in der Datei - config/lx_config.conf zwei weitere Variablen + config/kivitendo.conf zwei weitere Variablen angepasst werden: openofficeorg_writer muss den vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten. xvfb muss den Pfad zum “X virtual frame buffer” enthalten. Beide stehen im Abschnitt applications. - Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit + Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die Variable $openofficeorg_daemon gesetzt ist, startet ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet @@ -1424,10 +1405,10 @@ insserv lx-office-task-server xreflabel="Einführung in die Konfiguration zur EUR"> Einführung - Lx-Office besaß bis inklusive Version 2.6.3 einen + kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens eur, der sich in der Konfigurationsdatei config/lx_office.conf - befindet. Somit galt er für alle Mandanten, die in dieser Installation + befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden. Mit der nachfolgenden Version wurde der Parameter zum Einen in @@ -1489,7 +1470,7 @@ insserv lx-office-task-server Die Konfiguration "eur" unter [system] in der Konfigurationsdatei - config/lx_office.conf wird nun nicht mehr + config/kivitendo.conf wird nun nicht mehr benötigt und kann entfernt werden. Dies muss manuell geschehen. @@ -1516,7 +1497,7 @@ insserv lx-office-task-server Bemerkungen zu Bestandsmethode Die Bestandsmethode ist eigentlich eine sehr elegante Methode, - funktioniert in Lx-Office aber nur unter bestimmten Bedingungen: + funktioniert in kivitendo aber nur unter bestimmten Bedingungen: Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie @@ -1553,7 +1534,7 @@ insserv lx-office-task-server Die Umsatzsteuerumstellung auf 19% für SKR04 für die Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt. - Lx-Office beinhaltet ein Upgradeskript, das das Konto 3804 automatisch + kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch erstellt und die Steuereinstellungen korrekt einstellt. Hat der Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das @@ -1653,19 +1634,19 @@ insserv lx-office-task-server - - Lx-Office ERP verwenden + + kivitendo ERP verwenden Nach erfolgreicher Installation ist der Loginbildschirm unter folgender URL erreichbar: http://localhost/lx-office-erp/login.pl + url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl Die Administrationsseite erreichen Sie unter: http://localhost/lx-office-erp/admin.pl + url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl @@ -1790,7 +1771,7 @@ insserv lx-office-task-server Informationen zu den erstellten Rechnungen verschickt werden. Konfiguriert wird dies in der Konfigurationsdatei - config/lx_office.conf im Abschnitt + config/kivitendo.conf im Abschnitt [periodic_invoices]. @@ -1841,7 +1822,7 @@ insserv lx-office-task-server linkend="dokumentenvorlagen-und-variablen.tag-style" />). Früher wurde hier nur über LaTeX gesprochen. Inzwischen - unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern es nicht + unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für alle Vorlagenarten. @@ -1949,7 +1930,7 @@ insserv lx-office-task-server % config: tag-style=($ $) - Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen, + Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen, wenn sie wie folgt aussehen: ($customer$). Das äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus: @@ -2232,6 +2213,14 @@ insserv lx-office-task-server dem Kürzel das im Dateinamen verwendetet wird. + + + template_meta.tmpfile + + + Datei-Prefix für temporäre Dateien. + + @@ -4116,7 +4105,7 @@ insserv lx-office-task-server Mittels != anstelle von == würde auf Ungleichheit getestet. - %if var1 == var2%> + <%if var1 == var2%> Testet die Variable var1 auf übereinstimmung mit der Variablen var2. Mittel @@ -4176,9 +4165,9 @@ Beschreibung: <%description%> Markup-Code zur Textformatierung innerhalb von Formularen - Wenn der Benutzer innhalb von Formularen in Lx-Office Text + Wenn der Benutzer innhalb von Formularen in kivitendo Text anders formatiert haben möchte, so ist dies begrenzt möglich. - Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags. + kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags. Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird dann automatisch in Anweisungen für das ausgewählte Vorlagenformat @@ -4668,7 +4657,7 @@ Beschreibung: <%description%> brauchbares Tracing gebaut ist, "log_time", mit der man die Wallclockzeit seit Requeststart loggen kann, sowie "message" und "dump" mit - denen man flott Informationen ins Log (tmp/lx-office-debug.log) + denen man flott Informationen ins Log (tmp/kivitendo-debug.log) packen kann. Beispielsweise so: @@ -4720,7 +4709,7 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ Repräsentation der - config/lx_office.conf[.default]-Dateien + config/kivitendo.conf[.default]-Dateien @@ -4733,7 +4722,7 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ verfügbar: [debug] -file = /tmp/lx-office-debug.log +file = /tmp/kivitendo-debug.log ist der Key file im Programm als $::lx_office_conf->{debug}{file} @@ -4919,7 +4908,7 @@ file = /tmp/lx-office-debug.log Allgemeines - Wenn Änderungen in der Konfiguration von Lx-Office gemacht + Wenn Änderungen in der Konfiguration von kivitendo gemacht werden, muss der Webserver neu gestartet werden. Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu @@ -4938,13 +4927,13 @@ file = /tmp/lx-office-debug.log Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm am Laufen zu halten. Man kann mit die, confess oder carp Fehler - ausgeben, die dann vom Dispatcher angezeigt werden. Die Lx-Office + ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo eigene $::form-error()> tut im Prinzip das Gleiche, mit ein paar Extraoptionen. warn und exit hingegen werden nicht abgefangen. warn wird direkt nach STDERR, also in Server Log eine Nachricht schreiben (sofern in der Konfiguration nicht die - Warnungen in das Lx-Office Log umgeleitet wurden), und + Warnungen in das kivitendo Log umgeleitet wurden), und exit wird die Ausführung beenden. Prinzipiell ist es kein Beinbruch, wenn sich der Prozess @@ -4977,7 +4966,7 @@ file = /tmp/lx-office-debug.log 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 + Rechnungsmaske in kivitendo 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. @@ -5014,7 +5003,7 @@ file = /tmp/lx-office-debug.log diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele Entwicklung im stable- und unstable-Baum betrifft. - Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert. + Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert. Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt. Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, @@ -5028,7 +5017,7 @@ file = /tmp/lx-office-debug.log angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern mehr braucht. - Lx-Office merkt sich dabei, welches der Upgradescripte in + kivitendo merkt sich dabei, welches der Upgradescripte in sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht erneut aus. Dazu dient die Tabelle "schema_info", die bei der Anmeldung automatisch angelegt wird. @@ -5105,7 +5094,7 @@ file = /tmp/lx-office-debug.log Optional. Eine mit Leerzeichen getrennte Liste von "tags", - von denen dieses Upgradescript abhängt. Lx-Office stellt sicher, + von denen dieses Upgradescript abhängt. kivitendo stellt sicher, dass die in dieser Liste aufgeführten Scripte bereits durchgeführt wurden, bevor dieses Script ausgeführt wird. @@ -5131,7 +5120,7 @@ file = /tmp/lx-office-debug.log der Wert 1000 benutzt. Dies ist reine Kosmetik. Für echte Reihenfolgen muss - "depends" benutzt werden. Lx-Office sortiert die auszuführenden + "depends" benutzt werden. kivitendo sortiert die auszuführenden Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y" abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt, @@ -5159,10 +5148,10 @@ file = /tmp/lx-office-debug.log Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern, existiert ein Hilfsscript namens "scripts/dbupgrade2_tool.pl". Es muss aus dem - Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool + kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool liest alle Datenbankupgradescripte aus dem Verzeichnis sql/Pg-upgrade2 aus. Es benutzt dafür die - gleichen Methoden wie Lx-Office selber, sodass alle Fehlersituationen + gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen von der Kommandozeile überprüft werden können. Wird dem Script kein weiterer Parameter übergeben, so wird nur @@ -5176,7 +5165,7 @@ file = /tmp/lx-office-debug.log --list" Gibt eine Liste aller Scripte aus. Die Liste ist in der - Reihenfolge sortiert, in der Lx-Office die Scripte ausführen + Reihenfolge sortiert, in der kivitendo die Scripte ausführen würde. Es werden neben der Listenposition der Tag, die Abhängigkeitstiefe und die Priorität ausgegeben. @@ -5242,7 +5231,7 @@ file = /tmp/lx-office-debug.log internationalen Übersetzern die Arbeit zu erleichtern. - This section describes how localization packages in Lx-Office + This section describes how localization packages in kivitendo are built. Currently the only language fully supported is German, and since most of the internal messages are held in English the English version is usable too. @@ -5255,9 +5244,9 @@ file = /tmp/lx-office-debug.log xreflabel="File structure"> File structure - The structure of locales in Lx-Office is: + The structure of locales in kivitendo is: - lx-office/locale/<langcode>/ + kivitendo/locale/<langcode>/ where <langcode> stands for an abbreviation of the language package. The builtin packages use two letter special_chars - Lx-Office comes with a lot of interfaces to different + kivitendo comes with a lot of interfaces to different formats, some of which are rather picky with their accepted charset. The special_chars file contains a listing of chars not suited for different file format and @@ -5440,6 +5429,148 @@ filenames + + Die kivitendo-Test-Suite + + + Einführung + + kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul Test::More. + + Die grundlegenden Fakten sind: + + + Alle Tests liegen im Unterverzeichnis t/. + + Ein Script (bzw. ein Test) in f/ enthält einen oder mehrere Testfälle. + + Alle Dateinamen von Tests enden auf .t. Es sind selbstständig ausführbare Perl-Scripte. + + Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in f/, deren + Dateiname auf .t endet. + + + + + Voraussetzungen + + Für die Ausführung werden neben den für kivitendo eh schon benötigten Module noch weitere Perl-Module benötigt. Diese sind: + + + Test::Deep (Debian-Paketname: libtest-deep-perl; Fedora Core: + perl-Test-Deep; openSuSE: perl-Test-Deep) + + + + + + Existierende Tests ausführen + + + Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder, man lässt alle Tests auf einmal ausführen, oder man führt + gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript t/test.sh. + + Will man die komplette Test-Suite ausführen, so muss man einfach nur t/test.sh ohne weitere Parameter aus + dem kivitendo-Basisverzeichnis heraus ausführen. + + Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an t/test.sh. Beispielsweise: + + t/test.sh t/form/format_amount.t t/background_job/known_jobs.t + + + + + + Bedeutung der verschiedenen Test-Scripte + + + Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch + während der Entwicklung nützliche Tests sind: + + + t/001compile.t -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab + t/002goodperl.t -- überprüft alle Perl-Dateien auf Anwesenheit von 'use strict'-Anweisungen + t/003safesys.t -- überprüft Aufrufe von system() und exec() auf Gültigkeit + t/005no_tabs.t -- überprüft, ob Dateien Tab-Zeichen enthalten + t/006spelling.t -- sucht nach häufigen Rechtschreibfehlern + t/011pod.t -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit + + + Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module. + + + + + Neue Test-Scripte erstellen + + + Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende + Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden. + + + + Ideen für neue Test-Scripte, die keine konkreten Funktionen testen + + + Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden: + + + Überprüfung auf fehlende symbolische Links + Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten) + Test auf DOS-Zeilenenden (\r\n anstelle von nur \n) + Überprüfung auf Leerzeichen am Ende von Zeilen + Test, ob alle zu übersetzenden Strings in locale/de/all vorhanden sind + Test, ob alle Webseiten-Templates in templates/webpages mit vom Perl-Modul Template compiliert werden können + + + + + + Konvention für Verzeichnis- und Dateinamen + + + Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten und ihnen soweit es geht folgen: + + + Die Dateiendung muss .t lauten. + + Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise + bad_function_params.t). + + Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen + (beispielsweise background_jobs für Tests rund um Hintergrund-Jobs). + + Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist + (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben. + + + + + + Minimales Skelett für eigene Scripte + + + Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden: + + use Test::More tests => 0; + +use lib 't'; + +use Support::TestSetup; + +Support::TestSetup::login(); + + Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie + $::auth, $::form oder $::lxdebug), so muss in der Konfigurationsdatei + config/kivitendo.conf im Abschnitt testing.login ein gültiger Login-Name eingetragen + sein. Dieser wird für die Datenbankverbindung benötigt. + + Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile Support::TestSetup::login(); + weggelassen werden, was die Ausführungszeit des Scripts leicht verringert. + + + + Stil-Richtlinien @@ -5591,7 +5722,7 @@ map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount; Sämtliche Kommentare und Sonstiges im Quellcode ist bitte auf Englisch zu verfassen. So wie ich keine Lust habe, - französischen Quelltext zu lesen, sollte auch der Lx-Office + französischen Quelltext zu lesen, sollte auch der kivitendo Quelltext für nicht-Deutschsprachige lesbar sein. Beispiel: @@ -5665,7 +5796,7 @@ $some_hash{42} = 54; STDERR ist tabu. Unkonditionale Debugmeldungen auch. - Lx-Office bietet mit dem Modul LXDebug + kivitendo bietet mit dem Modul LXDebug einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen Grund, nach STDERR zu schreiben. @@ -5711,11 +5842,11 @@ $some_hash{42} = 54; Bei DocBook ist Prinzip, dass ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML - erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script + erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script scripts/build_doc.sh. Das Script benötigt zur Konvertierung verschiedene - Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht benötigt + Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt werden: @@ -5763,7 +5894,7 @@ unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip Die eigentliche Konvertierung erfolgt nach Installation der benötigten Software mit einem einfachen Aufruf direkt aus dem - Lx-Office-Installationsverzeichnis heraus: + kivitendo-Installationsverzeichnis heraus: ./scripts/build_doc.sh