Debugging: Common::check_params gibt jetzt bei Fehler einen Dump des $param Parameter...

[kivitendo-erp.git] / doc / INSTALL.txt

diff --git a/doc/INSTALL.txt b/doc/INSTALL.txt
index fb172d4..475ba9f 100644 (file)
--- a/doc/INSTALL.txt
+++ b/doc/INSTALL.txt
@@ -1,14 +1,15 @@
-Inhaltsverzeichnis
-******************
+Table of Contents
+*****************

 
 Inhalt der Anleitung
 1 Aktuelle Hinweise
 2 Benötigte Software und Pakete
 3 Installation des Programmpaketes
 4 Anpassung der PostgreSQL-Konfiguration
 
 Inhalt der Anleitung
 1 Aktuelle Hinweise
 2 Benötigte Software und Pakete
 3 Installation des Programmpaketes
 4 Anpassung der PostgreSQL-Konfiguration

-  4.1 Änderungen an Konfigurationsdateien
-  4.2 Erweiterung für servergespeicherte Prozeduren
-  4.3 Datenbankbenutzer anlegen
+  4.1 Zeichensätze/die Verwendung von UTF-8
+  4.2 Änderungen an Konfigurationsdateien
+  4.3 Erweiterung für servergespeicherte Prozeduren
+  4.4 Datenbankbenutzer anlegen

 5 Apache-Konfiguration
 6 Benutzerauthentifizierung und Administratorpasswort
   6.1 Grundlagen zur Benutzerauthentifizierung
 5 Apache-Konfiguration
 6 Benutzerauthentifizierung und Administratorpasswort
   6.1 Grundlagen zur Benutzerauthentifizierung


@@ -69,18 +70,25 @@ Bestandteil einer Standard-Perl-Installation sind:
 
    * IO::Wrap (aus dem Paket IO::Stringy)
 
 
    * IO::Wrap (aus dem Paket IO::Stringy)
 

+   * PDF::API2
+

    * YAML
 
    * Template
 
    * YAML
 
    * Template
 

+   * List::MoreUtils
+
+   * Email::Address
+

    Diese Pakete können bei den unterschiedlichen Distributionen anders
 heißen.
 
    Für Debian oder Ubuntu benötigen Sie diese Pakete:
 
    Diese Pakete können bei den unterschiedlichen Distributionen anders
 heißen.
 
    Für Debian oder Ubuntu benötigen Sie diese Pakete:
 

-   `apache postgresql libdbi-perl libdbd-pg-perl libpgperl
-libclass-accessor-perl libarchive-zip-perl libtext-iconv-perl
-libyaml-perl libtext-csv-perl libio-stringy-perl libtemplate-perl'
+   `apache postgresql libdbi-perl libdbd-pg-perl libpg-perl
+libpdf-api2-perl libclass-accessor-perl libarchive-zip-perl
+libtext-iconv-perl libyaml-perl libtext-csv-perl libio-stringy-perl
+libtemplate-perl'

 
    Für Fedora Core benötigen Sie unter anderem diese Pakete:
 
 
    Für Fedora Core benötigen Sie unter anderem diese Pakete:
 


@@ -92,20 +100,25 @@ libyaml-perl libtext-csv-perl libio-stringy-perl libtemplate-perl'
 perl-Class-Accessor perl-Text-Iconv perl-Text-CSV_XS perl-IO-stringy
 perl-Template-Toolkit'
 
 perl-Class-Accessor perl-Text-Iconv perl-Text-CSV_XS perl-IO-stringy
 perl-Template-Toolkit'
 

