Projekt

Allgemein

Profil

Herunterladen (359 KB) Statistiken
| Zweig: | Markierung: | Revision:

kivitendo/doc/dokumentation.xml @ fa1bb834

<?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">
<book id="kivitendo-documentation" lang="de">
<title>kivitendo 3.7.0: Installation, Konfiguration,
Entwicklung</title>

<chapter id="Aktuelle-Hinweise">
<title>Aktuelle Hinweise</title>

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

<itemizedlist>
<listitem>
<para>im Community-Forum: <ulink
url="https://forum.kivitendo.de">https://forum.kivitendo.de</ulink></para>
</listitem>

<listitem>
<para>im Kunden-Forum: <ulink
url="https://www.kivitendo.de/redmine/projects/forum/boards/">https://www.kivitendo.de/redmine/projects/forum/boards/</ulink></para>
</listitem>

<listitem>
<para>in der doc/UPGRADE Datei im doc-Verzeichnis der
Installation</para>
</listitem>

<listitem>
<para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
kivitendo-Partner: <ulink
url="https://www.kivitendo.de/partner.html">https://www.kivitendo.de/partner.html</ulink></para>
</listitem>
</itemizedlist>
</chapter>

<chapter id="config">
<title>Installation und Grundkonfiguration</title>

<sect1 id="Installation-Übersicht">
<title>Übersicht</title>

<para>Die Installation von kivitendo umfasst mehrere Schritte. Die
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>
<listitem>
<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>

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

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

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

<listitem>
<para><emphasis>Benutzer, Gruppen und Datenbanken
anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
</listitem>

<listitem>
<para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
</listitem>
</orderedlist>

<para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
werden.</para>
</sect1>

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

<sect2 id="Betriebssystem">
<title>Betriebssystem</title>

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

<para>Mitte 2020 (ab Version 3.5.6) empfehlen wir:</para>

<itemizedlist>
<listitem>
<para>Debian</para>

<itemizedlist>
<listitem>
<para>10.0 "Buster"</para>
</listitem>
<listitem>
<para>11.0 "Bullseye"</para>
</listitem>
</itemizedlist>
</listitem>

<listitem>
<para>20.04 "Focal Fossa" LTS
</para>
</listitem>

<listitem>
<para>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</para>
</listitem>

<listitem>
<para>Fedora 29</para>
</listitem>
</itemizedlist>
</sect2>

<sect2 id="Pakete" xreflabel="Pakete">
<title>Benötigte Perl-Pakete installieren</title>

<para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
Version (s.a. Liste der unterstützten Betriebssysteme)
benötigt.</para>

<para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
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>
<listitem>
<para><literal>Algorithm::CheckDigits</literal></para>
</listitem>

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

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

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

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

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

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

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

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

<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
linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
</listitem>

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

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

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

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

<listitem>
<para><literal>Imager</literal></para>
</listitem>

<listitem>
<para><literal>Imager::QRCode</literal></para>
</listitem>

<listitem>
<para><literal>IPC::Run</literal></para>
</listitem>

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

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

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

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

<listitem>
<para>LWP::UserAgent</para>
</listitem>

<listitem>
<para><literal>Net::SMTP::SSL</literal> (optional, bei
E-Mail-Versand über SSL; siehe Abschnitt "<xref
linkend="config.sending-email.smtp"/>")</para>
</listitem>

<listitem>
<para><literal>Net::SSLGlue</literal> (optional, bei
E-Mail-Versand über TLS; siehe Abschnitt "<xref
linkend="config.sending-email.smtp"/>")</para>
</listitem>

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

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

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

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

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

<listitem>
<para><literal>Rest::Client</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>Set::Infinite</literal></para>
</listitem>

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

<listitem>
<para><literal>Sort::Naturally</literal></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>Text::Unidecode</literal></para>
</listitem>

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

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

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

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

<listitem>
<para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
</listitem>
</itemizedlist>


<para>In der Version v3.7.0 sind keine neuen Pakete hinzugekommen.</para>

<para>Seit Version größer v3.6.0 sind die folgenden Pakete hinzugekommen: <literal>IPC::Run</literal></para>

<para>Seit Version größer v3.5.8 sind die folgenden Pakete hinzugekommen: <literal>Imager</literal>, <literal>Imager::QRCode</literal>
<literal>Rest::Client</literal><literal>Term::ReadLine::Gnu</literal></para>

<para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>Try::Tiny</literal>, <literal>Math::Round</literal></para>
<para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>XML::LibXML</literal>, <literal>CAM::PDF</literal></para>
<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</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>

<para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
<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>,
<literal>Net::SSLGlue</literal>.</para>

<para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
hinzugekommen, <literal>URI</literal> und
<literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
nicht.</para>

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

<sect3>
<title>Debian und Ubuntu</title>
<para>Für Debian und Ubuntu stehen die meisten der benötigten
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 \
libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
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 \
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 \
postgresql-contrib 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 libcam-pdf-perl \
libxml-libxml-perl libtry-tiny-perl libmath-round-perl \
libimager-perl libimager-qrcode-perl librest-client-perl libipc-run-perl
</programlisting>

<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>
</sect3>

<sect3>
<title>Fedora</title>

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

<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-libwww-perl</programlisting>
</sect3>

<sect3>
<title>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</title>

<para>Für openSUSE Leap 15.x stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
<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>
<para>Dazu geben wir folgenden Befehl ein:</para>
<programlisting>zypper addrepo -f \
http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.2/ \
"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.2 unterstützt. Die SuSE Macher haben ab Version 15.x einen großen Umbau in der Verwaltung der Pakete vorgenommen, das heißt, der Paketumfang ist der SLES 15 als Programmunterbau angepasst. Dies gilt besonders der openSUSE Distribution. Es gibt ja einmal die openSUSE Distri und die Professionelle SLES Version. Dadurch sind viele Pakete aus dem ursprünglich nur für die openSUSE geltenen Repositorie enfernt worden, aber auch viele auf aktuellem Stand gehalten.</para>
</note>
<para>Ab openSUSE Leap 15.x kann man die Distribution auch als reine Text Version, also ohne KDE Oberfläche aufsetzen. Vorteil hierbei ist, dass weniger Balast und unnötige Pakte installiert werden.</para>
<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>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>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>
<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>

<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 platzieren, 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 anwenden:</para>

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

<itemizedlist>
<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 postgresql-contrib poppler-utils</programlisting></para>
<para>Fedora: <programlisting>dnf install poppler-utils postgresql-contrib</programlisting></para>
<para>openSUSE: <programlisting>zypper install poppler-tools</programlisting></para>
</sect2>
</sect1>

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

<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-*.tgz</programlisting>

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

<programlisting>cd kivitendo-erp</programlisting>

<para>Alternativ können Sie auch einen Alias in der
Webserverkonfiguration benutzen, um auf das tatsächliche
Installationsverzeichnis zu verweisen.</para>

<para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
WebDAV Verzeichnis derzeit manuell angelegt werden:</para>

<programlisting>mkdir webdav</programlisting>

<para>Die Verzeichnisse <filename>users</filename>,
<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
<constant>apache</constant> oder bei openSUSE
<constant>wwwrun</constant>).</para>

<para>Der folgende Befehl ändert den Besitzer für die oben genannten
Verzeichnisse auf einem Debian/Ubuntu-System:</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>

<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
die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
git clone https://github.com/kivitendo/kivitendo-erp.git
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 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>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
3.4.1 nach 3.5: <programlisting>
$ git clone https://github.com/kivitendo/kivitendo-erp.git
$ cd kivitendo-erp/
$ git checkout release-3.4.1 # das ist ein alter release aus dem wir starten ...
$ 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"

[meine_aenderungen 1d89e41] juhu tolle ändernungen
4 files changed, 380 insertions(+)
create mode 100644 templates/mein_druck/img/webdav/tesla.png
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 ...
# webserver abschalten!

$ 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 ...
Wende an: juhu tolle änderungen
$ service apache2 restart # webserver starten!
</programlisting></para>
</note>
</sect1>

<sect1 id="config.config-file">
<title>kivitendo-Konfigurationsdatei</title>

<sect2 id="config.config-file.introduction"
xreflabel="Einführung in die Konfigurationsdatei">
<title>Einführung</title>

<para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
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
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
der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
Abschnitte und Werte enthalten, die von denen der Default-Datei
abweichen.</para>

<note>
<para>Vor der Umbenennung in kivitendo hieß diese Datei noch
<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>
</note>

<para>Diese Hauptkonfigurationsdatei ist dann eine
installationsspezifische Datei, d.h. sie enthält bspw. lokale
Passwörter und wird auch nicht im Versionsmanagement (git)
verwaltet.</para>

<para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
Mandaten, bzw. Datenbanken gleich.</para>
</sect2>

<sect2 id="config.config-file.sections-parameters">
<title>Abschnitte und Parameter</title>

<para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
entsprechend kommentiert sind:</para>

<itemizedlist>
<listitem>
<para><literal>authentication</literal> (siehe Abschnitt "<xref
linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
in diesem Kapitel)</para>
</listitem>

<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>paths</literal></para>
</listitem>

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

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

<listitem>
<para><literal>environment</literal></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>self_tests</literal></para>
</listitem>

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

<listitem>
<para><literal>testing</literal></para>
</listitem>

<listitem>
<para><literal>testing/database</literal></para>
</listitem>

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

<para>Die üblicherweise wichtigsten Parameter, die am Anfang
einzustellen oder zu kontrollieren sind, sind:</para>

<programlisting>[authentication]
admin_password = geheim

[authentication/database]
host = localhost
port = 5432
db = kivitendo_auth
user = postgres
password =

[system]
default_manager = german</programlisting>

<para>Für kivitendo Installationen in der Schweiz sollte hier
<varname>german</varname> durch <varname>swiss</varname> ersetzt
werden.</para>

<para>Die Einstellung <varname>default_manager = swiss</varname>
bewirkt:</para>

<itemizedlist>
<listitem>
<para>Beim Erstellen einer neuen Datenbank in der kivitendo
Administration werden automatisch die Standard-Werte für die
Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
(die Werte können aber manuell angepasst werden).</para>
</listitem>

<listitem>
<para>Einstellen der Standardkonten für Rundungserträge und
-aufwendungen (unter Mandantenkonfiguration → Standardkonten
veränderbar)</para>
</listitem>

<listitem>
<para>das verwendete Zahlenformat wird auf
<varname>1'000.00</varname> eingestellt (unter Programm →
Benutzereinstellungen veränderbar)</para>
</listitem>

