Kundenstammdaten: Nachnamensfeld eindeutiger beschriftet
[kivitendo-erp.git] / doc / dokumentation.xml
index b45f13a..1103e84 100644 (file)
 
     <itemizedlist>
       <listitem>
-        <para>im kivitendo-Forum: <ulink
-        url="https://forum.kivitendo.org:32443">https://forum.kivitendo.org:32443</ulink></para>
+        <para>im Community-Forum: <ulink
+        url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
+      </listitem>
+      <listitem>
+        <para>im Kunden-Forum: <ulink
+        url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
       </listitem>
       <listitem>
         <para>in der doc/UPGRADE Datei im doc-Verzeichnis der Installation</para>
@@ -415,10 +419,8 @@ password =</programlisting>
         <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 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. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
-        <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
-        <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
-        eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
+        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>
@@ -513,8 +515,15 @@ psql template1</programlisting>
 
         führen Sie die folgenden Kommandos aus:</para>
 
-        <programlisting>create language 'plpgsql';
+        <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="Datenbankbenutzer-anlegen">
@@ -556,10 +565,11 @@ exit</programlisting>
         anderen Datei hinzu, die beim Starten des Webservers eingelesen
         wird:</para>
 
-        <programlisting>AddHandler cgi-script .pl
+        <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;
 
@@ -574,6 +584,9 @@ Alias /kivitendo-erp/ /var/www/kivitendo-erp/
         <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
@@ -756,6 +769,15 @@ Alias       /url/for/kivitendo-erp-fcgid/          /path/to/kivitendo-erp/</prog
           FastCGI-Version.</para>
         </sect3>
       </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></para>
+      </sect2>
     </sect1>
 
     <sect1 id="config.task-server">
@@ -765,6 +787,12 @@ Alias       /url/for/kivitendo-erp-fcgid/          /path/to/kivitendo-erp/</prog
       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>
+
       <sect2 id="Konfiguration-des-Task-Servers">
         <title>Verfügbare und notwendige Konfigurationsoptionen</title>
 
@@ -774,28 +802,6 @@ Alias       /url/for/kivitendo-erp-fcgid/          /path/to/kivitendo-erp/</prog
         Optionen sind:</para>
 
         <variablelist>
-          <varlistentry>
-            <term><varname>client</varname></term>
-
-            <listitem>
-              <para>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.</para>
-
-              <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
-              wurden, ergänzt werden.</para>
-            </listitem>
-          </varlistentry>
-
-          <varlistentry>
-            <term><varname>login</varname></term>
-
-            <listitem>
-              <para>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.</para>
-            </listitem>
-          </varlistentry>
-
           <varlistentry>
             <term><varname>run_as</varname></term>
 
@@ -806,7 +812,7 @@ Alias       /url/for/kivitendo-erp-fcgid/          /path/to/kivitendo-erp/</prog
               Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
               (siehe see <xref
               linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
-              ist es sinnvoll, hier denselben Systembenutzer einzutragen,
+              ist es erforderlich, hier denselben Systembenutzer einzutragen,
               unter dem auch der Webserver läuft.</para>
             </listitem>
           </varlistentry>
@@ -821,6 +827,17 @@ Alias       /url/for/kivitendo-erp-fcgid/          /path/to/kivitendo-erp/</prog
         </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>
 
@@ -992,7 +1009,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
       <sect2 id="Administratorpasswort">
         <title>Administratorpasswort</title>
 
-        <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
+        <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
@@ -1067,7 +1084,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
         <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 Psaswörter in
+        der Administrator als auch die Benutzer selber ihre Passwörter in
         kivitendo ändern.</para>
 
         <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
@@ -1646,7 +1663,7 @@ ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
           </para>
         </sect3>
       </sect2>
-      
+
       <sect2 id="Vorlagen-rev-odt">
         <title>Der Druckvorlagensatz rev-odt</title>
 
@@ -2909,7 +2926,7 @@ empfang@revamp-it.ch
               <term><varname>template_meta.language.template_code</varname></term>
 
               <listitem>
-                <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
+                <para>Vorlagenkürzel der verwendeten Sprache, identisch mit dem
                 Kürzel das im Dateinamen verwendetet wird.</para>
               </listitem>
             </varlistentry>
@@ -3303,7 +3320,7 @@ empfang@revamp-it.ch
             </varlistentry>
 
             <varlistentry>
-              <term><varname>shiptodepartment1</varname></term>
+              <term><varname>shiptodepartment_1</varname></term>
 
               <listitem>
                 <para>Abteilung 1 (Lieferadresse) <link
@@ -3312,7 +3329,7 @@ empfang@revamp-it.ch
             </varlistentry>
 
             <varlistentry>
-              <term><varname>shiptodepartment2</varname></term>
+              <term><varname>shiptodepartment_2</varname></term>
 
               <listitem>
                 <para>Abteilung 2 (Lieferadresse) <link
@@ -6146,9 +6163,6 @@ sub run {
         are built. Currently the only language fully supported is German, and
         since most of the internal messages are held in English the English
         version is usable too.</para>
-
-        <para>A stub version of French is included but not functunal at this
-        point.</para>
       </sect2>
 
       <sect2 id="translations-languages.character-set"
@@ -6322,6 +6336,43 @@ filenames</programlisting>
               want to keep this safe somewhere.</para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term>more/all</term>
+
+            <listitem>
+              <para>This subdir and file is not a part of the language package
+              itself.</para>
+
+              <para>If the directory more exists and contains a file called all
+              it will be parsed in addition to the mandatory all (see above).
+              The file is useful if you want to change some translations for
+              the current installation without conflicting further upgrades.
+              The file is not autogenerated and has the same format as the all,
+              but needs another key (more_texts). See the german translation
+              for an example or copy the following code:
+              <programlisting>
+#!/usr/bin/perl
+# -*- coding: utf-8; -*-
+# vim: fenc=utf-8
+
+use utf8;
+
+# These are additional texts for custom translations.
+# The format is the same as for the normal file all, only
+# with another key (more_texts instead of texts).
+# The file has the form of 'english text'  => 'foreign text',
+
+$self->{more_texts} = {
+
+  'Ship via'                    => 'Terms of delivery',
+  'Shipping Point'              => 'Delivery time',
+}
+              </programlisting>
+              </para>
+            </listitem>
+          </varlistentry>
+
+
         </variablelist>
       </sect2>
     </sect1>