-   Da Perl-CGI-Ajax nicht als Paket für Distributionen bereit steht, muß
-es mit der CPAN-Shell installiert werden.  Leider gibt es Fälle, in
-denen das nicht möglich oder praktikabel ist. Lx-Office liefert daher
-das Paket im CGI-Verzeichnis mit. Das sollte als Fall-Back greifen.
+   Einige Module werden von Lx-Office benötigt, sind aber evtl. nicht
+als Distributionspakete vorhanden, und/oder nicht praktikabel zu
+installieren.  In diesen Fällen liefert Lx-Office das Paket mit, und
+lädt es als Fallback.
+
+   Lx-Office enthält ein Script, mit dem überprüft werden kann, ob alle
+benötigten Perl-Module installiert sind. Der Aufruf lautet wie folgt:
+
+   `./scripts/installation_check.pl'

 
 3 Installation des Programmpaketes
 **********************************
 
 
 3 Installation des Programmpaketes
 **********************************
 

-Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.4.x.tgz) wird im
+Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.0.tgz) wird im

 Dokumentenverzeichnis des Webservers (z.B. `/var/www/html/',
 `/srv/www/htdocs' oder `/var/www/') entpackt:
 
    `cd /var/www
 Dokumentenverzeichnis des Webservers (z.B. `/var/www/html/',
 `/srv/www/htdocs' oder `/var/www/') entpackt:
 
    `cd /var/www

-tar xvzf lxoffice-erp-2.4.x.tgz'
+tar xvzf lxoffice-erp-2.6.0.tgz'

 
    Verändern Sie evtl. noch den Namen des Verzeichnisses mit
 
 
    Verändern Sie evtl. noch den Namen des Verzeichnisses mit
 


@@ -114,32 +127,66 @@ tar xvzf lxoffice-erp-2.4.x.tgz'
    Alternativ können Sie auch einen Alias in der Webserverkonfiguration
 benutzen, um auf das tatsächliche Installationsverzeichnis zu verweisen.
 
    Alternativ können Sie auch einen Alias in der Webserverkonfiguration
 benutzen, um auf das tatsächliche Installationsverzeichnis zu verweisen.
 

-   Das Verzeichnis muß für den Benutzer beschreibbar sein, unter dem der
-Webserver läuft. Dieser 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. Der
+Benutzername ist 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/'
+   `chown -R www-data lx-office-erp/users lx-office-erp/spool
+lx-office-erp/webdav'

 
 4 Anpassung der PostgreSQL-Konfiguration
 ****************************************
 
 PostgreSQL muss auf verschiedene Weisen angepasst werden.
 
 
 4 Anpassung der PostgreSQL-Konfiguration
 ****************************************
 
 PostgreSQL muss auf verschiedene Weisen angepasst werden.
 

