# KeyHelp Installation

Um KeyHelp zu installieren, reicht der Aufruf eines einzelnen Befehls. Anschließend werden Sie vom Assistenten durch die Installation geführt. Während der Installation werden alle notwendigen Dienste installiert und konfiguriert, so dass Sie sich um nichts weiter kümmern müssen. Nach Abschluss der Installation können Sie sofort mit der Administration ihres Servers beginnen.

### Systemvoraussetzungen

- Betriebssystem: Ubuntu LTS oder Debian
- Arbeitsspeicher: Mindestens 1 GB RAM
- Architektur: 64-Bit Betriebssystem (amd64 oder arm64)
- Die Installation muss auf einem sauberen System (Minimal-Image), frei von installierter / vorkonfigurierter Software erfolgen. Sämtliche benötigten Dienste werden durch KeyHelp installiert und konfiguriert.
- Die Installation muss als root-Benutzer durchgeführt werden.

### Installation von KeyHelp

1. Verbinden Sie sich über SSH als Benutzer **root** mit Ihrem Server.
2. Führen Sie den folgenden Befehl über die Kommandozeile aus.  
      
    ```shell
    wget https://install.keyhelp.de/get_keyhelp.php -O install_keyhelp.sh ;
    bash install_keyhelp.sh ;
    ```
3. Die Installation wird nun vorbereitet und der Installationsassistent gestartet.  
    Im Assistenten haben Sie die Möglichkeit, diverse Installationsparameter anzupassen.
4. Bestätigen Sie den Beginn der Installation über den Menüpunkt **Installation starten**.
5. Nach Abschluss der Installation wird Ihr System neu gestartet.

Jetzt sind alle Arbeiten abgeschlossen und Sie können mit der Administration Ihres KeyHelp-Servers beginnen.

<p class="callout info">Die Zugangsdaten für Ihren primären Administrator- und Datenbank-Account finden Sie in der Datei **/root/keyhelp\_login\_data\_\***.</p>

<p class="callout warning">Wenn Sie die Meldung **FEHLER: Dem Zertifikat von »install.keyhelp.de« wird nicht vertraut.** erhalten, stehen Ihnen verschiedene Möglichkeiten der Problemlösung zur Verfügung:  
  
- Fügen Sie dem **wget** Befehl den Parameter **--no-check-certificate** hinzu.  
- Installieren Sie das Paket **ca-certificates** mit dem Befehl **apt install ca-certificates**.  
- Führen Sie den Befehl **apt update &amp;&amp; apt upgrade** aus.  
</p>

<p class="callout warning">KeyHelp bietet keinen Uninstaller an.  
Wenn Sie KeyHelp und die im Zuge der Installation konfigurierten Dienste entfernen möchten, müssen Sie Ihren Server manuell zurücksetzen.</p>

### Installation von KeyHelp automatisieren

Für eine nicht-interaktive Steuerung der Installation über Skripte bietet die KeyHelp-Installation folgende Parameter.

<table border="1" id="bkmrk-parameter-bedeutung-" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 34.3645%;">**Parameter**</td><td style="width: 65.6355%;">**Bedeutung**</td></tr><tr><td style="width: 34.3645%;">--non-interactive</td><td style="width: 65.6355%;">Führt die Installation ohne Rückfragen und Benutzerinteraktion durch.</td></tr><tr><td style="width: 34.3645%;">--no-reboot </td><td style="width: 65.6355%;">Unterbindet den Reboot im Anschluss an die Installation.</td></tr><tr><td style="width: 34.3645%;">--notification=&lt;EMAIL ADDRESS&gt;</td><td style="width: 65.6355%;">Sendet nach Abschluss der Installation eine E-Mail an die angegebene E-Mail-Adresse.</td></tr><tr><td style="width: 34.3645%;">--language=&lt;LANGUAGE\_CODE&gt;</td><td style="width: 65.6355%;">Legt die Standardsprache von KeyHelp und seiner Komponenten fest.</td></tr><tr><td style="width: 34.3645%;">--extended-log </td><td style="width: 65.6355%;">Protokolliert alles, auch sensible Daten wie Passwörter etc.</td></tr><tr><td style="width: 34.3645%;">--preferred-protocol=&lt;PROTOCOL&gt;</td><td style="width: 65.6355%;">Legt das bevorzugte Protokoll bei der Kommunikation mit den Installationsservern fest.

\[ipv4 / ipv6 / none\]

</td></tr><tr><td style="width: 34.3645%;">--hostname-fqdn=&lt;SERVER\_DOMAIN&gt;</td><td style="width: 65.6355%;">Der vollständig qualifizierte Domainname (FQDN).

Beispiel: 'keyhelp.example.com'

</td></tr><tr><td style="width: 34.3645%;">--server-fqdn=&lt;SERVER\_DOMAIN&gt;</td><td style="width: 65.6355%;">Alias für --hostname-fqdn \[Veraltet\]</td></tr><tr><td style="width: 34.3645%;">--admin-username=&lt;USERNAME&gt;</td><td style="width: 65.6355%;">Login-Name für das KeyHelp-Administrator-Konto.

</td></tr><tr><td style="width: 34.3645%;">--admin-password=&lt;PASSWORD&gt; </td><td style="width: 65.6355%;">Passwort für das KeyHelp-Administrator-Konto.

Mindestens 6 Zeichen.

</td></tr><tr><td style="width: 34.3645%;">--admin-email=&lt;EMAIL\_ADDRESS&gt;</td><td style="width: 65.6355%;">E-Mail-Adresse für das KeyHelp-Administrator-Konto.</td></tr></tbody></table>

Mit folgendem Befehl wird KeyHelp ohne Benutzerinteraktion installiert. Es wird ein Administratorkonto mit dem Namen `my-admin` und dem Passwort `my-password-123` angelegt. Im Anschluss an die Installation wird eine Email an `info@example.com` gesendet, um über den Abschluss der Installation zu informieren.

```shell
wget https://install.keyhelp.de/get_keyhelp.php -O install_keyhelp.sh ;
bash install_keyhelp.sh --non-interactive --admin-username="my-admin" --admin-password="my-password-123" --notification="info@example.com";
```

### Installationsprotokoll

Alle Aktionen während der Installation werden im Installationsprotokoll unter `/var/log/keyhelp/install.log` protokolliert.  
Sollten während der Installation Fehler auftreten, kann der Fehler-verursachende Befehl sowie dessen Ursachen anhand dieses Protokolls ermittelt werden. Durchsuchen Sie hierzu die genannte Datei nach dem Schlüsselwort **ERROR DETECTED**.