projekt kivitendo

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<chapter id="Aktuelle-Hinweise">

<title>Aktuelle Hinweise</title>

<para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>

<itemizedlist>

<listitem>

<para>im Kunden-Forum: <ulink

url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>

</listitem>

Installation</para>

kivitendo-Partner: <ulink

</listitem>

</chapter>

<title>Übersicht</title>

folgende Liste kann sowohl für Neulinge als auch für alte Hasen als

Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit

minimalen Features möglichst schnell zum Laufen zu kriegen.</para>

<orderedlist>

<para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo

benötigt gewisse Ressourcen und benutzt weitere Programme. Das

Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert

diese. Auch die Liste der benötigten Perl-Module befindet sich

hier.</para>

</listitem>

<para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst

die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"

sowie grundlegende Einstellungen, die der "<xref

linkend="config.config-file"/>" erläutert.</para>

</listitem>

<para><emphasis>Konfiguration externer Programme</emphasis>: hierzu

gehören die Datenbank ("<xref

linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der

Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>

</listitem>

<para><emphasis>Benutzerinformationen speichern können</emphasis>:

man benötigt mindestens eine Datenbank, in der Informationen zur

Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man

das als Administrator macht, verrät "<xref

linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>

</listitem>

<para><emphasis>Benutzer, Gruppen und Datenbanken

anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref

linkend="Benutzer--und-Gruppenverwaltung"/>".</para>

</listitem>

<para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann

kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>

</listitem>

wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen

werden.</para>

<title>Benötigte Software und Pakete</title>

<sect2 id="Betriebssystem">

<title>Betriebssystem</title>

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

<itemizedlist>

<listitem>

<listitem>

<listitem>

<listitem>

</itemizedlist>

</sect2>

<sect2 id="Pakete" xreflabel="Pakete">

Version (s.a. Liste der unterstützten Betriebssysteme)

benötigt.</para>

Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,

ob die erforderlichen Pakete installiert und aktuell genug sind, wird

ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>

<programlisting>./scripts/installation_check.pl</programlisting>

<para>Die vollständige Liste der benötigten Perl-Module lautet:</para>

<itemizedlist>

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

</listitem>

<para><literal>CAM::PDF</literal></para>

</listitem>

<para><literal>CGI</literal></para>

</listitem>

<para><literal>Clone</literal></para>

</listitem>

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

</listitem>

<para><literal>Daemon::Generic</literal></para>

</listitem>

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

</listitem>

<para><literal>DateTime::Event::Cron</literal></para>

</listitem>

<para><literal>DateTime::Format::Strptime</literal></para>

</listitem>

<para><literal>DateTime::Set</literal></para>

</listitem>

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

</listitem>

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

</listitem>

<para><literal>Digest::SHA</literal></para>

</listitem>

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

</listitem>

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

</listitem>

<para><literal>Exception::Class</literal></para>

</listitem>

<para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71

inklusive; siehe <xref

linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>

</listitem>

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

</listitem>

<para><literal>File::Flock</literal></para>

</listitem>

<para><literal>File::Slurp</literal></para>

</listitem>

<para><literal>GD</literal></para>

</listitem>

<para><literal>HTML::Parser</literal></para>

</listitem>

<para><literal>HTML::Restrict</literal></para>

</listitem>

<para><literal>Image::Info</literal></para>

</listitem>

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

</listitem>

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

</listitem>

</listitem>

<para>LWP::Authen::Digest</para>

</listitem>

<listitem>

<para>LWP::UserAgent</para>

</listitem>

<para><literal>Net::SMTP::SSL</literal> (optional, bei

E-Mail-Versand über SSL; siehe Abschnitt "<xref

linkend="config.sending-email.smtp"/>")</para>

</listitem>

<para><literal>Net::SSLGlue</literal> (optional, bei

E-Mail-Versand über TLS; siehe Abschnitt "<xref

linkend="config.sending-email.smtp"/>")</para>

</listitem>

<para><literal>Math::Round</literal></para>

</listitem>

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

</listitem>

<para><literal>PBKDF2::Tiny</literal></para>

</listitem>

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

</listitem>

<para><literal>Regexp::IPv6</literal></para>

</listitem>

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

</listitem>

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

</listitem>

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

neuer</para>

</listitem>

<para><literal>Set::Infinite</literal></para>

</listitem>

<para><literal>String::ShellQuote</literal></para>

</listitem>

<para><literal>Sort::Naturally</literal></para>

</listitem>

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

</listitem>

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

</listitem>

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

</listitem>

</listitem>

<para><literal>Try::Tiny</literal></para>

</listitem>

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

</listitem>

<para><literal>XML::LibXML</literal></para>

</listitem>

<literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>

<para>Seit Version größer v3.5.0 sind die folgenden Pakete

<literal>LWP::Authen::Digest</literal>,

<literal>LWP::UserAgent</literal></para>

<literal>PBKDF2::Tiny</literal></para>

<literal>GD</literal>, <literal>HTML::Restrict</literal>,

<literal>Image::Info</literal></para>

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

hinzugekommen, <literal>URI</literal> und

<para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,

<literal>DateTime</literal>, <literal>Rose::Object</literal>,

<literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>

neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>

<para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu

hinzugekommen.</para>

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

<literal>List::MoreUtils</literal> sind schon länger feste

zukünftigen Version aber aus dem Paket entfernt werden. Es wird

empfohlen diese Module zusammen mit den anderen als Bibliotheken zu

installieren.</para>

<title>Debian und Ubuntu</title>

libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \

liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \

libparams-validate-perl libpdf-api2-perl librose-db-object-perl \

librose-db-perl librose-object-perl libsort-naturally-perl \

libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \

libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \

<note id="ubuntu-universe">

<para>Die Perl Pakete für Ubuntu befinden sich im "Universe" Repository. Falls dies nicht aktiv ist, kann dies mit folgendem Aufruf aktiviert werden:

<programlisting>add-apt-repository universe</programlisting></para>

</note>

RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl

installiert werden:</para>

perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \

perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \

perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \

perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \

perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \

perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-DB-Object \

perl-YAML perl-libwww-perl</programlisting>

<para>Damit diese installiert werden können, muß das System die erforderlichen Repositories kennen und Zugriff über das Internet darauf haben.</para>

<para>Daher machen wir die Repositories dem System bekannt.</para>

<para>Um die zusätzlichen Repositories für die Installation zur Verfügung zu stellen, kann man diese mit YaST oder auch in einem Terminal auf der Konsole bekannt geben. Wir beschränken uns hier mit der Eingabe auf der Konsole. In den allermeisten Fällen verwenden die Administratoren eine sichere SSH-Verbindung zum zu administrierenden Server.</para>

<programlisting>zypper addrepo -f \

</programlisting>

<programlisting>zypper addrepo -f \

https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\

openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"

</programlisting>

<programlisting>zypper addrepo -f \

https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\

openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"

</programlisting>

<para>Danach geben wir noch die beiden folgenden Befehle ein:</para>

<programlisting>zypper clean</programlisting>

<programlisting>zypper refresh</programlisting>

<para>Sollte zypper eine Meldung ausgeben, ob der Repositorie Key abgelehnt, nicht vertraut oder für immer akzeptiert werden soll, ist die Beantwortung durch drücken der "i" Taste am besten geeignet. Wer noch mehr über zypper erfahren möchte, kann sich einmal die zypper Hilfe anschauen.</para>

<programlisting>zypper --help</programlisting>

<note>

<para>Bei openSUSE Versionen bis 15.x, also 10.x, 11.x, 12.x, 13.x hatte der Administrator die Möglichkeit, bei der Installation der Distribution die KDE Oberfläche zu aktivieren. In dieser Konstellation hat man die Möglichkeit, eine VNC Verbindung vom administrativen Client zu verwenden. Ist das nicht eingerichtet, arbeitet der Admin dann direkt am Bildschirm des Servers. Nun loggen wir uns am Server direkt ein, starten Yast2 in einer Konsole wie folgt:</para>

<para>Im weiteren Verlauf der Installation, beschränken wir uns mit dem Installations Werkzeug zypper. Zypper ist ein Komandozeilen basiertes Installations Tool, welches bei openSUSE Standard ist. Zypper weist ein etwas eigenartiges Verhalten auf, dass sich in etwa wie folgt darstellt. Hat man die Repositories eingerichtet, kann man diese mit Yast als auch mit Zypper benutzen, setzt man einen Befehl wie etwa: zypper up ab, so findet zypper mehr neuere Programmversionen als Yast. Ich habe im allgemeinen noch keine Nachteile damit erlebt.</para>

<para>Programmpakete können mit folgendem Befehl installiert werden:</para>

<programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \

perl-Archive-Zip perl-CGI perl-CGI-Ajax perl-Clone \

perl-Config-Std perl-Class-XSAccessor perl-Daemon-Generic perl-DateTime \

perl-DateTime-Event-Cron perl-DateTime-Format-Strptime perl-DateTime-Set \

perl-DBI perl-DBD-Pg perl-Devel-REPL perl-FastCGI perl-Email-Address \

perl-Email-MIME perl-Email-MIME-ContentType perl-Email-MIME-Encodings \

perl-FCGI perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo \

perl-File-Slurp perl-GD perl-HTML-Restrict perl-Image-Info \

perl-JSON perl-List-MoreUtils perl-List-UtilsBy perl-Log-Log4perl perl-Net-LDAP-Server \

perl-Net-SSLGlue perl-Net-SMTP-SSL perl-PBKDF2-Tiny perl-PDF-API2 \

perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-Object \

perl-Rose-DB-Object perl-MooseX-Role-Cmd perl-Set-Crontab perl-Set-Infinite \

perl-Sort-Naturally perl-String-ShellQuote perl-Sys-CPU perl-Template-Toolkit \

perl-Text-CSV_XS perl-Test-Deep perl-Test-Output perl-Text-Iconv \

perl-Text-Unidecode perl-URI perl-URI-Find perl-XML-Writer \

perl-YAML perl-libwww-perl

</programlisting>

<para>Für die Entwickler installiert man noch die folgenden Pakete:</para>

<programlisting>zypper install ghc-mtl-devel ghc-old-locale-devel \

ghc-process-extras-devel ghc-rpm-macros ghc-text-devel ghc-time-devel \

ghc-Cabal-devel ghc-time-locale-compat-devel perl-Log-Log4perl ghc-pdfinfo \

ghc-pdfinfo-devel perl-Devel-REPL perl-URI-Find perl-Class-Utils \

perl-Error-Pure perl-File-Object perl-Readonly perl-Test-Warnings \

perl-Test-NoWarnings perl-Test-Deep perl-Test-Output perl-Test-Strict \

perl-Test-LongString perl-File-Find-Rule

<programlisting>zypper install texlive-wallpaper texlive-colortbl \

texlive-scrlttr2copy texlive-eurosym \

texlive-geometry texlive-german texlive-graphbox texlive-hyperref \

texlive-xifthen texlive-luainputenc texlive-lastpage texlive-ltabptch \

texlive-nomentbl texlive-threeparttablex texlive-substr texlive-tabulary \

texlive-ulem texlive-wallpaper texlive-xcolor texlive-xstring \

texlive-xypic texlive-mwe texlive-mweights texlive-barcodes \

texlive-GS1 texlive-ean texlive-makebarcode texlive-pst-barcode \

texlive-upca

HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>

<title>Andere Pakete installieren</title>

<listitem>

<para><literal>poppler-utils</literal> 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung</para>

</listitem>

<listitem>

<para><literal>Postgres Trigram-Index</literal> Für datenbankoptimierte Suchanfragen. Bspw. im Paket <literal>postgresql-contrib</literal> enthalten</para>

</listitem>

</itemizedlist>

<para>Fedora: <programlisting>dnf install poppler-utils postgresql-contrib</programlisting></para>

<para>openSUSE: <programlisting>zypper install poppler-tools</programlisting></para>

<sect1 id="Manuelle-Installation-des-Programmpaketes"

xreflabel="Manuelle Installation des Programmpaketes">

<title>Manuelle Installation des Programmpaketes</title>

<para>Der aktuelle Stable-Release, bzw. beta Release wird bei github

gehostet und kann <ulink

url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>

heruntergeladen werden.</para>

<filename>/var/www/html/</filename>,

<filename>/srv/www/htdocs</filename> oder

<filename>/var/www/</filename>) entpackt:</para>

<para>Alternativ können Sie auch einen Alias in der

Webserverkonfiguration benutzen, um auf das tatsächliche

Installationsverzeichnis zu verweisen.</para>

WebDAV Verzeichnis derzeit manuell angelegt werden:</para>

<programlisting>mkdir webdav</programlisting>

<filename>spool</filename> und <filename>webdav</filename> 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 <constant>www-data</constant>, bei Fedora

<para>Der folgende Befehl ändert den Besitzer für die oben genannten

Verzeichnisse auf einem Debian/Ubuntu-System:</para>

<filename>templates</filename> und <filename>users</filename>

Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in

kivitendo angelegt wird:</para>

<note>

<para>Wir empfehlen eine Installation mittels des Versionsmanagager

git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr

viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte

cd kivitendo-erp/

beta oder rc raus und das tail gibt davon den obersten Treffer

zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen

Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen

damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>

Git Magic</ulink>).</para>

3.4.1 nach 3.5: <programlisting>

$ cd kivitendo-erp/

$ git checkout -b meine_eigene_änderungen # unser lokaler branch - unabhängig von allen anderen

$ git add templates/mein_druck # das sind unsere druckvorlagen inkl. produktbilder

$ git commit -m "juhu tolle änderungen"

4 files changed, 380 insertions(+)

create mode 100644 templates/mein_druck/mahnung.tex

create mode 100644 templates/mein_druck/zahlungserinnerung_zwei.tex

create mode 100644 templates/mein_druck/zahlungserinnerung_zwei_invoice.tex

# 5 Jahre später ...

$ git checkout master

$ git pull # oder git fetch und danach ein stable release tag auswählen (s.o.)

$ git checkout meine_eigenen_änderungen

$ git rebase master

Zunächst wird der Branch zurückgespult, um Ihre Änderungen

darauf neu anzuwenden ...

$ service apache2 restart # webserver starten!

<sect1 id="config.config-file">

xreflabel="Einführung in die Konfigurationsdatei">

<title>Einführung</title>

benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die

Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von

kivitendo bzw. der Migration von älteren Versionen angelegt

der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der

Default-Datei. Die Hauptkonfigurationsdatei muss also nur die

<filename>config/lx_office.conf</filename>. Aus Gründen der

Kompatibilität wird diese Datei eingelesen, sofern die Datei

<filename>config/kivitendo.conf</filename> nicht existiert.</para>

installationsspezifische Datei, d.h. sie enthält bspw. lokale

Passwörter und wird auch nicht im Versionsmanagement (git)

verwaltet.</para>

Mandaten, bzw. Datenbanken gleich.</para>

</sect2>

<title>Abschnitte und Parameter</title>

entsprechend kommentiert sind:</para>

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

linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"

in diesem Kapitel)</para>

</listitem>

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

</listitem>

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

</listitem>

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

</listitem>

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