From: Jan Büren Date: Thu, 30 Jan 2014 14:08:48 +0000 (+0100) Subject: Dokumentations-Update X-Git-Tag: release-3.1.0beta1~3 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=d63ea7c6b814244c99eb40d56633a96debf93a3f;p=kivitendo-erp.git Dokumentations-Update --- diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index 51f9549cb..66ac4e947 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -2,7 +2,7 @@ - kivitendo 3.0.0: Installation, Konfiguration, Entwicklung + kivitendo 3.1.0: Installation, Konfiguration, Entwicklung Aktuelle Hinweise @@ -60,7 +60,7 @@ - Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen + Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen werden. @@ -622,7 +622,7 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/ - Apache 2.2.11 (Ubuntu) und mod_fastcgi. + Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi. @@ -1993,7 +1993,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies zu falschen Werten. - In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen: + In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man: weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher) @@ -2003,9 +2003,11 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/ immer die letzte Eröffnungsbuchung als Startdatum nimmt + - mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt + - oder mit "alle Buchungen" als Alternative" - mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt + mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt immer alle Buchungen seit Beginn der Datenbank nimmt diff --git a/doc/html/ch01.html b/doc/html/ch01.html index f3c9e3e15..642b25af1 100644 --- a/doc/html/ch01.html +++ b/doc/html/ch01.html @@ -1,5 +1,5 @@ - Kapitel 1. Aktuelle Hinweise

Kapitel 1. Aktuelle Hinweise

Aktuelle Installations- und Konfigurationshinweise gibt es:

\ No newline at end of file diff --git a/doc/html/ch02.html b/doc/html/ch02.html index 0d6b60def..f9db6d202 100644 --- a/doc/html/ch02.html +++ b/doc/html/ch02.html @@ -1,6 +1,6 @@ - Kapitel 2. Installation und Grundkonfiguration

Kapitel 2. Installation und Grundkonfiguration

2.1. Übersicht

+ Kapitel 2. Installation und Grundkonfiguration

Kapitel 2. Installation und Grundkonfiguration

2.1. Übersicht

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.

  1. @@ -13,6 +13,6 @@ Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "Abschnitt 2.8, „Benutzerauthentifizierung und Administratorpasswort“".

  2. Benutzer, Gruppen und Datenbanken anlegen: wie dies alles zusammenspielt erläutert "Abschnitt 2.9, „Mandanten-, Benutzer- und Gruppenverwaltung“".

  3. Los geht's: alles soweit erledigt? Dann kann es losgehen: "Abschnitt 2.17, „kivitendo ERP verwenden“"

- Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen + Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen werden.

\ No newline at end of file diff --git a/doc/html/ch02s02.html b/doc/html/ch02s02.html index 79b77a082..816731de6 100644 --- a/doc/html/ch02s02.html +++ b/doc/html/ch02s02.html @@ -1,6 +1,6 @@ - 2.2. Benötigte Software und Pakete

2.2. Benötigte Software und Pakete

2.2.1. Betriebssystem

kivitendo ist für Linux konzipiert, und sollte auf jedem + 2.2. Benötigte Software und Pakete

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 diff --git a/doc/html/ch02s03.html b/doc/html/ch02s03.html index 3c796d1da..274a9c55d 100644 --- a/doc/html/ch02s03.html +++ b/doc/html/ch02s03.html @@ -1,6 +1,6 @@ - 2.3. Manuelle Installation des Programmpaketes

2.3. Manuelle Installation des Programmpaketes

Die kivitendo ERP Installationsdatei (kivitendo-erp-3.0.0.tgz) wird im Dokumentenverzeichnis des Webservers + 2.3. Manuelle Installation des Programmpaketes

2.3. Manuelle Installation des Programmpaketes