<listitem>
<para>DATEV-Automatik und UStVA werden nicht angezeigt,
Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
Features veränderbar)</para>
</listitem>
</itemizedlist>

<para>Nutzt man wiederkehrende Rechnungen, kann man unter
<varname>[periodic_invoices]</varname> den Login eines Benutzers
angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
mit Informationen über die erstellten Rechnungen bekommt.</para>

<para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
Ausführung bestimmter Aufgaben mit, den <link
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
daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
<link linkend="config.task-server">Task-Server</link> genauer
beschrieben.</para>

<para>Für Entwickler finden sich unter <varname>[debug]</varname>
wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
</sect2>

<sect2 id="config.config-file.prior-versions">
<title>Versionen vor 2.6.3</title>

<para>In älteren kivitendo Versionen gab es im Verzeichnis
<filename>config</filename> die Dateien
<filename>authentication.pl</filename> und
<filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>

<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
manuell übertragen und die alten Konfigurationsdateien anschließend
gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
entsprechende Fehlermeldung an.</para>
</sect2>
</sect1>

<sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
<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>

<para>kivitendo setzt zwingend voraus, dass die Datenbank
Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
Serverinstallationen braucht man hier meist nicht einzugreifen.</para>

<para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>

<programlisting>su postgres
echo '\l' | psql
exit </programlisting>

<para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
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
Versionsnummer angepasst werden.</para>

<para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>

<para>Das Encoding einer Datenbank kann in <command>psql</command> mit
<literal>\l</literal> geprüft werden.</para>
</sect2>

<sect2 id="Änderungen-an-Konfigurationsdateien">
<title>Änderungen an Konfigurationsdateien</title>

<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,
dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
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
Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
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
sein sollte, müssen die Berechtigungen für den Zugriff geändert
werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
nötigen Verbindungen immer zuzulassen, für eine lokal laufende
Datenbank zum Beispiel:</para>

<programlisting>local all kivitendo password
host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
</sect2>

<sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
<title>Erweiterung für servergespeicherte Prozeduren</title>

<para>In der Datenbank <literal>template1</literal> muss die
Unterstützung für servergespeicherte Prozeduren eingerichet werden.
Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
<programlisting>su - postgres
psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>

<programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
\q</programlisting>

<note>
<para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
anzulegen. In diesen Versionen ist die Extension meist auch schon
vorhanden. Sollten Sie eine ältere Version von Postgres haben,
benutzen Sie stattdessen den folgenden Befehl.</para>

<programlisting>CREATE LANGUAGE 'plpgsql';
\q</programlisting>
</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>

<para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
können:</para>

<para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
generieren nicht nötig.</para>

<programlisting>su - postgres
createuser -d -P kivitendo
exit</programlisting>

<para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
bzw. den hier gewählten Benutzernamen.</para>
</sect2>
</sect1>

<sect1 id="Apache-Konfiguration">
<title>Webserver-Konfiguration</title>

<sect2>
<title>Grundkonfiguration mittels CGI</title>

<note>
<para>Für einen deutlichen Performanceschub sorgt die Ausführung
mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
<xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
</note>

<para>Der Zugriff auf das Programmverzeichnis muss in der Apache
Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
anderen Datei hinzu, die beim Starten des Webservers eingelesen
wird:</para>

<programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
Alias /kivitendo-erp/ /var/www/kivitendo-erp/

&lt;Directory /var/www/kivitendo-erp&gt;
AddHandler cgi-script .pl
Options ExecCGI Includes FollowSymlinks
&lt;/Directory&gt;

&lt;Directory /var/www/kivitendo-erp/users&gt;
Require all granted
&lt;/Directory&gt;</programlisting>

<para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
das kivitendo-Archiv entpacket haben.</para>

<note>
<para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
Plus ‘<literal>+</literal>’ gesetzt werden.</para>

<para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
aktiviert werden.</para>
</note>

<para>Auf einigen Webservern werden manchmal die Grafiken und
Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>

<programlisting>EnableSendfile Off</programlisting>
</sect2>

<sect2 id="Apache-Konfiguration.FCGI"
xreflabel="Konfiguration für FastCGI/FCGI">
<title>Konfiguration für FastCGI/FCGI</title>

<sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
<title>Was ist FastCGI?</title>

<para>Direkt aus <ulink
url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
kopiert:</para>

