Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision b68acc78

Von Jan Büren vor mehr als 1 Jahr hinzugefügt

  • ID b68acc78968e732b2b6f4bd17e54d3f1d728a5a5
  • Vorgänger 5bb76a79
  • Nachfolger 5cb6779a

Leichte Überarbeitung visuell/inhaltlich Druckvorlagensatz marei

Unterschiede anzeigen:

doc/dokumentation.xml
579 579
    </sect1>
580 580
    <sect1 id="Installation mittels Ansible"
581 581
	   xreflabel="Inatallation mittels Ansible">
582
      <title>Installation mittels Ansible</title>
583
      <para>
584
        Kivitendo lässt sich auch mithilfe von Ansible installieren.
585
      </para>
582
      <title>Installation mittels Ansible auf Ubuntu 22.04</title>
586 583
      <para>
587 584
        Ansible ist ein Open-Source-Automatisierungstool, das verwendet
588 585
        wird, um die Bereitstellung, Konfiguration und Verwaltung von
589 586
        IT-Systemen zu automatisieren. Dabei führt es Aufgaben über SSH auf
590 587
        entfernten Rechnern (Hosts) aus. Die Aufgaben werden dabei
591
        deklarativ als YAML Dateien, den sogenannten Playbooks , übergeben.
592
      </para>
593
      <para>
594
        Um die installation von Kivitendo einfacher zu gestalten liegt ein
595
        Playbook im scripts Ordner, welches die Installation von Kivitendo
596
        auf einer Ubuntu Umgebung automatisiert.
588
        deklarativ als YAML Dateien, den sogenannten Playbooks, übergeben.
589
        Benötigt wird lediglich python und ansible ab Version 2.10.
597 590
      </para>
598 591
      <para>
599
        Zur Installation mit Ansible liegt auf dem Git Repository im ansible
600
        Ordner mit dem benötigtem Playbook und Konfigurationsdateien.
592
        Alle benötigten Konfigurationsdateien und das Playbook sind auf dem kivitendo github Account
593
        unter dem Repository namens <ulink
594
      url="https://github.com/kivitendo/kivitendo-ansible">kivitendo-ansible</ulink> verfügbar.
595
        Das Repo kann lokal mit folgendem git-Befehl "geklont" werden:
596
    <programlisting>git clone https://github.com/kivitendo/kivitendo-ansible</programlisting>
597
      In diesem Repository befindet sich auch eine Readme.md, die aktuelle Installationshinweise auf englisch enthält.
601 598
      </para>
602 599
      <para>
603
        Um die installation zu starten wechseln sie zunächst in den Order
604
        <literal>scripts/ansible</literal> und führen dann folgenden Befehl
605
        aus.
600
        Um die Installation zu starten,  wechseln Sie dann zunächst in den erstellten Ordner 'kivitendo-ansible' und
601
        editieren die Datei inventory.
602

  
603
        <programlisting>cd kivitendo-ansible
604
vim inventory</programlisting>
605

  
606
        Der/die Hosts auf denen Kivitendo installiert werden soll wird dann in
607
        dieser Datei ('inventory') eingefügt, bspw. die
608

  
609
        <programlisting>192.168.1.121</programlisting>
610
        oder als Namen:
611
        <programlisting>kivi.meine-lokale-domaene.de</programlisting>
612
        Zusätzliche Parameter könnten erforderlich sein, bspw. der Benutzer für den SSH-Login:
613
        <programlisting>kivi.meine-lokale-domaene.de ansible_user=myuser</programlisting>
606 614
      </para>
607
      <programlisting>
608
    ansible-playbook --ask-become-pass main.yaml --extra-vars&quot;target=ZIEL_RECHNER&quot;
609
    </programlisting>
610 615
      <para>
611
        Der/die Hosts auf denen Kivitendo installiert werden soll wird in
612
        der Variable target übergeben. Als nächstes werden sie von Ansible
616
      Danach kann das Playbook mittels:
617
      <programlisting>ansible-playbook --ask-become main.yml</programlisting>
618
        ausgeführt werden, je nach Konfiguration wird man noch
613 619
        aufgefordert das BECOME password einzutragen, hierbei handelt es
614
        sich um das Passwort des nutzers, über den die Installation laufen
615
        wird.
620
        sich um das Passwort des Benutzers, über den die Installation dann auf dem Ziel-Rechner ausgeführt wird.
616 621
      </para>
617 622
      <para>
618
        Nach ausführen des Playbooks ist Kivitendo über den Browser
623
        Nach erfolgreichen Ausführen des Playbooks ist Kivitendo dann über den Browser
