X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=doc%2Fdokumentation.xml;h=8a09613a1eddcecbd9b052d2413732281d1e4fe6;hb=e4971398dab1138fe348dca454c26f7ad156c1f6;hp=2570e8ee6d9a283e32f0e812b90d9113581b9d62;hpb=892615935831941cdefb81ba4017bf658b11898b;p=kivitendo-erp.git diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index 2570e8ee6..8a09613a1 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -2,7 +2,7 @@ - kivitendo 3.3.0: Installation, Konfiguration, Entwicklung + kivitendo 3.4.0: Installation, Konfiguration, Entwicklung Aktuelle Hinweise @@ -82,7 +82,7 @@ ohne große Probleme auf den derzeit aktuellen verbreiteten Distributionen läuft. - Anfang 2014 sind das folgende Systeme, von denen bekannt ist, + Anfang 2016 sind das folgende Systeme, von denen bekannt ist, dass kivitendo auf ihnen läuft: @@ -91,28 +91,24 @@ Debian - 6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden, und Rose::DB::Object ist zu alt) + 7.0 "Wheezy" - 7.0 "Wheezy" + 8.0 "Jessie" - Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal", 13.04 "Precise Pangolin" und 14.04 "Trusty Tahr" LTS Alpha - - - - openSUSE 12.2, 12.3 und 13.1 + Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr" LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS Alpha - SuSE Linux Enterprice Server 11 + openSUSE LEAP 42.1 - Fedora 16 bis 19 + Fedora 22 @@ -137,10 +133,18 @@ Archive::Zip + Algorithm::CheckDigits + + CGI + + Clone + Config::Std DateTime + DateTime::Format::Strptime + DBI DBD::Pg @@ -153,10 +157,20 @@ File::Copy::Recursive + GD + + HTML::Parser + + HTML::Restrict + + Image::Info + JSON List::MoreUtils + List::UtilsBy + Net::SMTP::SSL (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "") @@ -165,6 +179,8 @@ Params::Validate + PBKDF2::Tiny + PDF::API2 Rose::Object @@ -173,6 +189,10 @@ Rose::DB::Object Version 0.788 oder neuer + String::ShellQuote + + Sort::Naturally + Template Text::CSV_XS @@ -186,6 +206,7 @@ YAML + Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen: Algorithm::CheckDigitsPBKDF2::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. @@ -226,8 +247,10 @@ 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 \ - libfile-copy-recursive-perl postgresql + libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \ + libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \ + libcrypt-pbkdf2-perl git + Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies muß per CPAN installiert werden. Unter Ubuntu funktioniert das mit: apt-get install build-essential @@ -235,22 +258,22 @@ cpan HTML::Restrict - Fedora Core + Fedora - Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden: + 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: - yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \ + dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \ perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \ perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \ perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \ perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \ perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \ - perl-XML-Writer perl-YAML perl-parent postgresql-server + perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \ + perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen: - yum install perl-CPAN -cpan Config::Std + cpan Config::Std HTML::Restrict @@ -260,17 +283,17 @@ cpan Config::Std Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden: - zypper install apache2 perl-Archive-Zip perl-Clone \ + zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \ perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \ perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \ perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \ perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \ - perl-URI perl-XML-Writer perl-YAML postgresql-server + perl-URI perl-XML-Writer perl-YAML perl-CPAN \ + perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen: - yum install perl-CPAN -cpan Rose::Db::Object + cpan Rose::Db::Object @@ -281,11 +304,11 @@ cpan Rose::Db::Object Manuelle Installation des Programmpaketes Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann hier heruntergeladen werden. - Die kivitendo ERP Installationsdatei (kivitendo-erp-3.3.0.tgz) wird im Dokumentenverzeichnis des Webservers + Die kivitendo ERP Installationsdatei (kivitendo-erp-3.4.0.tgz) wird im Dokumentenverzeichnis des Webservers (z.B. /var/www/html/, /srv/www/htdocs oder /var/www/) entpackt: cd /var/www -tar xvzf kivitendo-erp-3.3.0.tgz +tar xvzf kivitendo-erp-3.4.0.tgz Wechseln Sie in das entpackte Verzeichnis: @@ -302,7 +325,7 @@ tar xvzf kivitendo-erp-3.3.0.tgz Die Verzeichnisse users, spool und webdav 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 www-data, bei Fedora - core apache oder bei OpenSUSE wwwrun). + apache oder bei OpenSUSE wwwrun). Der folgende Befehl ändert den Besitzer für die oben genannten Verzeichnisse auf einem Debian/Ubuntu-System: @@ -313,6 +336,21 @@ tar xvzf kivitendo-erp-3.3.0.tgz Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird: chown www-data templates users + + 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: + cd /usr/local/src/ +git clone https://github.com/kivitendo/kivitendo-erp.git +cd kivitendo-erp/ +git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1` + 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 + git checkout -b meine_eigenen_änderungen + nach dem letzten Kommando (weiterführende Informationen +getting started with git). + + @@ -419,10 +457,8 @@ password = kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den Taskserver. Er wird u.a. für Features wie die wiederkehrenden Rechnungen benötigt, erledigt aber auch andere erforderliche Aufgaben - und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter - [task_server] anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable - client), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable login) - eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird. + und muss daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt Task-Server + genauer beschrieben. Für Entwickler finden sich unter [debug] wichtige Funktionen, um die Fehlersuche zu erleichtern. @@ -705,22 +741,20 @@ Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/ <Directory /path/to/kivitendo-erp> AllowOverride All Options ExecCGI Includes FollowSymlinks - Order Allow,Deny - Allow from All + Require all granted </Directory> <DirectoryMatch /path/to/kivitendo-erp/users> - Order Deny,Allow - Deny from All +Require all granted </DirectoryMatch> - Im Vergleich zu Apache 2.2 hat sich in Apache 2.4 die Syntax der Directorydirektiven verändert. Statt + Wer einen älteren Apache als Version 2.4 im Einsatz hat, muss entsprechend die Syntax der Directorydirektiven verändert. Statt + Require all granted + muß man Folgendes einstellen: Order Allow,Deny Allow from All - muß man jetzt Folgendes einstellen: - Require all granted Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für @@ -789,6 +823,12 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ + 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. + + 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. + Verfügbare und notwendige Konfigurationsoptionen @@ -798,28 +838,6 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ - - client - - - Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende - Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben - werden. - - Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert - wurden, ergänzt werden. - - - - - login - - - gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der - Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden. - - - run_as @@ -830,7 +848,7 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/). Daher - ist es sinnvoll, hier denselben Systembenutzer einzutragen, + ist es erforderlich, hier denselben Systembenutzer einzutragen, unter dem auch der Webserver läuft. @@ -845,6 +863,17 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ + + Konfiguration der Mandanten für den Task-Server + + 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. + + Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so wird der Task-Server für diesen Mandanten keine Aufgaben + ausführen. + + Automatisches Starten des Task-Servers beim Booten @@ -859,7 +888,7 @@ Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/ - SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core) + SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora) Kopieren Sie die Datei scripts/boot/system-v/kivitendo-task-server @@ -878,7 +907,7 @@ insserv kivitendo-task-server - Ältere OpenSUSE und ältere Fedora Core: + Ältere OpenSUSE und ältere Fedora: chkconfig --add kivitendo-task-server @@ -891,7 +920,7 @@ insserv kivitendo-task-server - Upstart-basierende Systeme (z.B. Ubuntu) + Upstart-basierende Systeme (z.B. Ubuntu bis 14.04) Kopieren Sie die Datei scripts/boot/upstart/kivitendo-task-server.conf @@ -906,7 +935,7 @@ insserv kivitendo-task-server - systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core) + systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora, neuere Ubuntu) Verlinken Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach /etc/systemd/system/. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile @@ -964,20 +993,6 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Dieselben Optionen können auch für die SystemV-basierenden Runlevel-Scripte benutzt werden (siehe oben). - - Task-Server mit mehreren Mandanten - - Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die - Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen. - - Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie [task_server] die - gewünschten Werte für client und login eingetragen werden. - - Der alternative Task-Server wird dann mit folgendem Befehl - gestartet: - - ./scripts/task_server.pl -c config/DATEINAME.conf - @@ -1432,18 +1447,6 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Verschlüsselung aktiviert werden. - - Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind: - - - TLS-Verschlüsselung: Modul Net::SSLGlue (Debian-Paketname - libnet-sslglue-perl, Fedora Core: perl-Net-SSLGlue, openSUSE: - perl-Net-SSLGlue - - SSL-Verschlüsselung: Modul Net::SMTP::SSL (Debian-Paketname - libnet-smtp-ssl-perl, Fedora Core: perl-Net-SMTP-SSL, openSUSE: - perl-Net-SMTP-SSL - @@ -1454,10 +1457,20 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ LaTeX System. Am einfachsten ist dazu eine texlive Installation. Unter debianoiden Betriebssystemen installiert man die Pakete mit: - aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \ - texlive-latex-extra texlive-lang-german texlive-generic-extra + apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \ + exlive-latex-extra texlive-lang-german texlive-generic-extra + + Für Fedora benötigen Sie die folgenden Pakete: + + dnf install texlive-collection-latex texlive-collection-latexextra \ + texlive-collection-latexrecommended texlive-collection-langgerman \ + texlive-collection-langenglish - TODO: RPM-Pakete. + Für openSUSE benötigen Sie die folgenden Pakete: + + zypper install texlive-collection-latex texlive-collection-latexextra \ + texlive-collection-latexrecommended texlive-collection-langgerman \ + texlive-collection-langenglish kivitendo bringt drei alternative Vorlagensätze mit: @@ -3234,6 +3247,15 @@ empfang@revamp-it.ch + + gln + + + GLN (Globale Lokationsnummer) + + + + greeting @@ -3327,7 +3349,7 @@ empfang@revamp-it.ch - shiptodepartment1 + shiptodepartment_1 Abteilung 1 (Lieferadresse) - shiptodepartment2 + shiptodepartment_2 Abteilung 2 (Lieferadresse) + + shiptogln + + + GLN (Globale Lokationsnummer) (Lieferadresse) * + + + shiptoname @@ -4367,7 +4398,7 @@ empfang@revamp-it.ch fee - Kummulative Mahngebühren + Kumulative Mahngebühren @@ -5205,18 +5236,18 @@ Beschreibung: <%description%> - Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für + Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein. Zusätzliche Funktionshinweise: - Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von + Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet. - Wird beim 'Auslagern über Standardlagerplatz' + Wird beim 'Auslagern über Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet. @@ -6412,19 +6443,19 @@ $self->{more_texts} = { Für die Ausführung werden neben den für kivitendo eh schon benötigten Module noch weitere Perl-Module benötigt. Diese sind: - Test::Deep (Debian-Paketname: libtest-deep-perl; Fedora Core: + Test::Deep (Debian-Paketname: libtest-deep-perl; Fedora: perl-Test-Deep; openSUSE: perl-Test-Deep) - Test::Exception (Debian-Paketname: libtest-exception-perl; Fedora Core: + Test::Exception (Debian-Paketname: libtest-exception-perl; Fedora: perl-Test-Exception; openSUSE: perl-Test-Exception) - Test::Output (Debian-Paketname: libtest-output-perl; Fedora Core: + Test::Output (Debian-Paketname: libtest-output-perl; Fedora: perl-Test-Output; openSUSE: perl-Test-Output) Test::Harness 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und kann für frühere Versionen aus dem CPAN bezogen werden. LWP::Simple aus dem Paket libwww-perl (Debian-Panetname: - libwww-perl; Fedora Core: perl-libwww-perl; openSUSE: + libwww-perl; Fedora: perl-libwww-perl; openSUSE: perl-libwww-perl) - URI::Find (Debian-Panetname: liburi-find-perl; Fedora Core: + URI::Find (Debian-Panetname: liburi-find-perl; Fedora: perl-URI-Find; openSUSE: perl-URI-Find)