<para><citation> FastCGI ist ein Standard für die Einbindung
externer Software zur Generierung dynamischer Webseiten in einem
Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
(CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
umgehen. </citation></para>
</sect3>

<sect3 id="Apache-Konfiguration.FCGI.Warum">
<title>Warum FastCGI?</title>

<para>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 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 kivitendo Aufruf der Kernmasken mittlerweile
deutlich länger dauert als früher, und dass davon 90% für das Laden
der Module verwendet wird.</para>

<para>Mit FastCGI werden nun die Module einmal geladen, und danach
wird nur die eigentliche Programmlogik ausgeführt.</para>
</sect3>

<sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
<title>Getestete Kombinationen aus Webservern und Plugin</title>

<para>Folgende Kombinationen sind getestet:</para>

<itemizedlist>
<listitem>
<para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
</listitem>
<listitem>
<para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
</listitem>
<listitem>
<para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
</listitem>
<listitem>
<para>Apache 2.4.41 (Ubuntu 20.04 LTS) und mod_fcgid</para>
</listitem>

</itemizedlist>

<para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
verwendet.</para>

<warning>
<para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
strict in der Behandlung von Unicode, und verweigern bestimmte
Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
Installation gibt, muss zwingend Version 0.68 oder aber Version
0.72 und neuer eingesetzt werden.</para>

<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>
</warning>
</sect3>

<sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
<title>Konfiguration des Webservers</title>

<para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
laufen zu lassen, empfiehlt 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
Installation schon funktionieren, lesen Sie weiter.</para>

<para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>

<programlisting>a2enmod fcgid</programlisting>

<para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
und <function>Directory</function>-Direktiven. Dabei wird zwischen
dem Installationspfad von kivitendo im Dateisystem
("<filename>/path/to/kivitendo-erp</filename>") und der URL
unterschieden, unter der kivitendo im Webbrowser erreichbar ist
("<filename>/url/for/kivitendo-erp</filename>").</para>

<para>Folgender Konfigurationsschnipsel funktioniert mit
mod_fastcgi:</para>

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

&lt;Directory /path/to/kivitendo-erp&gt;
AllowOverride All
Options ExecCGI Includes FollowSymlinks
Require all granted
&lt;/Directory&gt;

&lt;DirectoryMatch /path/to/kivitendo-erp/users&gt;
Require all denied
&lt;/DirectoryMatch&gt;</programlisting>

<warning>
<para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
muss entsprechend die Syntax der Directorydirektiven verändert.
Statt</para>

<programlisting>Require all granted</programlisting>

<para>muß man Folgendes einstellen:</para>

<programlisting>
Order Allow,Deny
Allow from All </programlisting>

<para>und statt</para>

<programlisting>Require all denied</programlisting>

<para>muss stehen:</para>

<programlisting>
Order Deny,Allow
Deny from All </programlisting>
</warning>

<para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
die maximale Größe eines Requests. Diese sollte wie folgt
hochgesetzt werden:</para>

<programlisting>FcgidMaxRequestLen 10485760</programlisting>

<para>Das Ganze sollte dann so aussehen:</para>

<programlisting>AddHandler fcgid-script .fpl
AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
FcgidMaxRequestLen 10485760

&lt;Directory /path/to/kivitendo-erp&gt;
AllowOverride All
Options ExecCGI Includes FollowSymlinks
Require all granted
&lt;/Directory&gt;

&lt;DirectoryMatch /path/to/kivitendo-erp/users&gt;
Require all denied
&lt;/DirectoryMatch&gt;</programlisting>

<para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
gibt es hier kleine Performance-Einbußen.</para>

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

<programlisting># Zugriff über CGI
Alias /url/for/kivitendo-erp /path/to/kivitendo-erp

# Zugriff mit mod_fcgid:
AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>

<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>
</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>Aktivierung von mod_rewrite/directory_match für git basierte Installationen</title>

<para>
Aufgrund von aktuellen (Mitte 2020) Sicherheitswarnungen für git basierte Webanwendungen ist die mitausgelieferte .htaccess
restriktiver geworden und verhindert somit das Auslesen von git basierten Daten.
Für debian/ubuntu muss das Modul mod_rewrite einmalig so aktiviert werden:
<programlisting>a2enmod rewrite</programlisting>
Alternativ und für Installationen ohne Apache ist folgender Artikel interessant:
<ulink url="https://www.cyberscan.io/blog/git-luecke">git-lücke</ulink>.
Anstelle des dort beschriebenen DirectoryMatch für Apache2 würden wir etwas weitergehend auch noch das Verzeichnis config miteinbeziehen
sowie ferner auch die Möglichkeit nicht ausschließen, dass es in Unterverzeichnissen auch noch .git Repositories geben kann.
Die Empfehlung für Apache 2.4 wäre damit:
<programlisting>
&lt;DirectoryMatch "/(\.git|config)/"&gt;
Require all denied
&lt;/DirectoryMatch&gt;</programlisting>
</para>
</sect2>


<sect2>
<title>Weitergehende Konfiguration</title>

<para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
von kivitendo nur über https-verschlüsselten Verbindungen, sowie
weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
(Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
SSL-Konfigurations-Generator</ulink>.</para>
</sect2>
<sect2>
<title>Aktivierung von Apache2 modsecurity</title>

<para>Aufgrund des OpenSource Charakters ist kivitendo nicht "out of the box" sicher.
Organisatorisch empfehlen wir hier die enge Zusammenarbeit mit einem kivitendo Partner der auch in der
Lage ist weiterführende Fragen in Bezug auf Datenschutz und Datensicherheit zu beantworten.
Unabhängig davon empfehlen wir im Webserver Bereich die Aktivierung und Konfiguration des Moduls modsecurity für den Apache2, damit
XSS und SQL-Injections verhindert werden.</para>
<para> Als Idee hierfür sei dieser Blog-Eintrag genannt:
<ulink url="https://doxsec.wordpress.com/2017/06/11/using-modsecurity-web-application-firewall-to-prevent-sql-injection-and-xss-using-blocking-rules/">
Test Apache2 modsecurity for SQL Injection</ulink>.</para>
</sect2>

</sect1>

<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 diese zu
festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
essenzielle Aufgaben benutzt.</para>

<para>Der Task-Server muss einmalig global in der Konfigurationsdatei
konfiguriert werden. Danach wird er für jeden Mandanten, für den er
laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>

<para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
Servers integriert werden muss, damit er automatisch gestartet wird.
Dies kann kivitendo nicht für Sie erledigen.</para>

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

<para>Die Konfiguration erfolgt über den Abschnitt
<literal>[task_server]</literal> in der Datei
<filename>config/kivitendo.conf</filename>. Die dort verfügbaren
Optionen sind:</para>

<variablelist>
<varlistentry>
<term><varname>run_as</varname></term>

<listitem>
<para>Wird der Server vom Systembenutzer <literal>root</literal>
gestartet, so wechselt er auf den mit <literal>run_as</literal>
angegebenen Systembenutzer. Der Systembenutzer muss dieselben
Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
(siehe see <xref
linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
ist es erforderlich, hier denselben Systembenutzer einzutragen,
unter dem auch der Webserver läuft.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>debug</varname></term>

<listitem>
<para>Schaltet Debug-Informationen an und aus.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>

<sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
<title>Konfiguration der Mandanten für den Task-Server</title>

<para>Ist der Task-Server grundlegend konfiguriert, so muss
anschließend jeder Mandant, für den der Task-Server laufen soll,
einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
ausgewählt werden, unter der der Task-Server seine Arbeit
verrichtet.</para>

<para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
wird der Task-Server für diesen Mandanten keine Aufgaben
ausführen.</para>
</sect2>

<sect2 id="Einbinden-in-den-Boot-Prozess">
<title>Automatisches Starten des Task-Servers beim Booten</title>

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

<para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
einzubinden. Da das bei neueren Linux-Distributionen aber nicht
zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
anstelle eines symbolischen Links verwendet werden können.</para>

<sect3>
<title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
openSUSE, ältere Fedora)</title>

<para>Kopieren Sie die Datei
<filename>scripts/boot/system-v/kivitendo-task-server</filename>
nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
<literal>DAEMON=....</literal>). Binden Sie das Script in den
Boot-Prozess ein. Dies ist distributionsabhängig:</para>

<itemizedlist>
<listitem>
<para>Debian-basierende Systeme:</para>

<programlisting>update-rc.d kivitendo-task-server defaults
insserv kivitendo-task-server</programlisting>
</listitem>

<listitem>
<para>Ältere openSUSE und ältere Fedora:</para>

<programlisting>chkconfig --add kivitendo-task-server</programlisting>
</listitem>
</itemizedlist>

<para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
werden:</para>

<programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
</sect3>

<sect3>
<title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>

<para>Kopieren Sie die Datei
<filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
<literal>exec ....</literal>).</para>

<para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
werden:</para>

<programlisting>service kivitendo-task-server start</programlisting>
</sect3>

<sect3>
<title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
Fedora, neuere Ubuntu und neuere Debians)</title>

<para>Kopieren Sie die Datei
<filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
kopierten Datei den Pfad zum Task-Server an (Zeilen
<literal>ExecStart=....</literal> und
<literal>ExecStop=...</literal>).</para>

<para>Machen Sie anschließend das Script systemd bekannt, und binden
Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
aus:</para>

<programlisting>systemctl daemon-reload
systemctl enable kivitendo-task-server.service</programlisting>

<para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
den Server neu zu starten, so können Sie das mit dem folgenden
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>

<sect2 id="Prozesskontrolle">
<title>Wie der Task-Server gestartet und beendet wird</title>

<para>Der Task-Server wird wie folgt kontrolliert:</para>

<programlisting>./scripts/task_server.pl Befehl</programlisting>

<para><literal>Befehl</literal> ist dabei eine der folgenden
Optionen:</para>

<itemizedlist>
<listitem>
<para><literal>start</literal> startet eine neue Instanz des
Task-Servers. Die Prozess-ID wird innerhalb des
<filename>users</filename>-Verzeichnisses abgelegt.</para>
</listitem>

<listitem>
<para><literal>stop</literal> beendet einen laufenden
Task-Server.</para>
</listitem>

<listitem>
<para><literal>restart</literal> beendet und startet ihn
neu.</para>
</listitem>

<listitem>
<para><literal>status</literal> berichtet, ob der Task-Server
läuft.</para>
</listitem>
</itemizedlist>

<para>Der Task-Server wechselt beim Starten automatisch in das
kivitendo-Installationsverzeichnis.</para>

<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>
<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>
<para><literal>Daten:</literal></para><programlisting>multiplier: 100
digits_year: 4</programlisting>
</listitem>
</itemizedlist>
</sect2>
</sect1>
<sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
<title>Benutzerauthentifizierung und Administratorpasswort</title>

<para>Informationen über die Einrichtung der Benutzerauthentifizierung,
über die Verwaltung von Gruppen und weitere Einstellungen</para>

<sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
<title>Grundlagen zur Benutzerauthentifizierung</title>

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

<para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
abgelegt 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
Konfigurationsdatei <filename>config/kivitendo.conf</filename>
festgelegt. Diese muss bei der Installation und bei einem Upgrade von
einer Version vor v2.6.0 angelegt werden. Eine
Beispielkonfigurationsdatei
<filename>config/kivitendo.conf.default</filename> existiert, die als
Vorlage benutzt werden kann.</para>
</sect2>

<sect2 id="Administratorpasswort">
<title>Administratorpasswort</title>

<para>Das Passwort, das zum Zugriff auf das Administrationsinterface
von kivitendo benutzt wird, wird ebenfalls in dieser Datei
gespeichert. Es kann auch nur dort und nicht mehr im
Administrationsinterface selber geändert werden. Der Parameter dazu
heißt <varname>admin_password</varname> im Abschnitt
<varname>[authentication]</varname>.</para>
</sect2>

<sect2 id="Authentifizierungsdatenbank">
<title>Authentifizierungsdatenbank</title>

<para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
Parametern in <varname>[authentication/database]</varname>
konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>

<variablelist>
<varlistentry>
<term><literal>host</literal></term>

<listitem>
<para>Der Rechnername oder die IP-Adresse des
Datenbankservers</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>port</literal></term>

<listitem>
<para>Die Portnummer des Datenbankservers, meist 5432</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>db</literal></term>

<listitem>
<para>Der Name der Authentifizierungsdatenbank</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>user</literal></term>

<listitem>
<para>Der Benutzername, mit dem sich kivitendo beim
Datenbankserver anmeldet (z.B.
"<literal>postgres</literal>")</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>password</literal></term>

<listitem>
<para>Das Passwort für den Datenbankbenutzer</para>
</listitem>
</varlistentry>
</variablelist>

<para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
automatisch anlegen (mehr dazu siehe unten).</para>
</sect2>

<sect2 id="Passwortüberprüfung">
<title>Passwortüberprüfung</title>

<para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
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>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>Die verfügbaren Parameter für die LDAP-Konfiguration lauten:</para>

<variablelist>
<varlistentry>
<term><literal>host</literal></term>

<listitem>
<para>Der Rechnername oder die IP-Adresse des LDAP- oder
Active-Directory-Servers. Diese Angabe ist zwingend
erforderlich.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>port</literal></term>

<listitem>
<para>Die Portnummer des LDAP-Servers; meist 389.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>tls</literal></term>

<listitem>
<para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
‘<literal>0</literal>’ belassen</para>
</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>

<listitem>
<para>Das LDAP-Attribut, in dem der Benutzername steht, den der
Benutzer eingegeben hat. Für Active-Directory-Server ist dies
meist ‘<literal>sAMAccountName</literal>’, für andere
LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
zwingend erforderlich.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>base_dn</literal></term>

<listitem>
<para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
Diese Angabe ist zwingend erforderlich.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>filter</literal></term>

<listitem>
<para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
<literal>&lt;%login%&gt;</literal>, so wird dieses durch den vom
Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
der LDAP-Baum nach einem Element durchsucht, bei dem das oben
angegebene Attribut mit dem Benutzernamen identisch ist.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><literal>bind_dn</literal> und
<literal>bind_password</literal></term>

<listitem>
<para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
durchsucht werden kann (z.B. ist dies bei
Active-Directory-Servern der Fall), so kann diese hier angegeben
werden. Für Active-Directory-Server kann als
‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
z.B. ‘<literal>cn=Martin
Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
volle Name des Benutzers eingegeben werden; in diesem Beispiel
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>

<sect2 id="Name-des-Session-Cookies">
<title>Name des Session-Cookies</title>

<para>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 <varname>cookie_name</varname> im Abschnitt
<varname>[authentication]</varname>gesetzt.</para>

<para>Diese Angabe ist optional, wenn nur eine Installation auf dem
Server existiert.</para>
</sect2>

<sect2 id="Anlegen-der-Authentifizierungsdatenbank">
<title>Anlegen der Authentifizierungsdatenbank</title>

<para>Nachdem alle Einstellungen in
<filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
der folgenden URL erreichbar sein sollte:</para>

<para><ulink
url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
</sect2>
</sect1>

<sect1 id="Benutzer--und-Gruppenverwaltung">
<title>Mandanten-, Benutzer- und Gruppenverwaltung</title>

<para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
das Sie unter folgender URL finden:</para>

<para><ulink
url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>

<para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
<filename>config/kivitendo.conf</filename> eingetragen haben.</para>

<sect2 id="Zusammenhänge">
<title>Zusammenhänge</title>

<para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
in einer oder zwei Datenbanken gespeichert werden.</para>

<para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
Diese Informationen werden in der Authentifizierungsdatenbank
gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
gespeichert werden.</para>

<para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
einer solchen Mandantendatenbank werden im Administrationsbereich
konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>

<para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
mehr als einem Mandanten, wird empfohlen, für die
Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
nicht gleichzeitig für einen Mandanten verwendet wird.</para>
</sect2>

<sect2 id="Mandanten-Benutzer-Gruppen">
<title>Mandanten, Benutzer und Gruppen</title>

<para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
die sich frei zueinander zuordnen lassen.</para>

<para>kivitendo kann mehrere Mandaten aus einer Installation heraus
verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
Diese sollte über die <link
linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
geschehen.</para>

<para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
der Administrator fest, an welchen Mandanten sich ein Benutzer
anmelden kann, was beim Login verifiziert wird.</para>

<para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
Administrator gewisse Rechte zugeordnet. Weiterhin legt der
Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
dann an einem Mandanten an, so erhält er alle Rechte von allen
denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
denen der Benutzer zum Anderen Mitglied ist,</para>

<para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>

<orderedlist numeration="arabic">
<listitem>
<para>Datenbank anlegen</para>
</listitem>

<listitem>
<para>Gruppen anlegen</para>
</listitem>

<listitem>
<para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
</listitem>

<listitem>
<para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
</listitem>
</orderedlist>
</sect2>

<sect2 id="Datenbanken-anlegen">
<title>Datenbanken anlegen</title>

<para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
</sect2>

<sect2 id="Gruppen-anlegen">
<title>Gruppen anlegen</title>

<para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
Anlegen können Sie die verschiedenen Bereiche wählen, auf die
Mitglieder dieser Gruppe Zugriff haben sollen.</para>

<para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
A, B und C gültig").</para>

<para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
Gruppen A, B und C").</para>
</sect2>

<sect2 id="Benutzer-anlegen">
<title>Benutzer anlegen</title>

<para>Beim Anlegen von Benutzern werden für viele Parameter
Standardeinstellungen vorgenommen, die den Gepflogenheiten des
deutschen Raumes entsprechen.</para>

<para>Zwingend anzugeben ist der Loginname. Wenn die
Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
deaktiviert.</para>

<para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
sind Benutzer A, B und C Mitglieder").</para>
</sect2>

<sect2 id="Mandanten-anlegen">
<title>Mandanten anlegen</title>

<para>Ein Mandant besteht aus Administrationssicht primär aus einem
eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
einer der eben angelegten Datenbanken eingetragen werden.</para>

