<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<book id="kivitendo-documentation" lang="de">
- <title>kivitendo 3.5.3: Installation, Konfiguration,
+ <title>kivitendo 3.5.5: Installation, Konfiguration,
Entwicklung</title>
<chapter id="Aktuelle-Hinweise">
<itemizedlist>
<listitem>
<para>im Community-Forum: <ulink
- url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
+ url="https://forum.kivitendo.de">https://forum.kivitendo.de</ulink></para>
</listitem>
<listitem>
<para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
Ausführung bestimmter Aufgaben mit, den <link
- linkend="config.task-server">Taskserver</link>. Er wird u.a. für
+ linkend="config.task-server">Task-Server</link>. Er wird u.a. für
Features wie die <link
linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
Servers integriert werden muss, damit er automatisch gestartet wird.
Dies kann kivitendo nicht für Sie erledigen.</para>
- <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
+ <para>Da der Task-Server als Perlscript läuft, wird Arbeitsspeicher, der
einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
- solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
- laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
- beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
- regelmässigen Abständen neu gestartet wird.</para>
+ solange der Task-Server läuft. Dies kann dazu führen, dass ein länger
+ laufender Task-Server mit der Zeit immer mehr Arbeitsspeicher für sich
+ beansprucht. Es ist deshalb sinnvoll, dass der Task-Server in
+ regelmässigen Abständen neu gestartet wird. Allerdings berücksichtigt der
+ Task-Server ein Memory-Limit, wenn dieses in der Konfigurationsdatei
+ angegeben ist. Bei Überschreiten dieses Limits beendet sich der
+ Task-Server. Sofern der Task-Server als systemd-Service mit dem
+ mitgelieferten Skript eingerichtet wurde, startet dieser danach
+ automatisch erneut.</para>
<sect2 id="Konfiguration-des-Task-Servers">
<title>Verfügbare und notwendige Konfigurationsoptionen</title>
Befehl tun:</para>
<programlisting>systemctl start kivitendo-task-server.service</programlisting>
+
+ <para>Ein so eingerichteter Task-Server startet nach Beendigung
+ automatisch erneut. Das betrifft eine Beendigung über die Oberfläche,
+ eine Beendingung über die Prozesskontrolle und eine Beendigung bei
+ Überschreiten des Memory-Limits. Soll der Task-Server nicht erneut
+ starten, so können Sie ihn mit folgendem Befehl stoppen:</para>
+
+ <programlisting>systemctl stop kivitendo-task-server.service</programlisting>
+
</sect3>
</sect2>
<listitem>
<para><literal>status</literal> berichtet, ob der Task-Server
läuft.</para>
- </listitem>
+ </listitem>yy
</itemizedlist>
<para>Der Task-Server wechselt beim Starten automatisch in das
<para>Dieselben Optionen können auch für die SystemV-basierenden
Runlevel-Scripte benutzt werden (siehe oben).</para>
+
+ <para>Wurde der Task-Server als systemd-Service eingerichtet (s.o.),
+ so startet dieser nach Beendigung automatisch erneut.</para>
+
</sect2>
- </sect1>
+ <sect2 id="Tasks konfigurieren">
+ <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
+ <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
+ <para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para>
+<programlisting>* * * * *
+┬ ┬ ┬ ┬ ┬
+│ │ │ │ │
+│ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7)
+│ │ │ └────── Monat (1-12)
+│ │ └──────── Tag (1-31)
+│ └────────── Stunde (0-23)
+└──────────── Minute (0-59) </programlisting>
+ <para>Die Sterne können folgende Werte haben:</para>
+ <programlisting>
+1 2 3 4 5
+
+1 = Minute (0-59)
+2 = Stunde (0-23)
+3 = Tag (0-31)
+4 = Monat (1-12)
+5 = Wochentag (0-7, Sonntag ist 0 oder 7)
+</programlisting>
+<para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
+<programlisting>59 23 31 12 *</programlisting>
+ </listitem>
+ <listitem>
+ <para><literal>Daten:</literal>In diesem Feld können optionale Parameter für den Hintergrund im JSON-Format gesetzt werden. Der Hintergrund-Job <literal>SetNumberRange</literal> akzeptiert zwei Variable nämlich <literal>digit_year</literal> sowieso <literal>multiplier</literal>.</para><para> <literal>digit_year</literal> kann zwei Werte haben entweder 2 oder 4, darüber wird gesteuert ob die Jahreszahl zwei oder vierstellig kodiert wird (für 2019, dann entweder 19 oder 2019). Der Standardwert ist vierstellig.</para><para> <literal>multiplier</literal> ist ein Vielfaches von 10, darüber wird die erste Nummer im Nummernkreis (die Anzahl der Stellen) wie folgt bestimmt:</para>
+<programlisting>
+multiplier Nummernkreis 2020
+10 -> 20200
+100 -> 202000
+1000 -> 2020000
+</programlisting>
+<para>Wir gehen jetzt beispielhaft von einer letzten Rechnungsnummer von RE2019456 aus. Demnach sollte ab Januar 2020 die erste Nummer RE2020001 sein. Da der Task auch Präfixe berücksichtigt, kann dies mit folgenden JSON-kodierten Werten umgesetzt werden:</para>
+<literal>Daten:</literal><programlisting>multiplier: 100
+digits_year: 4</programlisting>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ </sect1>
<sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
<title>Benutzerauthentifizierung und Administratorpasswort</title>
Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
abgelegt werden.</para>
- <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
- entweder gegen die Authentifizierungsdatenbank oder gegen einen
- LDAP-Server überprüft werden.</para>
+ <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder
+ mehrere LDAP-Server überprüft werden.</para>
<para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
<title>Passwortüberprüfung</title>
<para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
- die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
+ die Authentifizierungsdatenbank und gegen externe LDAP- oder
Active-Directory-Server. Welche davon benutzt wird, regelt der
Parameter <varname>module</varname> im Abschnitt
<varname>[authentication]</varname>.</para>
- <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
- gespeichert werden, so muss der Parameter <varname>module</varname>
- den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
- der Administrator als auch die Benutzer selber ihre Passwörter in
- kivitendo ändern.</para>
+ <para>Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es
+ können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung
+ eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver
+ nicht erreichbar ist.</para>
- <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
- benutzt werden, so muss der Parameter <varname>module</varname> auf
- <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
- zusätzliche Informationen über den LDAP-Server im Abschnitt
- <literal>[authentication/ldap]</literal> angegeben werden:</para>
+ <para>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>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal>verify</literal></term>
+
+ <listitem>
+ <para>Wenn Verbindungsverschlüsselung gewünscht und der Parameter <parameter>tls</parameter> gesetzt ist, so gibt dieser
+ Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind <literal>require</literal> (Zertifikat
+ wird überprüft und muss gültig sei; dies ist der Standard) und <literal>none</literal> (Zertifikat wird nicht
+ überpfüft).</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><literal>attribute</literal></term>
also ‘<literal>Martin Mustermann</literal>’.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><literal>timeout</literal></term>
+
+ <listitem>
+ <para>Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</sect2>
<para>Die zeitliche und periodische Überprüfung, ob eine
wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
- durch den <link linkend="config.task-server">Taskserver</link>, einen
+ durch den <link linkend="config.task-server">Task-Server</link>, einen
externen Dienst, der automatisch beim Start des Servers gestartet
werden sollte.</para>
</sect2>
<para>Will man im laufenden Monat eine monatlich wiederkehrende
Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
- auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
+ auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
generiert hat. Alternativ setzt man das Startdatum auf den
Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
projects / kivitendo-erp.git / blobdiff