619 624
        erreichbar unter
620 625
        <literal>http://&lt;IP des rechners&gt;/kivitendo-erp/</literal>
621 626
      </para>
......
624 629
        werden. Dies kann über die Weboberfläche getan werden, indem man
625 630
        sich mit dem Passwort <literal>admin123</literal> in der
626 631
        Administrationsoberfläche anmeldet.
632
        Weitere Details siehe Abschnitt "<xref
633
            linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
627 634
      </para>
628 635
    </sect1>
629 636
    <sect1 id="Manuelle-Installation-des-Programmpaketes"
......
2301 2308
        <filename>./templates/[Neuer Name]</filename></para>
2302 2309
      </sect2>
2303 2310
 <sect2 id="Aufbau des marei Vorlagensatzes">
2304
  <title>Aufbau des marei Vorlagensatzes</title>
2311
  <title>Der Druckvorlagensatz marei</title>
2312
          <note id="marei.document.link">
2313
            <para>Die aktuelle Dokumentation inkl. dem Foliensatz vom kivi-Treffen im August 2023 befindet sich hier:
2314
            <ulink url="https://peitex.de/materialien/2023-08-04_kivitendo/"> https://peitex.de/materialien/2023-08-04_kivitendo/</ulink>
2315
            </para>
2316
          </note>
2305 2317

  
2306 2318
  <sect3 id="Quickstart – Wo kann was angepasst werden?">
2307 2319
    <title>Quickstart – Wo kann was angepasst werden?</title>
2308

  
2320
    <note id="do-not-edit-marei">
2309 2321
    <para>In keinem Fall sollten Dateien mit der Endung <filename>*.cls</filename> oder <filename>*.sty</filename> geändert werden. Durch Änderungen an diesen Dateien verhindert man Updates auf neuer Versionen.
2310 2322
    Zwar kopiert kivitendo die Datei und bearbeitet diese beim Update nicht. Allerdings sind sämtliche Änderungen über die Konfigurationsdateien möglich und erhöhen die Wartbarkeit.</para>
2311

  
2323
    </note>
2312 2324
    <itemizedlist>
2313 2325
      <listitem>
2314 2326
        <para><filename>insettings.tex</filename> :</para>
......
2349 2361
                              Dafür eine Sprache mit Vorlagenkürzel DE anlegen
2350 2362
        \item[english.tex] Textschnipsel für Englisch\\
2351 2363
                              Dafür eine Sprache mit Vorlagenkürzel EN anlegen
2352
        \end{description}
2353
        </programlisting>
2364
        \end{description}</programlisting>
2354 2365
    </itemizedlist>
2355 2366

  
2356 2367
    <para>Alle dokumententypspezifischen Einstellungen müssen in der jeweiligen Template-Datei modifiziert werden.</para>
......
2447 2458
    von |\setupCurrencyConfig| anpassen, z.B.</para>
2448 2459

  
2449 2460
    <programlisting>
2450
    \setupCurrencyConfig[chf]{\identpath}{\lxcurrency}
2451
    </programlisting>
2461
    \setupCurrencyConfig[chf]{\identpath}{\lxcurrency}</programlisting>
2452 2462
    <para>für Schweizer Franken als Standardwährung.</para>
2453 2463

  
2454 2464

  
......
2490 2500
    <para>Neben den in Abschnitt \ref{sec:options}  beschriebenen Optionen zum Abschalten der Fußzeile kann
2491 2501
    der Inhalt der Fußzeile über die \pck{scrlayer-scrpage} Makros, wie</para>
2492 2502
    <programlisting>
2493
      \cfoot[|\meta{Inhalt auf der ersten Briefseite}|]{|\meta{Inhalt auf folgenden Briefseiten}|}
2494
    </programlisting>
2503
      \cfoot[|\meta{Inhalt auf der ersten Briefseite}|]{|\meta{Inhalt auf folgenden Briefseiten}|}    </programlisting>
2495 2504

  
2496 2505
    <para>geändert werden.</para>
2497 2506

  
......
2499 2508
    Hierfür wird das Makro |\ourhead| in der <filename>insettings.tex</filename> definiert.</para>
2500 2509

  
2501 2510
    <programlisting>
2502
      \DescribeMacro{\ourhead}\marg{Bezeichner}\marg{Eintrag}\marg{Titel}\marg{Nummer}\marg{Datum}
2503
    </programlisting>
2511
      \DescribeMacro{\ourhead}\marg{Bezeichner}\marg{Eintrag}\marg{Titel}\marg{Nummer}\marg{Datum}    </programlisting>
2504 2512

  
2505 2513
    <para>Diese Definition kann ebenfalls über die <filename>insettings.tex</filename> angepasst oder auch nachträglich überschrieben werden:</para>
2506 2514

  
......
2538 2546
      \smallskip
2539 2547
      Erzeugt mit dem Aufruf
2540 2548
      \ourhead{arg1}{arg2}{arg3}{arg4}{arg5}
2541
      \endgroup
2542
    </programlisting>
2549
      \endgroup    </programlisting>
2543 2550

  
2544 2551

  
2545 2552
  </sect3>
......
2571 2578
          \locationentry{fromphone}
2572 2579
          \locationentry*{fromemail}
2573 2580
        }
2574
      }
2575
    </programlisting>
2581
      }    </programlisting>
2576 2582

  
2577 2583
    <para>Um die Reihenfolge der Variablenausgabe zu verändern, kann diese Definition als Basis in
2578 2584
    die <filename>insettings.tex</filename> oder <filename>ident.tex</filename> (Falls nur für eine Firma) kopiert und dort entsprechend modifiziert werden.</para>
......
2581 2587

  
2582 2588

  
2583 2589
  </sect3>
2584
</sect2>
2585
<sect2 id="Allgemeine TeXnische Hinweise">
2590
<sect3 id="Allgemeine TeXnische Hinweise">
2586 2591
  <title>Allgemeine TeXnische Hinweise</title>
2587 2592

  
2588 2593

  
2589
  <sect3 id="Änderung der Basisschriftart">
2594
  <sect4 id="Änderung der Basisschriftart">
2590 2595
    <title>Änderung der Basisschriftart</title>
2591 2596

  
2592 2597
    <para>\LaTeX{} kann grundsätzlich beliebige Schriftarten verwenden. Hierfür sollte allerdings immer darauf geachtet werden,
......
2601 2606
    Mandant*innen gelten soll oder in der Mantant*innenspezifischen Konfigurationsdatei gsesetzt.</para>
2602 2607

  
2603 2608

  
2604
    <sect4>
2609
    <sect5>
2605 2610
      <title>Änderung, falls es ein Schriftpaket gibt</title>
2606 2611

  
2607 2612
      <para>Wenn möglich sollte die Schriftart über ein entsprechendes Konfigurationspaket gesetzt werden.
2608 2613
        Ob ein solches existiert kann man sehr leicht über eine Suche nach dem Namen unter \url{ctan.org} herausfinden.</para>
2609 2614

  
2610
    </sect4>
2615
    </sect5>
2611 2616

  
2612
    <sect4>
2617
    <sect5>
2613 2618
      <title>Änderung der Basisschriftart auf eine Schriftart mit Serifen</title>
2614 2619

  
2615 2620
    <programlisting>
2616
      \setmainfont{|\meta{Name der Schriftart, z.B. SourceSerifPro}|}
2617
    </programlisting>
2621
      \setmainfont{|\meta{Name der Schriftart, z.B. SourceSerifPro}|}    </programlisting>
2618 2622

  
2619
    </sect4>
2623
    </sect5>
2620 2624

  
2621
    <sect4>
2625
    <sect5>
2622 2626
      <title>Änderung der Basisschriftart auf eine Schriftart ohne Serifen</title>
2623 2627

  
2624 2628
    <programlisting>
2625 2629
      \setsansfont{|\meta{Name der Schriftart, z.B. SourceSansPro}|}
2626
      \renewcommand*{\familydefault}{\sfdefault}
2627
    </programlisting>
2630
      \renewcommand*{\familydefault}{\sfdefault}    </programlisting>
2628 2631

  
2629
    </sect4>
2632
    </sect5>
2630 2633

  
2631 2634

  
2632
  </sect3>
2633
  <sect3 id="Unterscheidungen durch String-Vergleich">
2635
  </sect4>
2636
  <sect4 id="Unterscheidungen durch String-Vergleich">
2634 2637
    <title>Unterscheidungen durch String-Vergleich</title>
2635 2638

  
2636 2639
    <programlisting>
2637
    \Ifstr{\lxmedia}{printer}{Falls gedruckt werden soll} {sonst}
2638
    </programlisting>
2640
    \Ifstr{\lxmedia}{printer}{Falls gedruckt werden soll} {sonst}    </programlisting>
2641
  </sect4>
2639 2642
  </sect3>
2640 2643
</sect2>
2641 2644
      <sect2 id="Vorlagen-RB">

Auch abrufbar als: Unified diff