2.2. Benötigte Software und Pakete

2.2.1. Betriebssystem

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.

Mitte 2020 (ab Version 3.5.6) empfehlen wir:

  • Debian

    • 10.0 "Buster"

    • 11.0 "Bullseye"

  • 20.04 "Focal Fossa" LTS

  • openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA

  • Fedora 29

2.2.2. Benötigte Perl-Pakete installieren

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.

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:

./scripts/installation_check.pl

Die vollständige Liste der benötigten Perl-Module lautet:

  • Algorithm::CheckDigits

  • Archive::Zip

  • CAM::PDF

  • CGI

  • Clone

  • Config::Std

  • Daemon::Generic

  • DateTime

  • DateTime::Event::Cron

  • DateTime::Format::Strptime

  • DateTime::Set

  • DBI

  • DBD::Pg

  • Digest::SHA

  • Email::Address

  • Email::MIME

  • Exception::Class

  • FCGI (nicht Versionen 0.68 bis 0.71 inklusive; siehe Abschnitt 2.6.2.3, „Getestete Kombinationen aus Webservern und Plugin“)

  • File::Copy::Recursive

  • File::Flock

  • File::MimeInfo

  • File::Slurp

  • GD

  • HTML::Parser

  • HTML::Restrict

  • Image::Info

  • JSON

  • List::MoreUtils

  • List::UtilsBy

  • LWP::Authen::Digest

  • LWP::UserAgent

  • Net::SMTP::SSL (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "E-Mail-Versand über einen SMTP-Server")

  • Net::SSLGlue (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "E-Mail-Versand über einen SMTP-Server")

  • Math::Round

  • Params::Validate

  • PBKDF2::Tiny

  • PDF::API2

  • Regexp::IPv6

  • Rose::Object

  • Rose::DB

  • Rose::DB::Object Version 0.788 oder neuer

  • Set::Infinite

  • String::ShellQuote

  • Sort::Naturally

  • Template

  • Text::CSV_XS

  • Text::Iconv

  • Text::Unidecode

  • Try::Tiny

  • URI

  • XML::Writer

  • XML::LibXML

  • YAML::XS oder YAML

Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: Try::Tiny, Math::Round

Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: XML::LibXML, CAM::PDF

Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: Exception::Class

Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: Set::Infinite, List::UtilsBy, DateTime::Set, DateTime::Event::Cron Daemon::Generic, DateTime::Event::Cron, File::Flock, File::Slurp

Seit Version größer v3.5.0 sind die folgenden Pakete hinzugekommen: Text::Unidecode, LWP::Authen::Digest, LWP::UserAgent

Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen: Algorithm::CheckDigits, PBKDF2::Tiny

Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen: GD, HTML::Restrict, Image::Info

Seit v3.0.0 sind die folgenden Pakete hinzugekommen: File::Copy::Recursive.

Seit v2.7.0 sind die folgenden Pakete hinzugekommen: Email::MIME, Net::SMTP::SSL, Net::SSLGlue.

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

Gegenüber Version 2.6.1 sind parent, DateTime, Rose::Object, Rose::DB und Rose::DB::Object neu hinzugekommen. IO::Wrap wurde entfernt.

Gegenüber Version 2.6.3 ist JSON neu hinzugekommen.

Email::Address und List::MoreUtils 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.

2.2.2.1. Debian und Ubuntu

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:

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

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

[Anmerkung]Anmerkung

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

add-apt-repository universe

2.2.2.2. Fedora

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:

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

2.2.2.3. openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA

Für openSUSE Leap 15.x stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.

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

Daher machen wir die Repositories dem System bekannt.

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.

Dazu geben wir folgenden Befehl ein:

zypper addrepo -f \
  http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.2/ \
  "devel:languages:perl"
          
zypper addrepo -f \
  https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
  openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
          
zypper addrepo -f \
  https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
  openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
          

Danach geben wir noch die beiden folgenden Befehle ein:

zypper clean
zypper refresh

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.

zypper --help
[Anmerkung]Anmerkung

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.

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.

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:

yast2 return.

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.

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.

Programmpakete können mit folgendem Befehl installiert werden:

zypper install Paketname

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.

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
          

Für die Entwickler installiert man noch die folgenden Pakete:

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
          

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:

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
          

Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle anwenden:

cpan DateTime::event::Cron DateTime::Set FCGI \
  HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite

2.2.3. Andere Pakete installieren

  • poppler-utils 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung

  • Postgres Trigram-Index Für datenbankoptimierte Suchanfragen. Bspw. im Paket postgresql-contrib enthalten

Debian und Ubuntu:

apt install postgresql-contrib poppler-utils

Fedora:

dnf install poppler-utils postgresql-contrib

openSUSE:

zypper install poppler-tools