<para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
Gruppe ist für Mandanten A, B und C gültig").</para>
</sect2>
</sect1>

<sect1 id="Drucker--Systemverwaltung">
<title>Drucker- und Systemverwaltung</title>

<para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
Druckeradministration und System.</para>

<sect2 id="Druckeradministration">
<title>Druckeradministration</title>

<para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
viele "Druckbefehle" im System verwalten. Diese Befehle werden
mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
angezeigt wird.</para>

<para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
meinDrucker' oder ein kompletter Pfad zu einem Skript
(/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
Ausdruck eines Angebots folgende Vorlage geparst:
sales_quotation_epson_drucker.tex.</para>
</sect2>

<sect2 id="System">
<title>System sperren / entsperren</title>

<para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
gesamten kivitendo Installation gesperrt.</para>

<para>Falls die Sperre gesetzt ist, erscheint anstelle der
Anmeldemaske die Information: 'kivitendo ist momentan zwecks
Wartungsarbeiten nicht zugänglich.'.</para>

<para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
inkonsistenten Datenbestand weitergearbeitet werden.</para>
</sect2>
</sect1>

<sect1 id="config.sending-email"
xreflabel="E-Mail-Versand aus kivitendo heraus">
<title>E-Mail-Versand aus kivitendo heraus</title>

<para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
funktioniert, muss eingestellt werden, über welchen Server die E-Mails
verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
Versand über einen lokalen E-Mail-Server (z.B. mit
<productname>Postfix</productname> oder <productname>Exim</productname>,
was auch die standardmäßig aktive Methode ist) sowie Versand über einen
SMTP-Server (z.B. der des eigenen Internet-Providers).</para>

<para>Welche Methode und welcher Server verwendet werden, wird über die
Konfigurationsdatei <filename>config/kivitendo.conf</filename>
festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
Abschnitt '<literal>[mail_delivery]</literal>'.</para>

<sect2 id="config.sending-email.sendmail"
xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
<title>Versand über lokalen E-Mail-Server</title>

<para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
<productname>Postfix</productname>, <productname>Exim</productname>
oder <productname>Sendmail</productname> läuft.</para>

<para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
'<literal>method = sendmail</literal>' gesetzt sein. Dies ist
gleichzeitig der Standardwert, falls er nicht verändert wird.</para>

<para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
Standardwert verweist auf das Programm
<filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>

<para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
verwiesen.</para>
</sect2>

<sect2 id="config.sending-email.smtp"
xreflabel="E-Mail-Versand über einen SMTP-Server">
<title>Versand über einen SMTP-Server</title>

<para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
ist.</para>

<para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
'<literal>method = smtp</literal>' gesetzt sein. Die folgenden
Parameter dienen dabei der weiteren Konfiguration:</para>

<variablelist>
<varlistentry>
<term><varname>hostname</varname></term>

<listitem>
<para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
'<literal>localhost</literal>'</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>port</varname></term>

<listitem>
<para>Portnummer. Der Standardwert hängt von der verwendeten
Verschlüsselungsmethode ab. Gilt '<literal>security =
none</literal>' oder '<literal>security = tls</literal>', so ist
25 die Standardportnummer. Für '<literal>security =
ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
geändert werden.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>security</varname></term>

<listitem>
<para>Wahl der zu verwendenden Verschlüsselung der Verbindung
mit dem Server. Standardwert ist '<literal>none</literal>',
wodurch keine Verschlüsselung verwendet wird. Mit
'<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
eingeschaltet. Achtung: Für '<literal>tls</literal>' und
'<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
(siehe unten).</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>login</varname> und
<varname>password</varname></term>

<listitem>
<para>Falls der E-Mail-Server eine Authentifizierung verlangt,
so können mit diesen zwei Parametern der Benutzername und das
Passwort angegeben werden. Wird Authentifizierung verwendet, so
sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
aktiviert werden.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>

<sect1 id="Drucken-mit-kivitendo">
<title>Drucken mit kivitendo</title>

<para>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 <literal>texlive</literal> Installation. Unter
debianoiden Betriebssystemen installiert man die Pakete mit:</para>

<para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
texlive-latex-extra texlive-lang-german ghostscript</programlisting></para>

<para>Für Fedora benötigen Sie die folgenden Pakete:</para>

<para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
texlive-collection-latexrecommended texlive-collection-langgerman \
texlive-collection-langenglish</programlisting></para>

<para>Für openSUSE benötigen Sie die folgenden Pakete:</para>

<para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
texlive-collection-latexrecommended texlive-collection-langgerman \
texlive-collection-langenglish</programlisting></para>

<note><para>kivitendo erwartet eine aktuelle TeX Live Umgebung, um PDF/A zu erzeugen. Aktuelle Distributionen von 2020 erfüllen diese. Überprüfbar ist dies mit dem Aufruf des installation_check.pl mit Parameter -l:</para><para><programlisting>scripts/installations_check.pl -l</programlisting></para></note>
<para>kivitendo bringt drei alternative Vorlagensätze mit:</para>

<itemizedlist>
<listitem>
<para>RB</para>
</listitem>
<listitem>
<para>marei</para>
</listitem>
<listitem>
<para>rev-odt</para>
</listitem>
</itemizedlist>

<para>Der ehemalige Druckvorlagensatz "f-tex" wurde mit der Version
3.5.6 entfernt, da er nicht mehr gepflegt wird.</para>

<sect2 id="Vorlagenverzeichnis-anlegen"
xreflabel="Vorlagenverzeichnis anlegen">
<title>Vorlagenverzeichnis anlegen</title>

<para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>

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

<para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
Recht "Konfiguration -&gt; Mandantenverwaltung" verfügt. Siehe auch
<xref linkend="Gruppen-anlegen"/>.</para>

<para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
-&gt; <guisubmenu>Mandantenverwaltung</guisubmenu> -&gt;
<guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>

<orderedlist>
<listitem>
<para><option>Vorlagen auswählen</option>: Wählen Sie hier den
Vorlagensatz aus, der kopiert werden soll
(<filename>RB</filename>, <filename>marei</filename> oder
<filename>odt-rev</filename>.)</para>
</listitem>

<listitem>
<para><option>Neuer Name</option>: Der Verzeichnisname für den
neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
für Verzeichnisnamen frei gewählt werden.</para>
</listitem>
</orderedlist>

<para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
vorgenommen werden. Den Ordner findet man im Dateisystem unter
<filename>./templates/[Neuer Name]</filename></para>
</sect2>

<sect2 id="Vorlagen-RB">
<title>Der Druckvorlagensatz RB</title>

<para>Hierbei handelt es sich um einen vollständigen LaTeX
Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
sind nicht gepflegt.</para>

<para>Die konzeptionelle Idee der Vorlagen wird <ulink
url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
eigenen Firmendaten finden sich in der Datei Readme.tex im
Vorlagenverzeichnis.</para>

<para>Eine kurze Übersicht der Features:</para>

<itemizedlist>
<listitem>
<para>Mehrsprachenfähig, mit Deutscher und Englischer
Übersetzung</para>
</listitem>

<listitem>
<para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
werden, z.B. für Kopf- und Fußzeilen, und Infos wie
Bankdaten</para>
</listitem>

<listitem>
<para>mehrere vordefinierte Varianten für
Logos/Hintergrundbilder</para>
</listitem>

<listitem>
<para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
"Außerhalb EU"</para>
</listitem>
</itemizedlist>
</sect2>

<sect2 id="Vorlagen-rev-odt">
<title>Der Druckvorlagensatz rev-odt</title>

<para>Hierbei handelt es sich um einen Dokumentensatz der mit
odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
Zürich erstellt und werden laufend aktualisiert. Ein paar der
Formulierungen in den Druckvorlagen entsprechen dem Schweizer
Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>

<para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>

<para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
die vom Parser nicht korrekt gelesen werden kann.</para>

<para>Mahnungen können unter folgenden Einschränkungen mit den
odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>

<itemizedlist>
<listitem>
<para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
Verfügung, das heisst, die Mahnungen werden als PDF-Datei
ausgegeben.</para>
</listitem>

<listitem>
<para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
(auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
vorhanden sind).</para>
</listitem>
</itemizedlist>

<para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
PDF-Datei zusammengefasst</para>

<para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
die verrechneten Mahngebühren und Verzugszinsen.</para>

<para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>

<para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
empfang@revamp-it.ch</para>
</sect2>

<sect2 id="allgemeine-hinweise-zu-latex">
<title>Allgemeine Hinweise zu LaTeX Vorlagen</title>

<para>In den allermeisten Installationen sollte das Drucken jetzt
schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
sind zum Beispiel:</para>

<itemizedlist>
<listitem>
<para>! LaTeX Error: File `eurosym.sty' not found. Die
entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
allem bei Vorlagen aus der Community auf. Installieren Sie die
entsprechenden Pakete.</para>
</listitem>

<listitem>
<para>! Package inputenc Error: Unicode char \u8:... set up for
use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
einer Standardinstallation exotische utf8 Zeichen zu drucken.
TeXLive unterstützt von Haus nur romanische Schriften und muss mit
diversen Tricks dazu gebracht werden andere Zeichen zu
akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
Abhilfe.</para>
</listitem>
</itemizedlist>

<para>Wird gar kein Fehler angezeigt, sondern nur der Name des
Templates, heißt das normalerweise, dass das LaTeX Binary nicht
gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
<literal>latexmk --pdflatex</literal>), und stellen Sie sicher, dass
latexmk (oder das von Ihnen verwendete System) vom Webserver ausgeführt
werden darf.</para>

<para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
verifizieren lässt:</para>

<itemizedlist>
<listitem>
<para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
"keep_temp_files" auf 1</para>

<para><programlisting>keep_temp_files = 1;</programlisting></para>
</listitem>

<listitem>
<para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
</listitem>

<listitem>
<para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
</listitem>

<listitem>
<para>wechsel in das users Verzeichnis von kivitendo</para>

<para><programlisting>cd [kivitendo-home]/users</programlisting></para>
</listitem>

<listitem>
<para>LaTeX Suchpfad anpassen:</para>

<para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
</listitem>

<listitem>
<para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
erstellt hat</para>

<para><programlisting>ls -lahtr ./1*.tex</programlisting></para>

<para>Es sollte die letzte Datei ganz unten sein</para>
</listitem>

<listitem>
<para>für besseren Hinweis auf Fehler texdatei nochmals
übersetzen</para>

<para><programlisting>pdflatex ./1*.tex</programlisting></para>

<para>in der *.tex datei nach dem Fehler suchen.</para>
</listitem>
</itemizedlist>
</sect2>
</sect1>

<sect1 id="OpenDocument-Vorlagen">
<title>OpenDocument-Vorlagen</title>

<para>kivitendo unterstützt die Verwendung von Vorlagen im
OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
auch aus diesen direkt PDF-Dateien erzeugen. Nachfolgend ist die
Verwendung mit LibreOffice beschrieben. Für die Verwendung mit
OpenOffice müssen die Einstellungen allenfalls angepasst werden.</para>

<sect2>
<title>Grundeinstellung</title>

<para>Um die Unterstützung von OpenDocument-Vorlagen zu aktivieren,
muss in der Datei <filename>config/kivitendo.conf</filename> die
Variable <literal>opendocument</literal>, im Abschnitt
<literal>print_templates</literal>, auf <literal>1</literal> stehen.
Dies ist die Standardeinstellung.</para>
</sect2>

<sect2>
<title>Direkte Erzeugung von PDF-Dateien</title>

<para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
LibreOffice oder OpenOffice benötigt.</para>

<para>Unter Debian kann dieses installiert werden mit:</para>

<programlisting>apt install libreoffice</programlisting>

<para>Der Pfad zu LibreOffice kann in der Datei
<filename>config/kivitendo.conf</filename>, im Abschnitt
<literal>applications</literal>, angepasst werden. Unter Debian sollte
dies nicht notwendig sein.</para>

<sect3>
<title>Variante 1)</title>

<para>In der Standardeinstellung wird LibreOffice für jedes Dokument
neu gestartet. Es ist keine weitere Konfiguration
erforderlich.</para>
</sect3>

<sect3>
<title>Variante 2)</title>

<para>Die zweite Variante startet ein LibreOffice, das auch nach der
Umwandlung des Dokumentes gestartet bleibt. Bei weiteren
Umwandlungen wird dann diese laufende Instanz benutzt. Der Vorteil
ist, dass die Zeit zur Umwandlung möglicherweise reduziert wird,
weil nicht für jedes Dokument eine neue Instanz gestartet werden
muss.</para>

<para>Dazu muss in der Konfigurationsdatei
<filename>config/kivitendo.conf</filename>, im Abschnitt
<literal>print_templates</literal>, <literal>openofficeorg_daemon =
1</literal> gesetzt werden.</para>

<para>Diese Methode verwendet Python und die Python uno bindings.
Unter Debian werden diese mit LibreOffice mitgeliefert.</para>

<para>Die Optionen <literal>python_uno</literal> und
<literal>python_uno_path</literal> in der Konfigurationsdatei
<filename>config/kivitendo.conf</filename> dienen zur Anpassung der
Python uno Pfade. Unter Debian sollte keine Anpassung notwendig
sein.</para>
</sect3>
</sect2>

<sect2>
<title>Vorbereitungen</title>

<sect3 id="opendocument-druckvorlagen-mit-makros.vorbereitungen">
<title>Adminbereich</title>

<para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
ein Drucker eingerichtet werden:</para>

<itemizedlist>
<listitem>
<para>Druckeradministration → Drucker hinzufügen</para>
</listitem>

<listitem>
<para>Mandant wählen</para>
</listitem>

<listitem>
<para>Druckerbeschreibung → aussagekräftiger Text: wird in der
Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
Einzahlungsschein Bank xy)</para>
</listitem>

<listitem>
<para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
aber nicht leer sein)</para>
</listitem>

<listitem>
<para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
(muss genau der Zeichenfolge entsprechen, die zwischen
"invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
</listitem>

<listitem>
<para>speichern</para>
</listitem>
</itemizedlist>
</sect3>

<sect3>
<title>Benutzereinstellungen</title>

<para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
dies persönlich für sich bei den Benutzereinstellungen
konfigurieren:</para>

<itemizedlist>
<listitem>
<para>Programm → Benutzereinstellungen → Druckoptionen</para>
</listitem>

<listitem>
<para>Standardvorlagenformat → OpenDocument/OASIS</para>
</listitem>

<listitem>
<para>Standardausgabekanal → Bildschirm</para>
</listitem>

<listitem>
<para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
(z.B. mit Einzahlungsschein Bank xy)</para>
</listitem>

<listitem>
<para>Anzahl Kopien → leer</para>
</listitem>

<listitem>
<para>speichern</para>
</listitem>
</itemizedlist>
</sect3>

<sect3>
<title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
odt-Rechnung (analog bei Auftrag)</title>

<para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
den Benutzereinstellungen als persönlicher Standard gewählt
wurde.</para>
</sect3>
</sect2>

<sect2>
<title>Schweizer QR-Rechnung mit OpenDocument Vorlagen</title>

<para>Mit der Version 3.6.0 unterstützt Kivitendo die Erstellung von
Schweizer QR-Rechnungen gemäss <ulink
url="https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-de.pdf">Swiss
Payment Standards, Version 2.2</ulink>. Implementiert sind hierbei die
Varianten:</para>

<itemizedlist>
<listitem>
<para><emphasis role="bold">QR-IBAN mit
QR-Referenz</emphasis></para>
</listitem>

<listitem>
<para><emphasis role="bold">IBAN ohne Referenz</emphasis></para>
</listitem>
</itemizedlist>

<sect3>
<title>Einstellungen</title>

<sect4>
<title>Mandantenkonfiguration</title>

<para>Unter <emphasis>System → Mandantenkonfiguration →
Features</emphasis>. Im Abschnitt <emphasis>Einkauf und
Verkauf</emphasis>, beim Punkt <emphasis>Verkaufsrechnungen mit
Schweizer QR-Rechnung erzeugen</emphasis>, die gewünschte Variante
wählen.</para>
</sect4>

<sect4>
<title>Konfiguration der Bankkonten</title>

<para>Unter <emphasis>System → Bankkonten</emphasis> muss bei
mindestens einem Bankkonto die Option <emphasis>Nutzung mit
Schweizer QR-Rechnung</emphasis> auf <emphasis
role="bold">Ja</emphasis> gestellt werden.</para>

<para>Die IBAN muss ohne Leerzeichen angegeben werden.</para>

<tip>
<para>Für die Variante <emphasis role="bold">QR-IBAN mit
QR-Referenz</emphasis> muss dieses Konto unter IBAN eine gültige
<emphasis role="bold">QR-IBAN Nummer</emphasis> enthalten. Diese
unterscheidet sich von der regulären IBAN.</para>

<para>Zusätzlich muss eine gültige <emphasis role="bold">Bankkonto
Identifikationsnummer</emphasis> angegeben werden
(6-stellig).</para>

<para>Diese werden von der jeweiligen Bank vergeben.</para>
</tip>

<para>Sind mehrere Konten ausgewählt wird das erste
verwendet.</para>
</sect4>

<sect4>
<title>Rechnungen ohne Betrag</title>

<para>Für Rechnungen ohne Betrag (z.B. Spenden) kann, in der
jeweiligen Rechnung, die Checkbox <emphasis>QR-Rechnung ohne
Betrag</emphasis> aktiviert werden. Diese Checkbox erscheint nur,
wenn QR-Rechnungen in der Mandantenkonfiguration aktiviert sind
(variante ausgewählt).</para>

<para>Dies wirkt sich lediglich auf den erzeugten QR-Code aus. Die
Vorlage muss separat angepasst und ausgewählt werden.</para>
</sect4>
</sect3>

<sect3>
<title>Adressdaten</title>

<para>Die Adressdaten zum Zahlungsempfänger werden aus der
Mandantenkonfiguration entnommen. Unter <emphasis>System →
Mandantenkonfiguration → Verschiedenes</emphasis>, Abschnitt
<emphasis>Firmenname und -adresse.</emphasis></para>

<para>Die Adressdaten zum Zahlungspflichtigen stammen aus den
Kundendaten der jeweiligen Rechnung.</para>

<para>Ist bei den Adressdaten kein Land angegeben, wird standardmässig
Schweiz verwendet. Akzeptiert werden Ländername oder Ländercode, also
z.B. "Schweiz" oder "CH".</para>

<para>Die Adressdaten können in der Vorlage mit den jeweiligen
Variablen eingetragen werden. Siehe auch: <xref
linkend="dokumentenvorlagen-und-variablen"/></para>

<para>Der erzeugte QR-Code verwendet Adress-Typ "K" (Kombinierte
Adressfelder, 2 Zeilen).</para>
</sect3>

<sect3>
<title>Referenznummer</title>

<para>Die Referenznummer wird in Kivitendo erzeugt und setzt sich
wiefolgt zusammen:</para>

<itemizedlist>
<listitem>
<para>Bankkonto Identifikationsnummer (6-stellig)</para>
</listitem>

<listitem>
<para>Kundennummer (6-stellig, mit führenden Nullen
aufgefüllt)</para>
</listitem>

<listitem>
<para>Rechnungsnummer (14-stellig, mit führenden Nullen
aufgefüllt)</para>
</listitem>

<listitem>
<para>Prüfziffer (1-stellig, berechnet mittels modulo 10,
rekursiv)</para>
</listitem>
</itemizedlist>

<para>Es sind lediglich Ziffern erlaubt. Allfällige Buchstaben und
Sonderzeichen werden entfernt und fehlende Stellen werden mit
führenden Nullen aufgefüllt.</para>
</sect3>

<sect3>
<title>Vorlage</title>

<para>Der Vorlagensatz "rev-odt" enthält die Vorlage
<literal>invoice_qr.odt</literal>, welche für die Erstellung von
QR-Rechnungen vorgesehen ist. Damit diese verwendet werden kann muss
wie obenstehend beschrieben ein Drucker hinzugefügt werden, allerdings
mit dem Vorlagenkürzel <literal>qr</literal> (siehe <xref
linkend="opendocument-druckvorlagen-mit-makros.vorbereitungen"/>).
Weitere Vorlagen für die QR-Rechnung müssen im Dateinamen, bzw.
Vorlagenkürzel, ebenfalls die Zeichenfolge <literal>qr</literal>
enthalten, also z.b. <literal>invoice_qr2.odt</literal> etc.</para>

<para>Die Vorlagen können beliebig angepasst werden. Zwingend müssen
diese jedoch das QR-Code Platzhalter Bild, als eingebettetes Bild,
enthalten. Da dieses beim Ausdrucken/Erzeugen der Rechnung durch das
neu generierte QR-Code Bild ersetzt wird. Das Bild muss den Namen
<literal>QRCodePlaceholder</literal> tragen. In Libreoffice unter
<emphasis>Bild-Kontextmenü → </emphasis><emphasis>Einstellungen →
Optionen → Name</emphasis> einstellbar. Siehe dazu auch die
Beispielvorlage.</para>

<sect4>
<title>Zusätzliche Variablen für Vorlage</title>

<para>Zusätzlich zu den in der Vorlage standardmässig verfügbaren
Variablen (siehe <xref linkend="dokumentenvorlagen-und-variablen"/>),
werden die folgenden Variablen erzeugt:</para>

<variablelist>
<varlistentry>
<term>ref_number_formatted</term>

<listitem>
<para>Referenznummer formatiert mit Leerzeichen, z.B.: 21 00000
00003 13947 14300 09017</para>
</listitem>
</varlistentry>

<varlistentry>
<term>iban_formatted</term>

<listitem>
<para>IBAN formatiert mit Leerzeichen</para>
</listitem>
</varlistentry>

<varlistentry>
<term>amount_formatted</term>

<listitem>
<para>Betrag formatiert mit Tausendertrennzeichen Leerschlag,
z.B.: 1 005.55</para>
</listitem>
</varlistentry>
</variablelist>
</sect4>
</sect3>
</sect2>
</sect1>

<sect1 id="nomenclature">
<title>Nomenklatur</title>

<sect2 id="booking.dates">
<title>Datum bei Buchungen</title>

<para>Seit der Version 3.5 werden für Buchungen in kivitendo
einheitlich folgende Bezeichnungen verwendet:</para>

<itemizedlist>
<listitem>
<para><option>Erfassungsdatum</option> (en: <option>Entry
Date</option>, code: <option>Gldate</option>)</para>

<para>bezeichnet das Datum, an dem die Buchung in kivitendo
erfasst wurde.</para>
</listitem>

<listitem>
<para><option>Buchungsdatum</option> (en: <option>Booking
Date</option>, code: <option>Transdate</option>)</para>

<para>bezeichnet das buchhaltungstechnisch für eine Buchung
relevante Datum</para>

<para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
Berichten wie dem Buchungsjournal, in denen eine Spalte
<option>Buchungsdatum</option> angezeigt werden kann, erscheint
hier im Fall von Rechnungen das Rechnungsdatum.</para>
</listitem>

<listitem>
<para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>

<para>Möglicherweise wird für solche Fälle in einer späteren
Version von kivitendo ein dritter Datumswert für Buchungen
erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
deshalb später verbucht werden.)</para>
</listitem>
</itemizedlist>
</sect2>
</sect1>

<sect1 id="config.eur">
<title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
EUR</title>

<sect2 id="config.eur.introduction"
xreflabel="Einführung in die Konfiguration zur EUR">
<title>Einführung</title>

<para>kivitendo besaß bis inklusive Version 2.6.3 einen
Konfigurationsparameter namens <varname>eur</varname>, der sich in der
Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
für alle Mandanten, die in dieser Installation benutzt wurden.</para>

<para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
die Mandantendatenbank verschoben und dabei auch gleich in drei
Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
steuern lässt.</para>
</sect2>

<sect2 id="config.eur.parameters"
xreflabel="Konfigurationsparameter für EUR">
<title>Konfigurationsparameter</title>

<para>Es gibt drei Parameter, die die Gewinnermittlungsart,
Versteuerungsart und die Warenbuchungsmethode regeln:</para>

<variablelist>
<varlistentry>
<term><varname>profit_determination</varname></term>

<listitem>
<para>Dieser Parameter legt die Berechnungsmethode für die
Gewinnermittlung fest. Er enthält entweder
<literal>balance</literal> für
Betriebsvermögensvergleich/Bilanzierung oder
<literal>income</literal> für die
Einnahmen-Überschuss-Rechnung.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>accounting_method</varname></term>

<listitem>
<para>Dieser Parameter steuert die Buchungs- und
Berechnungsmethoden für die Versteuerungsart. Er enthält
entweder <literal>accrual</literal> für die Soll-Versteuerung
oder <literal>cash</literal> für die Ist-Versteuerung.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>inventory_system</varname></term>

<listitem>
<para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
enthält entweder <literal>perpetual</literal> für die
Bestandsmethode oder <literal>periodic</literal> für die
Aufwandsmethode.</para>
</listitem>
</varlistentry>
</variablelist>

<para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
<varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
bedeutete hingegen Bilanzierung, Soll-Versteuerung und
Bestandsmethode.</para>

<para>Die Konfiguration "<varname>eur</varname>" unter
<varname>[system]</varname> in der <link
linkend="config.config-file">Konfigurationsdatei</link>
<filename>config/kivitendo.conf</filename> wird nun nicht mehr
benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
</sect2>

<sect2 id="config.eur.setting-parameters">
<title>Festlegen der Parameter</title>
"dokumentation.xml.html#L3260" data-txt="3260">
<para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
automatisch auf die in der Mandantenkonfiguration festgelegten
Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
gebucht.</para>

<para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
verändert.)</para>

<para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
<varname>quototal</varname>, <varname>ordtotal</varname> bzw.
<varname>invtotal</varname> enthalten den gerundeten Betrag.</para>

<para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>

<para>Das heisst, Firmen in der Schweiz, die teilweise
Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
können zur Zeit die 5er Rundung noch nicht nutzen.</para>
</sect1>

<sect1 id="config.client">
<title>Einstellungen pro Mandant</title>

<para>Einige Einstellungen können von einem Benutzer mit dem <link
linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
Die Einstellungen sind unter <guimenu>System</guimenu> →
<guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>

<para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
geändert werden (siehe auch <link
linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
Bestandsmethode</link>).</para>

<para>Die Einstellungen <literal>show_bestbefore</literal> und
<literal>payments_changeable</literal> aus dem Abschnitt
<literal>features</literal> und die Einstellungen im Abschnitt
<literal>datev_check</literal> (sofern schon vorhanden) der <link
linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
bei einem Datenbankupdate einer älteren Version automatisch übernommen.
Diese Einträge können danach aus der Konfigurationsdatei entfernt
werden.</para>
</sect1>

<sect1 id="kivitendo-ERP-verwenden">
<title>kivitendo ERP verwenden</title>

<para>Nach erfolgreicher Installation ist der Loginbildschirm unter
folgender URL erreichbar:</para>

<para><ulink
url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>

<para>Die Administrationsseite erreichen Sie unter:</para>

<para><ulink
url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
</sect1>
</chapter>

<chapter id="features" xreflabel="Features und Funktionen">
<title>Features und Funktionen</title>

<sect1 id="features.periodic-invoices"
xreflabel="Wiederkehrende Rechnungen">
<title>Wiederkehrende Rechnungen</title>

<sect2 id="features.periodic-invoices.introduction"
xreflabel="Einführung in wiederkehrende Rechnungen">
<title>Einführung</title>

<para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
Die konfigurierten Aufträge werden später automatisch in Rechnungen
umgewandelt, so als ob man den Workflow benutzen würde, und auch die
Auftragsnummer wird übernommen, sodass alle wiederkehrenden
Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
wiederzufinden sind.</para>
</sect2>

<sect2 id="features.periodic-invoices.configuration"
xreflabel="Konfiguration von wiederkehrenden Rechnungen">
<title>Konfiguration</title>

<para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
findet sich beim Bearbeiten des Auftrags ein neuer Knopf
"Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
oder nicht.</para>

<para>Folgende Parameter kann man konfigurieren:</para>

<variablelist>
<varlistentry>
<term>Status</term>

<listitem>
<para>Bei aktiven Rechnungen wird automatisch eine Rechnung
erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
eines neuen Monats).</para>

<para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
nächsten Periodenwechsel für alle Perioden, seit der letzten
aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
verhindern, muss man vorher das Startdatum neu setzen.</para>

<para>Für gekündigte Aufträge werden nie mehr Rechnungen
erstellt. Man kann sich diese Aufträge aber gesondert in den
Berichten anzeigen lassen.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>Periodizität</term>

<listitem>
<para>Ob monatlich, quartalsweise oder jährlich auf neue
Rechnungen überprüft werden soll. Für jede Periode seit dem
Startdatum wird überprüft, ob für die Periode (beginnend immer
mit dem ersten Tag der Periode) schon eine Rechnung erstellt
wurde. Unter Umständen können bei einem Startdatum in der
Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>Buchen auf</term>

<listitem>
<para>Das Forderungskonto, in der Regel "Forderungen aus
Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
Buchungsgruppen der betreffenden Waren.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>Startdatum</term>

<listitem>
<para>ab welchem Datum auf Rechnungserstellung geprüft werden
soll</para>
</listitem>
</varlistentry>

<varlistentry>
<term>Enddatum</term>

<listitem>
<para>ab wann keine Rechnungen mehr erstellt werden
sollen</para>
</listitem>
</varlistentry>

<varlistentry>
<term>Automatische Verlängerung um x Monate</term>

<listitem>
<para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
eingetragenen Enddatums weiterhin erstellt werden, so kann man
hier die Anzahl der Monate eingeben, um die das Enddatum
automatisch nach hinten geschoben wird.</para>
</listitem>
"dokumentation.xml.html#L4674" data-txt="4674">
</listitem>
</varlistentry>
</variablelist>

<note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
<para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
Stammdaten nicht eingetragen, so haben die Variablen
<varname>shipto*</varname> den gleichen Wert wie die die
entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
einige <varname>shipto*</varname>-Variablen so nicht in den
Stammdaten wiederfinden sondern schlicht Kopien der
Lieferdatenvariablen sind (z.B.
<varname>shiptocontact</varname>).</para>
</note>
</sect3>

<sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
<title>Informationen über den Bearbeiter</title>

<variablelist>
<varlistentry>
<term><varname>employee_address</varname></term>

<listitem>
<para>Adressfeld</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>employee_businessnumber</varname></term>

<listitem>
<para>Firmennummer</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>employee_company</varname></term>

<listitem>
<para>Firmenname</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>employee_co_ustid</varname></term>

<listitem>
<para>Usatzsteuer-Identifikationsnummer</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>employee_duns</varname></term>

<listitem>
<para>DUNS-Nummer</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>employee_email</varname></term>

<listitem>
<para>Email</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>employee_fax</varname></term>
<varname>salesman_...</varname> zur Verfügung. Werden mehrere
Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
(Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
Ausdruck genommen.</para>

<para>Die Adressdaten des Kunden stehen als Variablen
<varname>name</varname>, <varname>street</varname>,
<varname>zipcode</varname>, <varname>city</varname>,
<varname>country</varname>, <varname>department_1</varname>,
<varname>department_2</varname>, und <varname>email</varname> zur
Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
zu Verfügung, wird allerdings auch nur von der ersten angemahnten
Rechnung (s.o.) genommen.</para>

<para>Weitere Variablen beinhalten:</para>

<variablelist>
<varlistentry>
<term><varname>dunning_date</varname></term>

<listitem>
<para>Datum der Mahnung</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>dunning_duedate</varname></term>

<listitem>
<para>Fälligkeitsdatum für diese Mahhnung</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>dunning_id</varname></term>

<listitem>
<para>Mahnungsnummer</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>fee</varname></term>

<listitem>
<para>Kumulative Mahngebühren</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>interest_rate</varname></term>

<listitem>
<para>Zinssatz per anno in Prozent</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>total_amount</varname></term>

<listitem>
<para>Gesamter noch zu zahlender Betrag als
<function>fee</function> + <function>total_interest</function>
+ <function>total_open_amount</function></para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>total_interest</varname></term>

<listitem>
<para>Zinsen per anno über alle Rechnungen</para>
</listitem>
</varlistentry>

<varlistentry>
<term><varname>total_open_amount</varname></term>

<listitem>
<para>Summe über alle offene Beträge der Rechnungen</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>

<sect3 id="dokumentenvorlagen-und-variabl