Die kivitendo ERP Installationsdatei (kivitendo-erp-3.0.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.0.0.tgz

Wechseln Sie in das entpackte Verzeichnis:

cd kivitendo-erp

Alternativ können Sie auch einen Alias in der Webserverkonfiguration benutzen, um auf das tatsächliche diff --git a/doc/html/ch02s04.html b/doc/html/ch02s04.html index c1bdf68ac..bc5864ba8 100644 --- a/doc/html/ch02s04.html +++ b/doc/html/ch02s04.html @@ -1,6 +1,6 @@ - 2.4. kivitendo-Konfigurationsdatei

2.4. kivitendo-Konfigurationsdatei

2.4.1. Einführung

In kivitendo gibt es nur noch eine Konfigurationsdatei, + 2.4. kivitendo-Konfigurationsdatei

2.4. kivitendo-Konfigurationsdatei

2.4.1. Einführung

In kivitendo gibt es nur noch eine Konfigurationsdatei, die benötigt wird: config/kivitendo.conf (kurz: "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von kivitendo bzw. der Migration von älteren Versionen angelegt diff --git a/doc/html/ch02s05.html b/doc/html/ch02s05.html index 4a6c0d83a..37c6a2876 100644 --- a/doc/html/ch02s05.html +++ b/doc/html/ch02s05.html @@ -1,6 +1,6 @@ - 2.5. Anpassung der PostgreSQL-Konfiguration

2.5. Anpassung der PostgreSQL-Konfiguration

PostgreSQL muss auf verschiedene Weisen angepasst werden.

2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8

kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen + 2.5. Anpassung der PostgreSQL-Konfiguration

2.5. Anpassung der PostgreSQL-Konfiguration

PostgreSQL muss auf verschiedene Weisen angepasst werden.

2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8

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

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:

su postgres
 echo '\l' | psql
diff --git a/doc/html/ch02s06.html b/doc/html/ch02s06.html
index 8adafac8c..c536d94f5 100644
--- a/doc/html/ch02s06.html
+++ b/doc/html/ch02s06.html
@@ -1,6 +1,6 @@
 
       
-   2.6. Webserver-Konfiguration

2.6. Webserver-Konfiguration

2.6.1. Grundkonfiguration mittels CGI

[Anmerkung]Anmerkung

Für einen deutlichen Performanceschub sorgt die Ausführung + 2.6. Webserver-Konfiguration

2.6. Webserver-Konfiguration

2.6.1. Grundkonfiguration mittels CGI

[Anmerkung]Anmerkung

Für einen deutlichen Performanceschub sorgt die Ausführung mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt Konfiguration für FastCGI/FCGI beschrieben.

Der Zugriff auf das Programmverzeichnis muss in der Apache Webserverkonfigurationsdatei httpd.conf eingestellt @@ -39,7 +39,7 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/ 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.

Mit FastCGI werden nun die Module einmal geladen, und danach - wird nur die eigentliche Programmlogik ausgeführt.

2.6.2.3. Getestete Kombinationen aus Webservern und Plugin

Folgende Kombinationen sind getestet:

  • Apache 2.2.11 (Ubuntu) und mod_fcgid.

  • Apache 2.2.11 (Ubuntu) und mod_fastcgi.

Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer + wird nur die eigentliche Programmlogik ausgeführt.

2.6.2.3. Getestete Kombinationen aus Webservern und Plugin

Folgende Kombinationen sind getestet:

  • Apache 2.2.11 (Ubuntu) und mod_fcgid.

  • Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.

Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf mod_fastcgi nicht mehr explizit eingegangen.

Als Perl Backend wird das Modul FCGI.pm verwendet.

[Warnung]Warnung

FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern diff --git a/doc/html/ch02s07.html b/doc/html/ch02s07.html index 577f2b5c6..b3797ca14 100644 --- a/doc/html/ch02s07.html +++ b/doc/html/ch02s07.html @@ -1,6 +1,6 @@ - 2.7. Der Task-Server

2.7. Der Task-Server

Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und + 2.7. Der Task-Server

2.7. Der Task-Server

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.

2.7.1. Verfügbare und notwendige Konfigurationsoptionen

Die Konfiguration erfolgt über den Abschnitt [task_server] in der Datei diff --git a/doc/html/ch02s08.html b/doc/html/ch02s08.html index 245951118..66aa89a9d 100644 --- a/doc/html/ch02s08.html +++ b/doc/html/ch02s08.html @@ -1,6 +1,6 @@ - 2.8. Benutzerauthentifizierung und Administratorpasswort

2.8. Benutzerauthentifizierung und Administratorpasswort

Informationen über die Einrichtung der Benutzerauthentifizierung, + 2.8. Benutzerauthentifizierung und Administratorpasswort

2.8. Benutzerauthentifizierung und Administratorpasswort

Informationen über die Einrichtung der Benutzerauthentifizierung, über die Verwaltung von Gruppen und weitere Einstellungen

2.8.1. Grundlagen zur Benutzerauthentifizierung

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 diff --git a/doc/html/ch02s09.html b/doc/html/ch02s09.html index 0abdceef4..12028f7c6 100644 --- a/doc/html/ch02s09.html +++ b/doc/html/ch02s09.html @@ -1,6 +1,6 @@ - 2.9. Mandanten-, Benutzer- und Gruppenverwaltung

2.9. Mandanten-, Benutzer- und Gruppenverwaltung

Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im + 2.9. Mandanten-, Benutzer- und Gruppenverwaltung

2.9. Mandanten-, Benutzer- und Gruppenverwaltung

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

http://localhost/kivitendo-erp/controller.pl?action=Admin/login

Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei diff --git a/doc/html/ch02s10.html b/doc/html/ch02s10.html index fca6121b3..0df88109a 100644 --- a/doc/html/ch02s10.html +++ b/doc/html/ch02s10.html @@ -1,6 +1,6 @@ - 2.10. E-Mail-Versand aus kivitendo heraus

2.10. E-Mail-Versand aus kivitendo heraus

kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu + 2.10. E-Mail-Versand aus kivitendo heraus

2.10. E-Mail-Versand aus kivitendo heraus

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 Postfix™ oder Exim™, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des diff --git a/doc/html/ch02s11.html b/doc/html/ch02s11.html index 2ab4e2cb2..a098788b4 100644 --- a/doc/html/ch02s11.html +++ b/doc/html/ch02s11.html @@ -1,6 +1,6 @@ - 2.11. Drucken mit kivitendo

2.11. Drucken mit kivitendo

Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes + 2.11. Drucken mit kivitendo

2.11. Drucken mit kivitendo

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 texlive Installation. Unter Debianoiden Betriebssystemen installiert man die Pakete mit:

aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
diff --git a/doc/html/ch02s12.html b/doc/html/ch02s12.html
index d24a40cfb..98be8bff2 100644
--- a/doc/html/ch02s12.html
+++ b/doc/html/ch02s12.html
@@ -1,6 +1,6 @@
 
       
-   2.12. OpenDocument-Vorlagen

2.12. OpenDocument-Vorlagen

kivitendo unterstützt die Verwendung von Vorlagen im + 2.12. OpenDocument-Vorlagen

2.12. OpenDocument-Vorlagen

kivitendo unterstützt die Verwendung von Vorlagen im OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von diff --git a/doc/html/ch02s13.html b/doc/html/ch02s13.html index 6eb8bea6c..eb63153a3 100644 --- a/doc/html/ch02s13.html +++ b/doc/html/ch02s13.html @@ -1,6 +1,6 @@ - 2.13. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR

4.1.3.7. $::instance_conf

  • Objekt der Klasse "SL::InstanceConfiguration"

  • wird pro Request neu erstellt

Funktioniert wie $::lx_office_conf, speichert aber Daten die von der Instanz abhängig sind. Eine Instanz ist hier eine Mandantendatenbank. Beispielsweise überprüft

$::instance_conf->get_inventory_system eq 'perpetual'

- ob die berüchtigte Bestandsmethode zur Anwendung kommt.

4.1.3.8. $::dispatcher

  • Objekt der Klasse + ob die berüchtigte Bestandsmethode zur Anwendung kommt.

4.1.3.8. $::dispatcher

  • Objekt der Klasse "SL::Dispatcher"

  • wird pro Serverprozess erstellt.

  • enthält Informationen über die technische Verbindung zum Server

Der dritte Punkt ist auch der einzige Grund warum das Objekt global gespeichert wird. Wird vermutlich irgendwann in einem anderen - Objekt untergebracht.

4.1.3.9. $::request

  • Hashref (evtl später Objekt)

  • Wird pro Request neu initialisiert.

  • Keine Unterstruktur garantiert.

+ Objekt untergebracht.

4.1.3.9. $::request

  • Hashref (evtl später Objekt)

  • Wird pro Request neu initialisiert.

  • Keine Unterstruktur garantiert.

$::request ist ein generischer Platz um Daten "für den aktuellen Request" abzulegen. Sollte nicht für action at a distance benutzt werden, sondern um lokales memoizing zu @@ -174,20 +174,20 @@ file = /tmp/kivitendo-debug.log

ist der Key file$::request

  • Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann $::request, aber Zugriff über - Wrappermethode

  • 4.1.4. Ehemalige globale Variablen

    Die folgenden Variablen waren einmal im Programm, und wurden - entfernt.

    4.1.4.1. $::cgi

    • war nötig, weil cookie Methoden nicht als + Wrappermethode

    4.1.4. Ehemalige globale Variablen

    Die folgenden Variablen waren einmal im Programm, und wurden + entfernt.

    4.1.4.1. $::cgi

    • war nötig, weil cookie Methoden nicht als Klassenfunktionen funktionieren

    • Aufruf als Klasse erzeugt Dummyobjekt was im Klassennamespace gehalten wird und über Requestgrenzen leaked

    • liegt jetzt unter $::request->{cgi} -

    4.1.4.2. $::all_units

    • war nötig, weil einige Funktionen in Schleifen zum Teil +

    4.1.4.2. $::all_units

    • war nötig, weil einige Funktionen in Schleifen zum Teil ein paar hundert mal pro Request eine Liste der Einheiten brauchen, und de als Parameter durch einen Riesenstack von Funktionen geschleift werden müssten.

    • Liegt jetzt unter $::request->{cache}{all_units}

    • Wird nur in AM->retrieve_all_units() gesetzt oder - gelesen.

    4.1.4.3. %::called_subs

    • wurde benutzt um callsub deep recursions + gelesen.

    4.1.4.3. %::called_subs

    • wurde benutzt um callsub deep recursions abzufangen.

    • Wurde entfernt, weil callsub nur einen Bruchteil der möglichen Rekursioenen darstellt, und da nie welche auftreten.

    • komplette recursion protection wurde entfernt.

    \ No newline at end of file diff --git a/doc/html/ch04s02.html b/doc/html/ch04s02.html index d5f370870..aebb2e1f2 100644 --- a/doc/html/ch04s02.html +++ b/doc/html/ch04s02.html @@ -1,6 +1,6 @@ - 4.2. Entwicklung unter FastCGI

    4.2. Entwicklung unter FastCGI

    4.2.1. Allgemeines

    Wenn Änderungen in der Konfiguration von kivitendo gemacht + 4.2. Entwicklung unter FastCGI

    4.2. Entwicklung unter FastCGI

    4.2.1. Allgemeines

    Wenn Änderungen in der Konfiguration von kivitendo gemacht werden, muss der Webserver neu gestartet werden.

    Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu achten. Dadurch, dass das Programm in einer Endlosschleife läuft, müssen folgende Aspekte beachtet werden.

    4.2.2. Programmende und Ausnahmen

    Betrifft die Funktionen warn, diff --git a/doc/html/ch04s03.html b/doc/html/ch04s03.html index bef5e5ded..ae129453b 100644 --- a/doc/html/ch04s03.html +++ b/doc/html/ch04s03.html @@ -1,6 +1,6 @@ - 4.3. SQL-Upgradedateien

    4.3. SQL-Upgradedateien

    4.3.1. Einführung

    Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis sql/Pg-upgrade2 + 4.3. SQL-Upgradedateien

    4.3. SQL-Upgradedateien

    4.3.1. Einführung

    Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis sql/Pg-upgrade2 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige Kontrollinformationen enthält.

    Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein ALTER TABLE erst ausgeführt werden, wenn die Tabelle mit CREATE diff --git a/doc/html/ch04s04.html b/doc/html/ch04s04.html index 98d906906..5640d89f1 100644 --- a/doc/html/ch04s04.html +++ b/doc/html/ch04s04.html @@ -1,6 +1,6 @@ - 4.4. Translations and languages

    4.4. Translations and languages

    4.4.1. Introduction

    [Anmerkung]Anmerkung

    Dieser Abschnitt ist in Englisch geschrieben, um + 4.4. Translations and languages

    4.4. Translations and languages

    4.4.1. Introduction

    [Anmerkung]Anmerkung

    Dieser Abschnitt ist in Englisch geschrieben, um internationalen Übersetzern die Arbeit zu erleichtern.

    This section describes how localization packages in kivitendo are built. Currently the only language fully supported is German, and since most of the internal messages are held in English the English diff --git a/doc/html/ch04s05.html b/doc/html/ch04s05.html index 17f81cb52..0e0ee2063 100644 --- a/doc/html/ch04s05.html +++ b/doc/html/ch04s05.html @@ -1,6 +1,6 @@ - 4.5. Die kivitendo-Test-Suite

    4.5. Die kivitendo-Test-Suite

    4.5.1. Einführung

    kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul Test::More.

    Die grundlegenden Fakten sind: