projekt kivitendo

<book id="kivitendo-documentation" lang="de">

<title>kivitendo 3.0.0: Installation, Konfiguration, Entwicklung</title>

<para>im kivitendo-Forum: <ulink

</listitem>

<chapter id="config">

<title>Installation und Grundkonfiguration</title>

<sect1 id="Installation-Übersicht">

<sect1 id="Benötigte-Software-und-Pakete">

<para>kivitendo ist für Linux konzipiert, und sollte auf jedem

unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist

<para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,

<listitem>

<para>Debian</para>

<para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden, und <literal>Rose::DB::Object</literal> ist zu alt)</para>

</listitem>

<para>7.0 "Wheezy"</para>

</listitem>

</listitem>

<para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal" und 13.04 "Precise Pangolin"</para>

</listitem>

<para>openSUSE 12.2 und 12.3</para>

</listitem>

<para>Fedora 16 bis 19</para>

</listitem>

<title>Benötigte Perl-Pakete installieren</title>

<para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist

Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)

benötigt.</para>

<para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu

<listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>

<listitem><para><literal>Archive::Zip</literal></para></listitem>

<listitem><para><literal>Config::Std</literal></para></listitem>

<listitem><para><literal>DateTime</literal></para></listitem>

<listitem><para><literal>DBI</literal></para></listitem>

<listitem><para><literal>DBD::Pg</literal></para></listitem>

<listitem><para><literal>Email::Address</literal></para></listitem>

<listitem><para><literal>Email::MIME</literal></para></listitem>

<listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>

<listitem><para><literal>File::Copy::Recursive</literal></para></listitem>

<listitem><para><literal>JSON</literal></para></listitem>

<listitem><para><literal>List::MoreUtils</literal></para></listitem>

<listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref

<listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref

<listitem><para><literal>Params::Validate</literal></para></listitem>

<listitem><para><literal>PDF::API2</literal></para></listitem>

<listitem><para><literal>Rose::Object</literal></para></listitem>

<listitem><para><literal>Rose::DB</literal></para></listitem>

<listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>

<listitem><para><literal>Template</literal></para></listitem>

<listitem><para><literal>Text::CSV_XS</literal></para></listitem>

<listitem><para><literal>Text::Iconv</literal></para></listitem>

<listitem><para><literal>URI</literal></para></listitem>

<listitem><para><literal>XML::Writer</literal></para></listitem>

<listitem><para><literal>YAML</literal></para></listitem>

</itemizedlist>

<para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>

<para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,

<para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete

<literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo

nicht.</para>

Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide

sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer

<sect3>

libfile-copy-recursive-perl postgresql</programlisting>

</sect3>

<sect3>

<para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden:</para>

<programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \

perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \

perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \

perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \

perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>

<para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>

<programlisting>yum install perl-CPAN

</sect3>

<sect3>

perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \

perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \

</sect2>

<para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers

(z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>

<programlisting>cd /var/www

tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>

<para>Wechseln Sie in das entpackte Verzeichnis:</para>

<programlisting>cd kivitendo-erp</programlisting>

<para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer

core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>

<programlisting>chown -R www-data users spool webdav</programlisting>

<para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>

Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>

<programlisting>chown www-data templates users</programlisting>

</sect1>

<title>kivitendo-Konfigurationsdatei</title>

<sect2 id="config.config-file.introduction"

<para>In kivitendo gibt es nur noch eine Konfigurationsdatei,

"die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation

von kivitendo bzw. der Migration von älteren Versionen angelegt

werden.</para>

<para>Als Vorlage dient die Datei

<filename>config/kivitendo.conf.default</filename> (kurz: "die

Default-Datei"):</para>

<programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>

<para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in

Abschnitte und Werte enthalten, die von denen der Default-Datei

abweichen.</para>

<note>

<para>Diese Hauptkonfigurationsdatei ist dann eine

<para>Die Konfiguration ist ferner serverabhängig, d.h. für alle

<sect2 id="config.config-file.sections-parameters">

<para>Die Konfigurationsdatei besteht aus mehreren Teilen, die

<itemizedlist>

<listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref

<listitem><para><literal>authentication/database</literal></para></listitem>

<listitem><para><literal>authentication/ldap</literal></para></listitem>

<listitem><para><literal>system</literal></para></listitem>

<listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>

<listitem><para><literal>paths</literal></para></listitem>

<listitem><para><literal>applications</literal></para></listitem>

<listitem><para><literal>environment</literal></para></listitem>

<listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>

<listitem><para><literal>print_templates</literal></para></listitem>

<listitem><para><literal>task_server</literal></para></listitem>

<listitem><para><literal>periodic_invoices</literal></para></listitem>

<listitem><para><literal>console</literal></para></listitem>

<listitem><para><literal>debug</literal></para></listitem>

</itemizedlist>

<para>Die üblicherweise wichtigsten Parameter, die am Anfang

admin_password = geheim

db = kivitendo_auth

user = postgres

password =</programlisting>

<para>Nutzt man wiederkehrende Rechnungen, kann man unter

<para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link

<para>In älteren kivitendo Versionen gab es im Verzeichnis

<filename>config</filename> die Dateien

<para>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

gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine

entsprechende Fehlermeldung an.</para>

</sect1>

<title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>

<para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen

<para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so

<para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit

Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl

getan werden:</para>

<programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>

<para>Die Datenbankversionsnummer muss an die tatsächlich verwendete

<para>Das Encoding einer Datenbank kann in <command>psql</command> mit

</sect2>

<para>In der Datei <filename>postgresql.conf</filename>, die je nach

Distribution in verschiedenen Verzeichnissen liegen kann (z.B.

<filename>/var/lib/pgsql/data/</filename> oder

<filename>/etc/postgresql/</filename>, muss sichergestellt werden,

Parameter <varname>listen_address</varname> gesteuert. Laufen

PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert

<literal>localhost</literal> verwendet werden. Andernfalls müssen

was mit dem Wert <literal>*</literal> geschieht.</para>

<para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen

Verzeichnis wie die <filename>postgresql.conf</filename> zu finden

werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die

<programlisting>local all kivitendo password

</sect2>

Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:

führen Sie die folgenden Kommandos aus:</para>

<programlisting>create language 'plpgsql';

</sect2>

<para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein

<programlisting>su - postgres

createuser -d -P kivitendo

Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.

den hier gewählten Benutzernamen.</para>

<xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>

</note>

<programlisting>AddHandler cgi-script .pl

Alias /kivitendo-erp/ /var/www/kivitendo-erp/

&lt;Directory /var/www/kivitendo-erp&gt;

Options ExecCGI Includes FollowSymlinks

&lt;/Directory&gt;

&lt;Directory /var/www/kivitendo-erp/users&gt;

Order Deny,Allow

das kivitendo-Archiv entpacket haben.</para>

<note>

<para>Vor den einzelnen Optionen muss bei einigen Distributionen ein

</note>

<programlisting>EnableSendfile Off</programlisting>

</sect2>

<para>Perl Programme (wie kivitendo eines ist) werden nicht statisch

kompiliert. Stattdessen werden die Quelldateien bei jedem Start

müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass

immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich

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

<para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern

<para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt

installieren:</para>

<programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>

</sect3>

<para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI

laufen zu lassen, empfliehlt es sich die Installation ersteinmal

<para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI

erfolgt durch Anpassung der vorhandenen <function>Alias</function>-

dem Installationspfad von kivitendo im Dateisystem

<programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi

&lt;Directory /path/to/kivitendo-erp&gt;

AllowOverride All

&lt;DirectoryMatch /path/to/kivitendo-erp/users&gt;

Order Deny,Allow

<para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für

die maximale Größe eines Requests. Diese sollte wie folgt

AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl

FcgidMaxRequestLen 10485760

&lt;Directory /path/to/kivitendo-erp&gt;

AllowOverride All

&lt;DirectoryMatch /path/to/kivitendo-erp/users&gt;

Order Deny,Allow

<para>Es ist möglich, die gleiche kivitendo Version parallel unter

CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven

Alias /url/for/kivitendo-erp /path/to/kivitendo-erp

AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl

<para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>

die normale Version erreichbar, und unter

<constant>/url/for/kivitendo-erp-fcgid/</constant> die

FastCGI-Version.</para>

</sect3>

<sect1 id="config.task-server">

<title>Der Task-Server</title>

<para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und

<filename>config/kivitendo.conf</filename>. Die dort verfügbaren

Optionen sind:</para>

<variablelist>

<varlistentry>

<varlistentry>

<listitem>

<para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der

</listitem>