KeyHelp Installation

UmTo KeyHelpinstall zuKeyHelp, installieren,it reichtis derenough Aufrufto einescall einzelnena Befehls.single Anschließendcommand. werdenAfter Siethat, vomthe Assistentenwizard durchwill dieguide Installationyou geführt.through Währendthe derinstallation. InstallationDuring werdenthe alleinstallation, notwendigenall Dienstethe installiertnecessary undservices konfiguriert,will be installed and configured, so dassyou Siedon't sichhave umto nichtsworry weiterabout kümmernanything müssen.else. NachAfter Abschlussthe derinstallation Installationis könnencomplete, Sieyou sofortcan mitimmediately derstart Administrationadministering ihresyour Servers beginnen.server.

SystemvoraussetzungenSystem requirements

• Betriebssystem:Operating system: Ubuntu LTS oderor Debian
• Arbeitsspeicher:Memory: MindestensAt least 1 GB RAM
  
• Architektur:Architecture: 64-Bitbit Betriebssystemoperating system (amd64 oderor arm64)
  
• Die Installation mussmust aufbe einemperformed sauberenon Systema clean system (Minimal-Image)minimal image), freifree vonof installierterinstalled / vorkonfigurierterconfigured Softwaresoftware. erfolgen.All Sämtlicherequired benötigtenservices Diensteare werdeninstalled durchand KeyHelpconfigured installiertby und konfiguriert.KeyHelp.
• DieThe Installationinstallation mussmust alsbe root-Benutzerperformed durchgeführtas werden.root user.

Installation vonInstalling KeyHelp

1. VerbindenConnect Sieto sichyour überserver via SSH als Benutzeras root mit Ihrem Server.user.
   
2. FührenRun Siethe denfollowing folgendencommand Befehlfrom überthe diecommand Kommandozeile aus.line.
   
   

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

3. DieThe Installationinstallation wirdis nunnow vorbereitetbeing undprepared derand Installationsassistentthe gestartet.installation wizard is started.
   ImThe Assistentenwizard habenallows Sieyou dieto Möglichkeit,adjust diversevarious Installationsparameterinstallation anzupassen.parameters.
4. BestätigenConfirm Siethe denstart Beginnof derthe Installationinstallation übervia den Menüpunktthe InstallationStart starteninstallation. menu item.
5. NachAfter Abschlussthe derinstallation Installationis wirdfinished, Ihryour Systemsystem neuwill gestartet.
   be restarted.

JetztNow sindall allethe Arbeitenwork abgeschlossenhas undbeen Siecompleted könnenand mityou dercan Administrationstart Ihresadministrating KeyHelp-Serversyour beginnen.KeyHelp server.

DieThe Zugangsdatenlogin fürcredentials Ihrenfor primärenyour Administrator-primary undadministrator Datenbank-Accountand findendatabase Sieaccount can be found in der Dateithe /root/keyhelp_login_data_*. file.

WennIf Sieyou diereceive Meldungthe message FEHLER:ERROR: DemThe Zertifikatcertificate vonof »'install.keyhelp.de«de' wirdis nichtnot vertraut.trusted. erhalten,you stehenhave Ihnenseveral verschiedeneoptions Möglichkeitento dersolve Problemlösungthe zur Verfügung:problem:

- FügenAdd Sie dem wget Befehl den Parameterthe --no-check-certificate hinzu.parameter to the wget command.
- InstallierenInstall Sie das Paketthe ca-certificates mitpackage demwith Befehlthe apt install ca-certificates. command.
- FührenRun Sie den Befehlthe apt update && apt upgrade aus.command.

KeyHelp bietetdoes keinennot Uninstallerprovide an.an uninstaller.
WennIf Sieyou want to remove KeyHelp undand diethe imservices Zugeconfigured derduring Installationthe konfigurierteninstallation, Diensteyou entfernenmust möchten,manually müssenreset Sieyour Ihren Server manuell zurücksetzen.server.

InstallationAutomate voninstallation of KeyHelp

For non-interactive control of the installation via scripts, KeyHelp automatisiereninstallation

Fürprovides einethe nicht-interaktivefollowing Steuerung der Installation über Skripte bietet die KeyHelp-Installation folgende Parameter.
parameters.

Parameter	BedeutungDescription
--non-interactive	FührtPerforms diethe Installationinstallation ohnewithout Rückfragenprompting undor Benutzerinteraktionuser durch.interaction.
--no-reboot	UnterbindetPrevents denthe Rebootreboot imat Anschlussthe anend dieof Installation.the installation.
--notification=<EMAIL ADDRESS>	Sendet nach Abschluss der Installation eine E-MailSends an dieemail angegebeneto E-Mail-Adresse.the specified email address after the installation is complete.
--language=<LANGUAGE_CODE>	LegtSets diethe Standardsprachedefault vonlanguage of KeyHelp undand seinerits Komponenten fest.components.
--extended-log	ProtokolliertLogs alles,everything, auchincluding sensiblesensitive Datendata wiesuch Passwörteras passwords etc.
--preferred-protocol=<PROTOCOL>	LegtSets dasthe bevorzugtepreferred Protokollprotocol beiwhen dercommunicating Kommunikationwith mitthe deninstall Installationsservern fest.servers. [ipv4 / ipv6 / none]
--hostname-fqdn=<SERVER_DOMAIN>	DerThe vollständigfully qualifiziertequalified Domainnamedomain name (FQDN). Beispiel:Example: 'keyhelp.example.com'
--server-fqdn=<SERVER_DOMAIN>	Alias fürfor --hostname-fqdn [Veraltet]Deprecated]
--admin-username=<USERNAME>	Login-NameLogin fürname dasfor KeyHelp-Administrator-Konto.the KeyHelp administrator account.
--admin-password=<PASSWORD>	PasswortPassword fürfor dasthe KeyHelp-Administrator-Konto.KeyHelp administrator account. MindestensAt least 6 Zeichen.characters.
--admin-email=<EMAIL_ADDRESS>	E-Mail-AdresseEmail füraddress dasfor KeyHelp-Administrator-Konto.the KeyHelp administrator account.

The

Mitfollowing folgendemcommand Befehl wirdinstalls KeyHelp ohnewithout Benutzerinteraktionuser installiert.interaction. EsAn wirdadministrator einaccount Administratorkontois mitcreated demwith Namenthe name my-admin undand demthe Passwortpassword my-password-123. angelegt.After Imthe Anschlussinstallation, an dieemail Installationis wirdsent eine Email anto info@example.com gesendet,to uminform überabout denthe Abschlusscompletion derof Installationthe zu informieren.installation.

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";

InstallationsprotokollInstallation log

AlleAll Aktionenoperations währendduring derthe Installationinstallation werdenare imlogged Installationsprotokollin unterthe installation log under /var/log/keyhelp/install.log.
If protokolliert.
Solltenany währenderrors deroccur Installationduring Fehlerthe auftreten,installation, kannthe dererror-causing Fehler-verursachendecommand Befehland sowieits dessencauses Ursachencan anhandbe diesesdetermined Protokollsfrom ermitteltthis werden.log. DurchsuchenTo Siedo hierzuthis, diesearch genanntethe Dateiabove nachfile demfor Schlüsselwortthe ERROR DETECTED. keyword.