Konsolen-Anwendungen
Beschreibung der Konsolen-Hilfsprogramme.
KeyHelp-Toolbox
Einleitung
Mit der KeyHelp-Toolbox steht dem Serveradministrator ein Hilfsprogramm zur Verfügung, mit dessen Hilfe sich eine Reihe von KeyHelp Funktionen über die Kommandozeile steuern lassen. Darüber hinaus stehen Optionen zur Verfügung, die über die KeyHelp-Web-Oberfläche nicht abgebildet sind.
Dieses Tool ist für eine interaktive Bedienung konzipiert. Möchten Sie dagegen KeyHelp Funktionen auf nicht interaktive Weise steuern (z.B. innerhalb von Skripten), können Sie zum Beispiel das Kommandozeilen-Dienstprogramm nutzen.
Aufruf & Bedienung
Um die Toolbox aufzurufen, verbinden Sie sich zunächst mit Ihrem Server. Anschließend rufen Sie den folgenden Befehl über die Kommandozeile auf.
keyhelp-toolbox
Sie befinden Sich nun im Hauptmenü der Toolbox.
Um zur gewünschten Funktion zu gelangen, tippen Sie die hervorgehobene Ziffer oder den Buchstaben vor dem entsprechenden Menüpunkt ein und betätigen Sie dies mit der Enter
Taste.
Funktionen
Über die Toolbox stehen Ihnen verschiedene Funktionen zur Verfügung, die nachfolgend genauer erläutert werden.
Neuschreiben von Benutzer-Konfigurationsdateien
Mit dieser Funktion können Sie ein Neuschreiben sämtlicher Konfigurationsdateien der im KeyHelp angelegten Benutzer auslösen.
Im Detail werden somit die benutzerspezifischen Konfigurationen des Webservers (Apache), des DNS-Servers (Bind) und des PHP-Process Managers (PHP-FPM) neugeschrieben und angewendet.
Wartungsmodus deaktivieren
Über das KeyHelp-Benutzerinterface lässt sich die Web-Oberfläche in einen Wartungsmodus versetzen. Fortan ist es nur noch Benutzern mit zuvor festgelegten IPs gestattet, KeyHelp aufzurufen. Ändert sich jedoch die IP des Benutzers, besteht die Gefahr, dass man vom Benutzerinterface ausgesperrt wird.
Über diese Funktion können Sie den Wartungsmodus aufheben und sich somit wieder Zugang zur Web-Oberfläche verschaffen.
Anmeldebeschränkungen für Administratorkonten deaktivieren
Über die KeyHelp-Oberfläche können Sie den Zugang zu den Administratorkonten auf bestimmte IPs und IP-Bereiche beschränken. Ändert sich jedoch die IP des Benutzers, besteht die Gefahr, dass man vom Benutzerinterface ausgesperrt wird.
Über diese Funktion können Sie die Anmeldebeschränkung für Administratorkonten aufheben und somit Administratoren wieder Zugang zur Web-Oberfläche ermöglichen.
Zwei-Faktor-Authentisierung deaktivieren
Wenn der Login für Benutzeraccounts über eine Zwei-Faktor-Authentisierung geschützt wird, ist ein Login ohne den zweiten Faktor für diesen Benutzeraccount fortan nicht mehr möglich. Sollte nun der zweite Faktor verloren gegangen sein, wäre folglich auch kein Login in die Benutzeroberfläche mehr möglich.
Mit Hilfe dieser Funktion kann die Zwei-Faktor-Authentisierung für beliebige Benutzer-Accounts deaktiviert und somit wieder Zugang zur Web-Oberfläche ermöglicht werden.
Template-Cache löschen
Wenn Sie an einem eigenen Theme für KeyHelp arbeiten, kann es notwendig sein, den Template-Cache regelmäßig zu löschen, andernfalls kann es passieren, dass die getätigten Änderungen an den Themedateien nicht korrekt angezeigt werden und veraltete Inhalte aus dem Cache ausgeliefert werden.
Wartungsaufgaben starten
In regelmäßigen Abständen führt KeyHelp Wartungsarbeiten durch, um so die optimale Lauffähigkeit Ihres Servers sicherzustellen. Normalerweise werden diese Aufgaben automatisch durch KeyHelp ausgelöst, sobald diese von Nöten sind.
Über diese Funktion können Sie alle zur Verfügung stehenden Wartungsaufgaben aber auch selbst auslösen.
Systeminformationen anzeigen
Dieser Funktion präsentiert Ihnen auf einen Blick die wichtigsten Informationen über Ihren Server sowie die Versionsnummern der darauf installierten Software.
Kommandozeilen-Dienstprogramm
Einleitung
Das KeyHelp-Dienstprogramm soll Administratoren und Entwickler dabei unterstützen, auf ausgewählte KeyHelp-Funktionen zugreifen zu können.
Dieses Tool ist für eine nicht-interaktive Bedienung konzipiert.
Aufruf & Bedienung
Um auf die Funktionen des Programm zuzugreifen, verbinden Sie sich zunächst mit ihrem Server. Anschließend rufen es über folgenden Befehl über die Kommandozeile auf.
keyhelp [command]
Für [command]
setzen Sie den Namen der Funktion ein, auf die Sie zugreifen möchten.
Ein Aufruf ohne [command]
zeigt die Hilfeseite des Befehls und zeigt alle zur Verfügung stehenden Funktionen an.
Funktionen
Befehl: help
keyhelp help [command]
Dieser Befehl zeigt die Hilfeseite des Dienstprogramms an.
Über den Optionalen Parameter [command]
können Sie sich die Hilfeseite des gewünschten Befehls anzeigen lassen.
Befehl: login
keyhelp login [username]
Dieser Befehl erzeugt eine URL, mit der Sie sich bei Aufruf über einen Webbrowser in das entsprechende Benutzerkonto einloggen können.
Über den Parameter [username]
bestimmen Sie, für welchen Benutzeraccount die URL generiert werden soll.
Wird kein [username]
angegeben wird die URL für den ersten Hauptadministrator generiert.
Die erzeugten Login-URLs sind nur für einen kurzen Zeitraum gültig.
Befehl: db-login
keyhelp db-login
Dieser Befehl erzeugt eine URL, mit der Sie sich bei Aufruf über einen Webbrowser in die derzeit konfigurierte Datenbank-Verwaltungssoftware einloggen können.
Der so erzeugte Zugang ermöglicht den Zugriff auf sämtliche Datenbanken und verfügt über volle root-Berechtigungen.
Die erzeugten Login-URLs sind nur für einen kurzen Zeitraum gültig.
Befehl: run
keyhelp run [name]
Dieser Befehl führt das Wartungsintervall mit dem angegebenen Namen aus.
Wird kein [name]
angegeben wird das Wartungsintervall update
ausgeführt.
Befehl: toolbox
keyhelp toolbox
Dieser Befehl öffnet das interaktive Konsolen-Programm KeyHelp-Toolbox.
Befehl: version
keyhelp version
Dieser Befehl zeigt Versionsinformationen an.