<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<book id="kivitendo-documentation" lang="de">
- <title>kivitendo 3.5.0: Installation, Konfiguration, Entwicklung</title>
+ <title>kivitendo 3.5.5: Installation, Konfiguration,
+ Entwicklung</title>
<chapter id="Aktuelle-Hinweise">
<title>Aktuelle Hinweise</title>
<itemizedlist>
<listitem>
<para>im Community-Forum: <ulink
- url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
+ url="https://forum.kivitendo.de">https://forum.kivitendo.de</ulink></para>
</listitem>
<listitem>
ohne große Probleme auf den derzeit aktuellen verbreiteten
Distributionen läuft.</para>
- <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
+ <para>Anfang 2019 sind das folgende Systeme, von denen bekannt ist,
dass kivitendo auf ihnen läuft:</para>
<itemizedlist>
<itemizedlist>
<listitem>
- <para>7.0 "Wheezy"</para>
+ <para>8.0 "Jessie"</para>
</listitem>
-
<listitem>
- <para>8.0 "Jessie"</para>
+ <para>9.0 "Stretch"</para>
+ </listitem>
+ <listitem>
+ <para>10.0 "Buster"</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
- <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
- LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
- Alpha</para>
+ <para>16.04 "Xenial Xerus" LTS und 18.04 "Bionic Beaver" LTS
+ </para>
</listitem>
<listitem>
- <para>openSUSE LEAP 42.1</para>
+ <para>openSUSE 15.0</para>
</listitem>
<listitem>
- <para>Fedora 22</para>
+ <para>Fedora 29</para>
</listitem>
</itemizedlist>
</sect2>
<itemizedlist>
<listitem>
- <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
+ <para><literal>Algorithm::CheckDigits</literal></para>
</listitem>
<listitem>
<para><literal>Archive::Zip</literal></para>
</listitem>
- <listitem>
- <para><literal>Algorithm::CheckDigits</literal></para>
- </listitem>
-
<listitem>
<para><literal>CGI</literal></para>
</listitem>
<para><literal>Config::Std</literal></para>
</listitem>
+ <listitem>
+ <para><literal>Daemon::Generic</literal></para>
+ </listitem>
+
<listitem>
<para><literal>DateTime</literal></para>
</listitem>
+ <listitem>
+ <para><literal>DateTime::Event::Cron</literal></para>
+ </listitem>
+
<listitem>
<para><literal>DateTime::Format::Strptime</literal></para>
</listitem>
+ <listitem>
+ <para><literal>DateTime::Set</literal></para>
+ </listitem>
+
<listitem>
<para><literal>DBI</literal></para>
</listitem>
<para><literal>Email::MIME</literal></para>
</listitem>
+ <listitem>
+ <para><literal>Exception::Class</literal></para>
+ </listitem>
+
<listitem>
<para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
inklusive; siehe <xref
<para><literal>File::Copy::Recursive</literal></para>
</listitem>
+ <listitem>
+ <para><literal>File::Flock</literal></para>
+ </listitem>
+
<listitem>
<para><literal>File::MimeInfo</literal></para>
</listitem>
+ <listitem>
+ <para><literal>File::Slurp</literal></para>
+ </listitem>
+
<listitem>
<para><literal>GD</literal></para>
</listitem>
<para><literal>PDF::API2</literal></para>
</listitem>
+ <listitem>
+ <para><literal>Regexp::IPv6</literal></para>
+ </listitem>
+
<listitem>
<para><literal>Rose::Object</literal></para>
</listitem>
neuer</para>
</listitem>
+ <listitem>
+ <para><literal>Set::Infinite</literal></para>
+ </listitem>
+
<listitem>
<para><literal>String::ShellQuote</literal></para>
</listitem>
</listitem>
<listitem>
- <para><literal>YAML</literal></para>
+ <para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
</listitem>
</itemizedlist>
+ <para>Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: <literal>Exception::Class</literal></para>
+
+ <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
+ <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
+ <literal>Daemon::Generic</literal>, <literal>DateTime::Event::Cron</literal>, <literal>File::Flock</literal>,
+ <literal>File::Slurp</literal></para>
+
<para>Seit Version größer v3.5.0 sind die folgenden Pakete
- hinzugekommen: <literal>Text::Unidecode, LWP::Authen::Digest,
- LWP::UserAgent</literal></para>
+ hinzugekommen: <literal>Text::Unidecode</literal>,
+ <literal>LWP::Authen::Digest</literal>,
+ <literal>LWP::UserAgent</literal></para>
<para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
- <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
+ <literal>Algorithm::CheckDigits</literal>,
+ <literal>PBKDF2::Tiny</literal></para>
<para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
<literal>GD</literal>, <literal>HTML::Restrict</literal>,
<sect3>
<title>Debian und Ubuntu</title>
-
<para>Für Debian und Ubuntu stehen die meisten der benötigten
- Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
+ Pakete als Debian-Pakete zur Verfügung. Sie können mit
folgendem Befehl installiert werden:</para>
<programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
- libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl
+ libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\
+ postgresql-contrib aqbanking-tools poppler-utils libhtml-restrict-perl\
+ libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\
+ libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl\
+ libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \
+ libdatetime-event-cron-perl libexception-class-perl
</programlisting>
-
- <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
- muß per CPAN installiert werden. Unter Ubuntu funktioniert das
- mit:</para>
-
+<para>Sollten Pakete nicht zu Verfügung stehen, so können diese auch mittels CPAN installiert werden. Ferner muss für Ubuntu das Repository "Universe" aktiv sein (s.a. Anmerkungen).</para>
+ <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>
+ <note id="build-essential">
+ <para>Für ältere Ubuntu/Debians müßen einige Pakete per CPAN installiert werden.
+ Das geht bspw. für das benötige Paket HTML::Restrict mit:</para>
<programlisting>apt-get install build-essential
cpan HTML::Restrict</programlisting>
+ </note>
</sect3>
<sect3>
RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
installiert werden:</para>
- <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
- perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
- 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 \
+ <programlisting>dnf install httpd mod_fcgid postgresql-server postgresql-contrib\
+ perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
+ 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-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
- perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
- perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
- perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced perl-libwww-perl</programlisting>
-
- <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
- werden. Dazu können Sie die folgenden Befehle nutzen:</para>
-
- <programlisting>cpan Config::Std HTML::Restrict</programlisting>
+ perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
+ perl-YAML perl-libwww-perl</programlisting>
</sect3>
<sect3>
<title>openSUSE</title>
- <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
- RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
- installiert werden:</para>
+ <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
+ <para>Dies setzt voraus, das eben die erforderlichen Repositories dem System bekannt gemacht worden sind.</para>
+ <para>Um zusätzliche 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. Da wahrscheinlich für die Administration eine SSH-Verbindung zum Server benutzt wird.</para>
+ <para>Dazu geben wir folgenden Befehl ein:</para>
+ <programlisting>zypper addrepo -f \
+ http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.0/ \
+ "devel:languages:perl"
+ </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>Offiziell wird von openSUSE nur noch Versionen ab 15.0 unterstützt. Die SuSE Macher haben ab Version 15.0 einen größen Umbau in der Verwaltung der Pakete vorgenommen, das heißt, der Paketumfang ist der SLES 15 als kleinsten Nenner angepasst. Dies gilt besonders der openSUE Distribution. Es gibt ja einmal die openSUSE Distri und die Professionelle SLES Version. Dadurch sind viele Pakete aus dem Repositorie enfernt worden, aber auch viele auf aktuellen Stand gehalten.</para>
+ </note>
+ <para>Das überprüfen wir mit YaST. Sollte openSUSE bis zur Version 15.0 zum Einsatz kommen und der Administrator bei der Installation der Distribution die KDE Oberfläche aktiviert hat, loggen wir uns am Server direkt ein, starten das Verwaltungsprogram in einer Konsole wie folgt:</para>
+ <para>yast2 return.</para>
+ <para>Oder über die Menüführung wie folgt: Ein Klick auf das runde Icon, ganz links unten in der Menüleiste dann die Maus Verfahren auf System und YaST.</para>
+ <para>Sie können mit folgendem Befehl installiert werden:</para>
+ <para>zypper install Paketname</para>
+ <para>Es wird empfohlen zusätzliche Pakete nicht direkt mit CPAN zu installieren, da man diese auch über andere Repositories beziehen kann, die bei openSUSE zur Verfügung stehen. Dadurch hat man den Vorteil, dass die Pakete mit YaST verwaltet werden, also wieder deinstalliert oder durch neuere ersetzt werden können. Zudem kann man auch noch eventuelle Bugs an openSUSE senden und diese dem Maintainer melden.</para>
+
+ <programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \
+ yast2-http-server postgresql-server postgresql-contrib perl-Algorithm-CheckDigits \
+ 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>
- <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
- perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
- 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 \
- perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
- perl-URI perl-XML-Writer perl-YAML perl-CPAN \
- perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server perl-libwwww-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>
+
+ <para>Zusätzlich müssen einige Pakete für den Umgang mit Latex installiert werden. Die Latex Module barcodes sind nützliche Helfer um auch Barcodes im Dokument zu plazieren, der Vollständigkeit halber hier für die Installation mit angegeben.
+ Dazu können Sie die folgenden Befehle nutzen:</para>
+
+ <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
+ </programlisting>
<para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
werden. Dazu können Sie die folgenden Befehle nutzen:</para>
- <programlisting>cpan Rose::Db::Object</programlisting>
+ <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
+ HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
</sect3>
</sect2>
<sect2>
<title>Andere Pakete installieren</title>
- <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
- 'aqbanking-tools' benötigt.</para>
-
- <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
- </programlisting></para>
-
- <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
-
- <para>Seit Version v3.4.1 wird generell zum Feststellen der
- Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
- 'poppler-utils' enthalten ist.</para>
-
- <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
- </programlisting></para>
-
- <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>aqbanking-tools</literal> Für das Parsen des MT940 Bankformats</para>
+ </listitem>
+ <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>Debian und Ubuntu: <programlisting>apt install aqbanking-tools postgresql-contrib poppler-utils</programlisting></para>
+ <para>Fedora: <programlisting>dnf install aqbanking poppler-utils postgresql-contrib</programlisting></para>
+ <para>openSUSE: <programlisting>zypper install aqbanking-tools poppler-tools</programlisting></para>
</sect2>
</sect1>
url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
heruntergeladen werden.</para>
- <para>Die kivitendo ERP Installationsdatei
- (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
+ <para>Das aktuelleste kivitendo ERP-Archiv
+ (<filename>kivitendo-erp-*.tgz</filename>) wird dann 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.4.1.tgz</programlisting>
+tar xvzf kivitendo-erp-*.tgz</programlisting>
<para>Wechseln Sie in das entpackte Verzeichnis:</para>
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
- <constant>apache</constant> oder bei OpenSUSE
+ <constant>apache</constant> oder bei openSUSE
<constant>wwwrun</constant>).</para>
<para>Der folgende Befehl ändert den Besitzer für die oben genannten
cd kivitendo-erp/
git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
- -l listet alle Tags auf, das egrep schmeisst alle Einträge mit 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>
+ -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
+ 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>
nach dem letzten Kommando (weiterführende Informationen <ulink
url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
Git Magic</ulink>).</para>
<para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
Ausführung bestimmter Aufgaben mit, den <link
- linkend="config.task-server">Taskserver</link>. Er wird u.a. für
+ linkend="config.task-server">Task-Server</link>. Er wird u.a. für
Features wie die <link
linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
<title>Anpassung der PostgreSQL-Konfiguration</title>
<para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
-
+ <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
+ Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
+ <itemizedlist>
+ <listitem>
+ <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
+ </listitem>
+ </itemizedlist>
<sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
<title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
</note>
</sect2>
+ <sect2 id="Erweiterung-für-trigram">
+ <title>Erweiterung für Trigram Prozeduren</title>
+
+ <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
+ Diese wird mit dem SQL-Updatescript
+ sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
+ Rechten automatisch installiert. Dazu braucht der
+ DatenbankSuperbenutzer "postgres" ein Passwort.</para>
+
+ <programlisting>su - postgres
+psql
+\password postgres
+
+Eingabe Passwort
+\q</programlisting>
+
+ <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
+ einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
+ benötigen, eingegeben werden.</para>
+
+ <note>
+ <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
+ Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
+ in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
+ das Paket nachinstalliert werden, bspw. bei debian/ubuntu
+ <programlisting>apt install postgresql-contrib</programlisting></para>
+ </note>
+ </sect2>
+
<sect2 id="Datenbankbenutzer-anlegen">
<title>Datenbankbenutzer anlegen</title>
<itemizedlist>
<listitem>
- <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
+ <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
</listitem>
-
<listitem>
- <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
+ <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
</listitem>
-
<listitem>
- <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
+ <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
</listitem>
</itemizedlist>
- <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
- Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
- mod_fastcgi nicht mehr explizit eingegangen.</para>
-
<para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
verwendet.</para>
<Directory /path/to/kivitendo-erp>
AllowOverride All
Options ExecCGI Includes FollowSymlinks
- Order Allow,Deny
- Allow from All
+ Require all granted
</Directory>
<DirectoryMatch /path/to/kivitendo-erp/users>
- Order Deny,Allow
- Deny from All
+Require all denied
</DirectoryMatch></programlisting>
<para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
</sect3>
</sect2>
+ <sect2>
+ <title>Authentifizierung mittels HTTP Basic Authentication</title>
+
+ <para>
+ Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
+ (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
+ mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
+ <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
+ folgende Konfigurationsoption aktiviert werden:
+ </para>
+
+ <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
+ </sect2>
+
<sect2>
<title>Weitergehende Konfiguration</title>
Servers integriert werden muss, damit er automatisch gestartet wird.
Dies kann kivitendo nicht für Sie erledigen.</para>
- <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
+ <para>Da der Task-Server als Perlscript läuft, wird Arbeitsspeicher, der
einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
- solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
- laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
- beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
- regelmässigen Abständen neu gestartet wird.</para>
+ solange der Task-Server läuft. Dies kann dazu führen, dass ein länger
+ laufender Task-Server mit der Zeit immer mehr Arbeitsspeicher für sich
+ beansprucht. Es ist deshalb sinnvoll, dass der Task-Server in
+ regelmässigen Abständen neu gestartet wird. Allerdings berücksichtigt der
+ Task-Server ein Memory-Limit, wenn dieses in der Konfigurationsdatei
+ angegeben ist. Bei Überschreiten dieses Limits beendet sich der
+ Task-Server. Sofern der Task-Server als systemd-Service mit dem
+ mitgelieferten Skript eingerichtet wurde, startet dieser danach
+ automatisch erneut.</para>
<sect2 id="Konfiguration-des-Task-Servers">
<title>Verfügbare und notwendige Konfigurationsoptionen</title>
<sect3>
<title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
- OpenSUSE, ältere Fedora)</title>
+ openSUSE, ältere Fedora)</title>
<para>Kopieren Sie die Datei
<filename>scripts/boot/system-v/kivitendo-task-server</filename>
</listitem>
<listitem>
- <para>Ältere OpenSUSE und ältere Fedora:</para>
+ <para>Ältere openSUSE und ältere Fedora:</para>
<programlisting>chkconfig --add kivitendo-task-server</programlisting>
</listitem>
Befehl tun:</para>
<programlisting>systemctl start kivitendo-task-server.service</programlisting>
+
+ <para>Ein so eingerichteter Task-Server startet nach Beendigung
+ automatisch erneut. Das betrifft eine Beendigung über die Oberfläche,
+ eine Beendingung über die Prozesskontrolle und eine Beendigung bei
+ Überschreiten des Memory-Limits. Soll der Task-Server nicht erneut
+ starten, so können Sie ihn mit folgendem Befehl stoppen:</para>
+
+ <programlisting>systemctl stop kivitendo-task-server.service</programlisting>
+
</sect3>
</sect2>
<listitem>
<para><literal>status</literal> berichtet, ob der Task-Server
läuft.</para>
- </listitem>
+ </listitem>yy
</itemizedlist>
<para>Der Task-Server wechselt beim Starten automatisch in das
<para>Dieselben Optionen können auch für die SystemV-basierenden
Runlevel-Scripte benutzt werden (siehe oben).</para>
+
+ <para>Wurde der Task-Server als systemd-Service eingerichtet (s.o.),
+ so startet dieser nach Beendigung automatisch erneut.</para>
+
</sect2>
- </sect1>
+ <sect2 id="Tasks konfigurieren">
+ <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
+ <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
+ <para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para>
+<programlisting>* * * * *
+┬ ┬ ┬ ┬ ┬
+│ │ │ │ │
+│ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7)
+│ │ │ └────── Monat (1-12)
+│ │ └──────── Tag (1-31)
+│ └────────── Stunde (0-23)
+└──────────── Minute (0-59) </programlisting>
+ <para>Die Sterne können folgende Werte haben:</para>
+ <programlisting>
+1 2 3 4 5
+
+1 = Minute (0-59)
+2 = Stunde (0-23)
+3 = Tag (0-31)
+4 = Monat (1-12)
+5 = Wochentag (0-7, Sonntag ist 0 oder 7)
+</programlisting>
+<para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
+<programlisting>59 23 31 12 *</programlisting>
+ </listitem>
+ <listitem>
+ <para><literal>Daten:</literal>In diesem Feld können optionale Parameter für den Hintergrund im JSON-Format gesetzt werden. Der Hintergrund-Job <literal>SetNumberRange</literal> akzeptiert zwei Variable nämlich <literal>digit_year</literal> sowieso <literal>multiplier</literal>.</para><para> <literal>digit_year</literal> kann zwei Werte haben entweder 2 oder 4, darüber wird gesteuert ob die Jahreszahl zwei oder vierstellig kodiert wird (für 2019, dann entweder 19 oder 2019). Der Standardwert ist vierstellig.</para><para> <literal>multiplier</literal> ist ein Vielfaches von 10, darüber wird die erste Nummer im Nummernkreis (die Anzahl der Stellen) wie folgt bestimmt:</para>
+<programlisting>
+multiplier Nummernkreis 2020
+10 -> 20200
+100 -> 202000
+1000 -> 2020000
+</programlisting>
+<para>Wir gehen jetzt beispielhaft von einer letzten Rechnungsnummer von RE2019456 aus. Demnach sollte ab Januar 2020 die erste Nummer RE2020001 sein. Da der Task auch Präfixe berücksichtigt, kann dies mit folgenden JSON-kodierten Werten umgesetzt werden:</para>
+<literal>Daten:</literal><programlisting>multiplier: 100
+digits_year: 4</programlisting>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ </sect1>
<sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
<title>Benutzerauthentifizierung und Administratorpasswort</title>
Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
abgelegt werden.</para>
- <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
- entweder gegen die Authentifizierungsdatenbank oder gegen einen
- LDAP-Server überprüft werden.</para>
+ <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder
+ mehrere LDAP-Server überprüft werden.</para>
<para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
<title>Passwortüberprüfung</title>
<para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
- die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
+ die Authentifizierungsdatenbank und gegen externe LDAP- oder
Active-Directory-Server. Welche davon benutzt wird, regelt der
Parameter <varname>module</varname> im Abschnitt
<varname>[authentication]</varname>.</para>
- <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
- gespeichert werden, so muss der Parameter <varname>module</varname>
- den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
- der Administrator als auch die Benutzer selber ihre Passwörter in
- kivitendo ändern.</para>
+ <para>Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es
+ können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung
+ eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver
+ nicht erreichbar ist.</para>
+
+ <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank geprüft werden, so muss der Parameter
+ <varname>module</varname> das Modul <literal>DB</literal> enthalten. Sofern das Modul in der Liste enthalten ist, egal an welcher
+ Position, können sowohl der Administrator als auch die Benutzer selber ihre Passwörter in kivitendo ändern.</para>
+
+ <para>Wenn Passwörter gegen einen oder mehrere externe LDAP- oder Active-Directory-Server geprüft werden, so muss der Parameter
+ <varname>module</varname> den Wert <literal>LDAP</literal> enthalten. In diesem Fall müssen zusätzliche Informationen über den
+ LDAP-Server im Abschnitt <literal>[authentication/ldap]</literal> angegeben werden. Das Modul kann auch mehrfach angegeben werden,
+ wobei jedes Modul eine eigene Konfiguration bekommen sollte. Der Name der Konfiguration wird dabei mit einem Doppelpunkt getrennt an
+ den Modulnamen angehängt (<literal>LDAP:Name-der-Konfiguration</literal>). Der entsprechende Abschnitt in der Konfigurationsdatei
+ lautet dann <literal>[authentication/Name-der-Konfiguration]</literal>.</para>
- <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
- benutzt werden, so muss der Parameter <varname>module</varname> auf
- <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
- zusätzliche Informationen über den LDAP-Server im Abschnitt
- <literal>[authentication/ldap]</literal> angegeben werden:</para>
+ <para>Die verfügbaren Parameter für die LDAP-Konfiguration lauten:</para>
<variablelist>
<varlistentry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal>verify</literal></term>
+
+ <listitem>
+ <para>Wenn Verbindungsverschlüsselung gewünscht und der Parameter <parameter>tls</parameter> gesetzt ist, so gibt dieser
+ Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind <literal>require</literal> (Zertifikat
+ wird überprüft und muss gültig sei; dies ist der Standard) und <literal>none</literal> (Zertifikat wird nicht
+ überpfüft).</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><literal>attribute</literal></term>
also ‘<literal>Martin Mustermann</literal>’.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><literal>timeout</literal></term>
+
+ <listitem>
+ <para>Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</sect2>
einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
debianoiden Betriebssystemen installiert man die Pakete mit:</para>
- <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
- texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
+ <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
+ texlive-latex-extra texlive-lang-german texlive-generic-extra texlive-xetex ghostscript</programlisting></para>
<para>Für Fedora benötigen Sie die folgenden Pakete:</para>
<para>Die zeitliche und periodische Überprüfung, ob eine
wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
- durch den <link linkend="config.task-server">Taskserver</link>, einen
+ durch den <link linkend="config.task-server">Task-Server</link>, einen
externen Dienst, der automatisch beim Start des Servers gestartet
werden sollte.</para>
</sect2>
<para>Will man im laufenden Monat eine monatlich wiederkehrende
Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
- auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
+ auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
generiert hat. Alternativ setzt man das Startdatum auf den
Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
</sect2>
</sect1>
+ <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
+ <title>Programmatische API-Aufrufe</title>
+
+ <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
+ <title>Einführung</title>
+
+ <para>
+ Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
+ Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
+ oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
+ übergeben werden.
+ </para>
+ </sect2>
+
+ <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
+ <title>Wahl des Mandanten</title>
+
+ <para>
+ Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
+ muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
+ übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
+ </para>
+
+ <para>
+ Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
+ keinen solchen, kommt es zu einer Fehlermeldung.
+ </para>
+ </sect2>
+
+ <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
+ <title>HTTP-»Basic«-Authentifizierung</title>
+
+ <para>
+ Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
+ url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
+ Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
+ </para>
+
+ <para>
+ Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
+ dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
+ </para>
+
+ <para>
+ Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
+ erfolgen.
+ </para>
+ </sect2>
+
+ <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
+ <title>Authentifizierung mit Parametern</title>
+
+ <para>
+ Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
+ <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
+ Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
+ </para>
+
+ <para>
+ Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
+ erfolgen.
+ </para>
+
+ <note>
+ <para>
+ Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
+ </para>
+ </note>
+ </sect2>
+
+ <sect2 id="dev-programmatic-api-calls.examples">
+ <title>Beispiele</title>
+
+ <para>
+ Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
+ Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
+ </para>
+
+ <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
+ 'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'</programlisting>
+ </sect2>
+ </sect1>
+
<sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
<title>SQL-Upgradedateien</title>
angegeben werden. Der hier angegebene Benutzer muss weiterhin das
Recht haben, Datenbanken anzulegen und zu löschen.</para>
- <para>Der so angegebene Benutzer muss nicht zwingend über Super-User-Rechte verfügen. Allerdings gibt es einige Datenbank-Upgrades,
- die genau diese Rechte benötigen. Für den Fall kann man in diesem Konfigurationsabschnitt einen weiteren Benutzeraccount angeben,
- der dann über Super-User-Rechte verfügt, und mit dem die betroffenen Upgrades durchgeführt werden. In der
- Beispiel-Konfigurationsdatei finden Sie die benötigten Parameter.</para>
-
+ <para>Der so angegebene Benutzer muss nicht zwingend über
+ Super-User-Rechte verfügen. Allerdings gibt es einige
+ Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
+ kann man in diesem Konfigurationsabschnitt einen weiteren
+ Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
+ mit dem die betroffenen Upgrades durchgeführt werden. In der
+ Beispiel-Konfigurationsdatei finden Sie die benötigten
+ Parameter.</para>
</sect2>
<sect2 id="devel.testsuite.execution">
projects / kivitendo-erp.git / blobdiff