-4.1 Änderungen an Konfigurationsdateien
+4.1 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.0
+oder neuer benutzt werden, und der PostgreSQL-Datenbankcluster muss
+ebenfalls mit UTF-8 als Locale angelegt worden sein.
+
+   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. mit dem folgenden Befehl getan werden:
+
+   `pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2
+clustername'
+
+   Die Datenbankversionsnummer muss an die tatsächlich verwendete
+Versionsnummer angepasst werden.
+
+   Unter anderen Distributionen gibt es ähnliche Methoden.
+
+   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.
+
+4.2 Änderungen an Konfigurationsdateien

 =======================================
 
 In der Datei `postgresql.conf', die je nach Distribution in
 verschiedenen Verzeichnissen liegen kann (z.B. `/var/lib/pgsql/data/'
 oder `/etc/postgresql/', muss sichergestellt werden, dass
 =======================================
 
 In der Datei `postgresql.conf', die je nach Distribution in
 verschiedenen Verzeichnissen liegen kann (z.B. `/var/lib/pgsql/data/'
 oder `/etc/postgresql/', muss sichergestellt werden, dass

-TCP/IP-Verbindungen aktiviert sind. Dieser Parameter lautet
+TCP/IP-Verbindungen aktiviert sind. Für PostgreSQL vor Version v8.0
+lautete dieser Parameter

 
    `TCPIP_SOCKET = 1'
 
 
    `TCPIP_SOCKET = 1'
 

-   Bei PostgreSQL-Versionen ab v8.0 und neuer muss zusätzlich der
-folgende Parameter gesetzt werden:
-
-   `default_with_oids = on'
+   Ab v8.0 wird das Verhalten hingegen über den neuen Parameter
+`listen_address' gesteuert. Laufen PostgreSQL und Lx-Office 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.

 
    In der Datei `pg_hba.conf', die im gleichen Verzeichnis wie die
 `postgresql.conf' zu finden sein sollte, müssen die Berichtigungen für
 
    In der Datei `pg_hba.conf', die im gleichen Verzeichnis wie die
 `postgresql.conf' zu finden sein sollte, müssen die Berichtigungen für


@@ -157,7 +204,7 @@ zuzulassen. Beispielsweise:
 host    all         lxoffice      127.0.0.1         255.255.255.255
 password'
 
 host    all         lxoffice      127.0.0.1         255.255.255.255
 password'
 

-4.2 Erweiterung für servergespeicherte Prozeduren
+4.3 Erweiterung für servergespeicherte Prozeduren

 =================================================
 
 In der Datenbank `template1' muss die Unterstützung für
 =================================================
 
 In der Datenbank `template1' muss die Unterstützung für


@@ -174,7 +221,7 @@ create language 'plpgsql' handler plpgsql_call_handler lancompiler
 Distribution zu Distribution verschiedlich sein kann. Bei Debian/Ubuntu
 befindet sie sich unter `/usr/lib/postgresql/lib/plpgsql.so'.
 
 Distribution zu Distribution verschiedlich sein kann. Bei Debian/Ubuntu
 befindet sie sich unter `/usr/lib/postgresql/lib/plpgsql.so'.
 

-4.3 Datenbankbenutzer anlegen
+4.4 Datenbankbenutzer anlegen

 =============================
 
 Wenn Sie nicht den Datenbanksuperuser "postgres" zum Zugriff benutzen
 =============================
 
 Wenn Sie nicht den Datenbanksuperuser "postgres" zum Zugriff benutzen


@@ -306,7 +353,7 @@ LDAP-Server in `$self->{LDAP_config}' angegeben werden:
    * `tls' - Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
      Wert auf `1' setzen, andernfalls auf `0' belassen
 
    * `tls' - Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
      Wert auf `1' setzen, andernfalls auf `0' belassen
 

-   * `attribute'' - Das LDAP-Attribut, in dem der Benutzername steht,
+   * `attribute' - Das LDAP-Attribut, in dem der Benutzername steht,

      den der Benutzer eingegeben hat. Für Active-Directory-Server   ist
      dies meist `sAMAccountName', für andere LDAP-Server hingegen
      `uid'. Diese Angabe ist zwingend erforderlich.
      den der Benutzer eingegeben hat. Für Active-Directory-Server   ist
      dies meist `sAMAccountName', für andere LDAP-Server hingegen
      `uid'. Diese Angabe ist zwingend erforderlich.


@@ -354,7 +401,7 @@ das unter der folgenden URL erreichbar sein sollte:
 *********************************
 
 Nach der Installation müssen Benutzer, Gruppen und Datenbanken angelegt
 *********************************
 
 Nach der Installation müssen Benutzer, Gruppen und Datenbanken angelegt

-werden.  Dieses geschieht im Administrationsmenü, dass Sie unter
+werden.  Dieses geschieht im Administrationsmenü, das Sie unter

 folgender URL finden:
 
    `http://localhost/lx-erp/admin.pl'
 folgender URL finden:
 
    `http://localhost/lx-erp/admin.pl'


@@ -380,7 +427,7 @@ Produktivdaten enthaltenden Datenbanken vorgeschaltet. Pro
 Lx-Office-Installation gibt es nur eine Authentifizierungsdatenbank,
 aber beliebig viele Datenbanken mit Firmendaten.
 
 Lx-Office-Installation gibt es nur eine Authentifizierungsdatenbank,
 aber beliebig viele Datenbanken mit Firmendaten.
 

-   Lx-Office lann seinen Benutzern Zugriff auf bestimmte
+   Lx-Office 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
 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
 gestattet, so werden der entsprechenden Menüpunkte auch nicht
 angezeigt. Diese Rechte werden ebenfalls in der