Installation

KeyHelp wird über ein Installationsskript direkt auf Ihrem Server eingerichtet. Das Skript lädt alle benötigten Komponenten herunter, installiert die erforderlichen Dienste und konfiguriert sie vollständig vor. Ein manuelles Einrichten von Webserver, Datenbank, Mailsystem o. Ä. ist nicht notwendig.

Systemvoraussetzungen

Bitte beachten Sie vor der Installation die folgenden Voraussetzungen.

Unterstützte Betriebssysteme

KeyHelp setzt ein 64-Bit-Betriebssystem voraus. Unterstützt werden derzeit die folgenden Distributionen:

Distribution	Version	Unterstützt bis
Ubuntu	24.04 LTS „Noble Numbat“	30. April 2029
	22.04 LTS „Jammy Jellyfish“	30. April 2027
Debian	13 „Trixie“	30. Juni 2030
	12 „Bookworm“	30. Juni 2028

Hardware-Anforderungen

Architektur: amd64 oder arm64
Arbeitsspeicher: mindestens 2 GB RAM, empfohlen ab 4 GB RAM

Der tatsächliche Arbeitsspeicherbedarf hängt von der Anzahl der Kunden und Domains sowie von den eingesetzten Diensten ab.

Systemzustand

Die Installation muss auf einem sauberen System (Minimal-Image) erfolgen, das frei von installierter oder konfigurierter Software ist. Sämtliche für den Betrieb des Servers benötigten Dienste werden durch KeyHelp installiert und konfiguriert.

Wichtig

Vorhandene Konfigurationen können zu Konflikten führen und werden gegebenenfalls überschrieben. Installieren Sie KeyHelp niemals auf einem System, auf dem bereits ein anderes Control Panel oder manuell eingerichtete Dienste betrieben werden.

Manuelle Installation

Loggen Sie sich als root-Benutzer auf Ihrem Server ein und führen Sie den folgenden Befehl aus:

BASH

wget https://install.keyhelp.de/install_keyhelp.sh -O install_keyhelp.sh ; bash install_keyhelp.sh ;

Nach Ausführung des Befehls führt KeyHelp Sie durch die Installation. Sie werden dabei nach dem vollständigen Hostnamen (FQDN) des Servers sowie nach den Zugangsdaten für das Administrator-Konto gefragt. Nach Abschluss der Installation können Sie KeyHelp sofort uneingeschränkt nutzen.

Hinweis bei Zertifikatsfehlern

Erhalten Sie die Meldung „FEHLER: Dem Zertifikat von »install.keyhelp.de« wird nicht vertraut.“, fehlen auf Ihrem System die Stammzertifikate. Sie haben zwei Möglichkeiten:

Installieren Sie das Paket ca-certificates nach:
BASH
```
apt install ca-certificates
```

Oder ergänzen Sie den wget-Parameter mit --no-check-certificate:

BASH

wget --no-check-certificate https://install.keyhelp.de/install_keyhelp.sh -O install_keyhelp.sh ; bash install_keyhelp.sh ;

Automatische Installation

KeyHelp lässt sich vollständig ohne Benutzerinteraktion installieren.

Die Installation besteht aus zwei Ebenen: dem Installationsskript install_keyhelp.sh, das KeyHelp herunterlädt, und dem eigentlichen Installer /home/keyhelp/www/keyhelp/install/install.php. Alle Argumente, die install_keyhelp.sh nicht selbst kennt, werden unverändert an install.php weitergereicht. Sie können also sämtliche Parameter direkt beim Aufruf des Installationsskripts angeben.

BASH

wget https://install.keyhelp.de/install_keyhelp.sh -O install_keyhelp.sh ;
bash install_keyhelp.sh \
    --non-interactive \
    --hostname-fqdn=keyhelp.example.com \
    --admin-username=keyadmin \
    --admin-password=IhrSicheresPasswort \
    --admin-email=admin@example.com \
    --language=de \
    --notification=admin@example.com ;

Installationsparameter

Option	Beschreibung
--non-interactive	Führt die Installation ohne Benutzerinteraktion durch.
--no-reboot	Unterbindet den Reboot im Anschluss an die Installation.
--notification=<EMAIL_ADRESSE>	Sendet nach Abschluss der Installation eine E-Mail an die angegebene Adresse.
--language=<SPRACHE>	Legt die Standardsprache von KeyHelp und seiner Komponenten fest. Format: 2- bzw. 5-stelliger Sprachcode (de, en, fr, pt_BR, zh_TW, ...). Standard: Wird automatisch ermittelt.
--log-sensitive-data	Schreibt sensible Daten wie Passwörter im Klartext in das Installationsprotokoll, statt sie unkenntlich zu machen.
--preferred-protocol=<PROTOKOLL>	Legt das bevorzugte Protokoll bei der Kommunikation mit den Installationsservern fest. Werte: ipv4, ipv6, none. Standard: ipv4
--hostname-fqdn=<HOSTNAME>	Der vollständig qualifizierte Domainname (FQDN) des Servers, z. B. keyhelp.example.com. Standard: Wird automatisch ermittelt.
--admin-username=<BENUTZERNAME>	Login-Name für das KeyHelp-Administrator-Konto. Standard: keyadmin
--admin-password=<PASSWORT>	Passwort für das KeyHelp-Administrator-Konto. Mindestens 10 Zeichen. Standard: Wird automatisch erzeugt.
--admin-email=<EMAIL_ADRESSE>	E-Mail-Adresse für das KeyHelp-Administrator-Konto. Standard: root@<HOSTNAME>

Achtung

Passwörter, die als Kommandozeilenparameter übergeben werden, landen in der Shell-History und sind über die Prozessliste einsehbar. Vergeben Sie nach der Installation im Bedarfsfall ein neues Passwort.

Zugangsdaten

Im Anschluss an die Installation finden Sie die Zugangsdaten zur KeyHelp-Oberfläche und der Datenbank-Administration in der Datei /root/keyhelp_login_data_<INSTALLATIONSDATUM>.

Installationsprotokoll

Das Installationsprotokoll einschließlich etwaiger protokollierter Fehlermeldungen finden Sie unter /var/log/keyhelp/install.log.

Deinstallation

Wir bieten keinen Uninstaller an. Wenn Sie KeyHelp entfernen möchten, müssen Sie den Server manuell zurücksetzen.