Dokumentation html und pdf Datei
[kivitendo-erp.git] / doc / dokumentation.xml
index 25a529e..2cb44fb 100644 (file)
@@ -2,7 +2,8 @@
 <!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.0: Installation, Konfiguration, Entwicklung</title>
+  <title>kivitendo 3.5.1-beta: Installation, Konfiguration,
+  Entwicklung</title>
 
   <chapter id="Aktuelle-Hinweise">
     <title>Aktuelle Hinweise</title>
             <para><literal>List::UtilsBy</literal></para>
           </listitem>
 
+          <listitem>
+            <para>LWP::Authen::Digest</para>
+          </listitem>
+
+          <listitem>
+            <para>LWP::UserAgent</para>
+          </listitem>
+
           <listitem>
             <para><literal>Net::SMTP::SSL</literal> (optional, bei
             E-Mail-Versand über SSL; siehe Abschnitt "<xref
         </itemizedlist>
 
         <para>Seit Version größer v3.5.0 sind die folgenden Pakete
-        hinzugekommen: <literal>Text::Unidecode</literal></para>
+        hinzugekommen: <literal>Text::Unidecode, LWP::Authen::Digest,
+        LWP::UserAgent</literal></para>
 
         <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
         <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
   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
+  libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl
 </programlisting>
 
           <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
@@ -401,7 +411,7 @@ cpan HTML::Restrict</programlisting>
   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-CPAN \
-  perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced</programlisting>
+  perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced perl-libwww-perl</programlisting>
 
           <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
           werden. Dazu können Sie die folgenden Befehle nutzen:</para>
@@ -422,7 +432,7 @@ cpan HTML::Restrict</programlisting>
   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 perl-CPAN \
-  perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server</programlisting>
+  perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server perl-libwwww-perl</programlisting>
 
           <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
           werden. Dazu können Sie die folgenden Befehle nutzen:</para>
@@ -513,13 +523,13 @@ tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
         die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
 git clone https://github.com/kivitendo/kivitendo-erp.git
 cd kivitendo-erp/
-git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
+git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
         Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
-        -l listet alle Tags auf, das egrep schmeisst alle Einträge mit beta
-        oder rc raus und das tail gibt davon den obersten Treffer zurück).
-        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 <programlisting>  git checkout -b meine_eigenen_änderungen</programlisting>
+        -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
+        beta oder rc raus und das tail gibt davon den obersten Treffer
+        zurück). 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 <programlisting>  git checkout -b meine_eigenen_änderungen</programlisting>
         nach dem letzten Kommando (weiterführende Informationen <ulink
         url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
         Git Magic</ulink>).</para>
@@ -840,6 +850,35 @@ psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
         </note>
       </sect2>
 
+      <sect2 id="Erweiterung-für-trigram">
+        <title>Erweiterung für Trigram Prozeduren</title>
+
+        <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
+        Diese wird mit dem SQL-Updatescript
+        sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
+        Rechten automatisch installiert. Dazu braucht der
+        DatenbankSuperbenutzer "postgres" ein Passwort.</para>
+
+        <programlisting>su - postgres
+psql
+\password postgres
+
+Eingabe Passwort
+\q</programlisting>
+
+        <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
+        einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
+        benötigen, eingegeben werden.</para>
+
+        <note>
+          <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
+          Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
+          in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
+          das Paket nachinstalliert werden, bspw. bei debian/ubuntu
+          <programlisting>apt install postgresql-contrib</programlisting></para>
+        </note>
+      </sect2>
+
       <sect2 id="Datenbankbenutzer-anlegen">
         <title>Datenbankbenutzer anlegen</title>
 
@@ -6846,30 +6885,6 @@ document_path = /var/local/kivi_documents
       Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
       werden.</para>
 
-      <sect2>
-        <title>Installationvorraussetzungen</title>
-
-        <para>In der Datenbank <literal>template1</literal> muss die
-        Unterstützung für die trigram-Extension eingerichet werden. Melden Sie
-        sich dafür als Benutzer “postgres” an der Datenbank an:
-        <programlisting>su - postgres
-psql template1</programlisting></para>
-
-        <para>führen Sie die folgenden Kommandos aus:</para>
-
-        <programlisting>CREATE EXTENSION IF NOT EXISTS pg_trgm;
-\q</programlisting>
-
-        <para>Für bestehende Datenbanken muss die Extension in der Datenbank
-        angelegt werden</para>
-
-        <programlisting>su - postgres
-psql DATENBANKNAME</programlisting>
-
-        <programlisting>CREATE EXTENSION IF NOT EXISTS pg_trgm;
-\q</programlisting>
-      </sect2>
-
       <sect2>
         <title>Rechte für die Webshopapi</title>
 
@@ -6886,7 +6901,7 @@ psql DATENBANKNAME</programlisting>
           </listitem>
 
           <listitem>
-            <para>Shopbestellungen holen und bearbeiten</para>
+            <para>Shop anlegen und bearbeiten</para>
           </listitem>
         </itemizedlist>
       </sect2>
@@ -8355,6 +8370,15 @@ $self-&gt;{more_texts} = {
         <literal>testing/database</literal> Datenbankverbindungsparameter
         angegeben werden. Der hier angegebene Benutzer muss weiterhin das
         Recht haben, Datenbanken anzulegen und zu löschen.</para>
+
+        <para>Der so angegebene Benutzer muss nicht zwingend über
+        Super-User-Rechte verfügen. Allerdings gibt es einige
+        Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
+        kann man in diesem Konfigurationsabschnitt einen weiteren
+        Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
+        mit dem die betroffenen Upgrades durchgeführt werden. In der
+        Beispiel-Konfigurationsdatei finden Sie die benötigten
+        Parameter.</para>
       </sect2>
 
       <sect2 id="devel.testsuite.execution">