Mobile Webseite EE¶
Installation¶
Die Mobile Webseite ist so konzipiert, dass Sie auf einem eigenen Server betrieben werden kann.
Um eine Instanz der Mobilen Webseite zu erzeugen, benötigen Sie eine openITCOCKPIT Enterprise Lizenz, welche Sie berechtigt, die Mobile Webseite zu installieren. Bitte Kontaktieren Sie uns über unser Sales-Kontaktformular
Sind die voraussetzungen dafür geschaffen, benötigen Sie auf ihrem neuen System Docker.
Authentifizierung und herunterladen des Images¶
Bevor Sie das Docker image herunterladen können, müssen Sie sich bei unserer Docker Registry anmelden:
docker login https://cr.openitcockpit.io
Der Befehl fordert Sie auf, einen Benutzernamen sowie ein Passwort einzugeben. Als Benutzername geben Sie bitte die E-Mail-Adresse ein, welche mit Ihrem openITCOCKPIT Enterprise Lizenzschlüssel registriert ist. Als Passwort geben Sie Ihren Lizenzschlüssel ein.
Nach erfolgreicher Authentifizierung können Sie das Docker image herunterladen:
docker pull cr.openitcockpit.io/openitcockpit-mobile
Docker container starten¶
Den Container können Sie mit folgendem Befehl starten:
docker run --rm -it -p 4443:443 -p 8898:80 --name mobile cr.openitcockpit.io/openitcockpit-mobile
Danach können Sie die Seite mit Ihrem Mobilen Endgerät öffnen:
https://<hostname oder IP adresse>:4443
Benutzung¶
Login¶
Nach erfolgreicher Installation können Sie nun mit Ihrem Smartphone oder Tablet die entsprechende Webseite öffnen und gelangen damit auf die Login seite.
Im Feld Ihre Server-URL geben Sie bitte die URL oder IP-Adresse Ihres openITCOCKPIT Systems an.
Erstellung des API Keys¶
Um sich einloggen zu können, müssen Sie zunächst einen API Key zur nutzung der Mobile webseite auf
Ihrem openITCOCKPIT System erstellen (siehe API Key erstellen). Zum einfacheren
übertragen des API Keys auf das Mobile endgerät, scannen Sie einfach den QR-Code mit einem entsprechendem
QR-Code Scanner und kopieren sie den API-Key. Den kopierten Key können Sie einfach im Feld Ihr Api-Key einfügen.
Nach erfolgreichem Login werden Sie auf das Dashboard weitergeleitet.
Dashboard¶
Das Dashboard ermöglicht eine schnelle Übersicht über den Zustand Ihrer Infrastruktur. Unbehandelte Hosts und Services werden in ihren jeweiligen spalten als erstes angezeigt, danach wird nach Status weiter sortiert. Mit einem klick auf den jeweiligen status, gelangen Sie zu der entsprechend gefilterten Host oder Service Liste
Funktionen¶
Prüfzeit zurücksetzen (Reset Check time) Host Service¶
Wählen Sie den gewünschten Host oder Service aus der jeweiligen Liste aus und klicken Sie anschließend auf den Reiter
Aktionen. Danach klicken Sie die Schaltfläche Prüfzeit zurücksetzen. Die Aktion wird sofort ausgeführt und benötigt
keine weiteren Informationen.
Weitere informationen zu Prüfzeitraum zurücksetzen
Wartungszeitraum planen (Downtime) Host Service¶
Wählen Sie den gewünschten Host oder Service aus der jeweiligen Liste aus und klicken Sie anschließend auf den Reiter Aktionen.
Danach klicken Sie die Schaltfläche Plane Wartung.
Danach verfahren Sie wie im Abschnitt Wartungszeit erstellen beschrieben.
Hier können keine wiederkehrenden Wartungszeiten eingerichtet werden. Wie Sie eine wiederkehrende Wartungszeit einrichten können, wird im Abschnitt wiederkehrende Wartungszeit erstellen erläutert.
Weitere Informationen zu Plane Wartung
Status bestätigen (Acknowledgement) Host Service¶
Wählen Sie den gewünschten Host oder Service aus der jeweiligen Liste aus und klicken Sie anschließend auf den Reiter Aktionen.
Danach klicken Sie die Schaltfläche Status bestätigen.
Haben Sie einen Host ausgewählt, so haben Sie die möglichkeit den Status für den Host oder den Host und seine Services zu bestätigen.
Weitere Informationen zu Hoststatus bestätigen
Flattererkennung ein/ausschalten (Flapping) Host Service¶
Wählen Sie den gewünschten Host oder Service aus der jeweiligen Liste aus und klicken Sie anschließend auf den Reiter Aktionen.
Danach klicken Sie die Schaltfläche Aktiviere Flattererkennung.
Weitere Informationen zu Flap Detection
Benachrichtigungen ein/ausschalten (Notifications) Host Service¶
Wählen Sie den gewünschten Host oder Service aus der jeweiligen Liste aus und klicken Sie anschließend auf den Reiter Aktionen.
Danach klicken Sie die Schaltfläche Benachrichtigungen ein/ausschalten.
Mit dieser Option können Sie Benachrichtigungen für den Host oder den Host und seine Services vorübergehend deaktivieren. Ist ein Service ausgewählt, so wird entsprechend nur die Benachrichtigungen für den Service vorübergehend deaktiviert.
Passive Übertragung eines Prüfergebnisses (Passive transfer check result) Service¶
Wählen Sie den gewünschten Service aus der Service Liste aus und klicken Sie anschließend auf den Reiter Aktionen.
Danach klicken Sie die Schaltfläche Passive Übertragung eines Prüfergebnisses.
Weitere Informationen zu passive Übertragung eines Prüfergebnisses für Services
Benutzerdefinierte Benachrichtigung senden (Send custom service notification) Service¶
Wählen Sie den gewünschten Service aus der Service Liste aus und klicken Sie anschließend auf den Reiter Aktionen.
Danach klicken Sie die Schaltfläche Benutzerdefinierte Benachrichtigung senden.
Weitere Informationen zu Benutzerdefinierte Benachrichtigung senden
Massenaktionen¶
Massenaktionen sind für fast alle Funktionen verfügbar. Um eine Aktion für mehreren Hosts und / oder Services
gleichzeitig auszuführen, navigieren Sie zu entsprechenden Host oder Service Liste und klicken anschließend die
Schaltfläche Auswahl. Für jedes Listenelement werden nun Checkboxen angezeigt. Wählen Sie nun die entsprechenden
Objekte aus und klicken auf die Schaltfläche Aktionen. Die ausgewählte aktion wird für alle selektierten Objekte
angewandt.
Host und Service Wartungszeiten (Downtimes)¶
Eine Übersicht aller Wartungszeiten sowie wiederkehrenden Wartungszeiten finden Sie
im Menü unter den Punkten Host Wartungszeiten und Service Wartungszeiten.
Wartungszeit erstellen¶
Wartungszeiten erstellen sind für Hosts und Services gleich. Bei hosts ist lediglich noch die Option zum Setzen der downtimes auf dessen Services
Wartungszeit erstellen¶
Eine Wartungszeit erstellen Sie über den Menüpunkt Host Wartungszeit oder Service Wartungszeit. Dort klicken Sie
auf die Schaltfläche Neu.
Wählen Sie nun die entsprechenden Hosts oder Services aus, für die Sie eine Wartungzeit einrichten möchten. Das Feld Wartungstyp ist nur bei Host Wartungszeiten verfügbar. Dort können Sie auswählen, ob für die gewählten Services der gewählten Hosts zusätzlich eine Wartungszeit mit den selben parametern erstellt werden soll. Mit dem Kommentar können Sie die Wartungszeit beschreiben.
Mit dem Auswahlfeld Wiederkehrende Wartungszeit können Sie Wiederkehrende Wartungszeiten erstellen
Die Felder Start und Ende definieren den start und endzeitpunkt der Wartungszeit.
Wiedekehrende Wartungszeit erstellen¶
Eine Wiederkehrende Wartungszeit erstellen Sie über den Menüpunkt Host Wartungszeit oder Service Wartungszeit.
Dort klicken Sie auf die Schaltfläche Neu.
Wählen Sie nun die entsprechenden Hosts oder Services aus, für die Sie eine Wiederkehrende Wartungzeit einrichten möchten. Das Feld Wartungstyp ist nur bei Host Wartungszeiten verfügbar. Dort können Sie auswählen, ob für die gewählten Services der gewählten Hosts zusätzlich eine Wartungszeit mit den selben parametern erstellt werden soll. Mit dem Kommentar können Sie die Wartungszeit beschreiben.
Wählen Sie die Option Wiederkehrende Wartungszeit aus. Die Folgenden Formularfelder ändern sich nun.
Zunächst müssen Sie eine Startzeit angeben sowie eine Dauer. Die Dauer können Sie durch die vorgegebenen Schaltflächen auswählen oder in dem darunterliegenden Feld eine eigenen Wert eintragen. Dieser Wert wird in Minuten angegeben.
Danach wählen sie entweder einen Wochentag, einen Monatstag oder beides aus.
Bei Wochentagen wird die Wartungszeit immer an den ausgewählten Wochentagen um die angegebene Uhrzeit für die angegebene Dauer erfolgen.
Bei den Monatstagen entsprechend am angegebenen Tag des Monats.
Sind sowohl Wochentage als auch Monatstage angegeben, so wird die Watrungszeit beispielsweise Montags, Mittwochs und am 3. des Monats erfolgen.
Wartungszeit abbrechen¶
Wartungszeiten können über die Mobile Webseite auch abgebrochen werden. Dazu suchen Sie die entsprechende Wartungszeit aus der Liste aus und klicken auf das Papierkorb-Symbol.
Es erscheint ein Popup, welches zur bestätigung der Löschung auffordert.
Wiederkehrende Wartungszeiten können abgebrochen werden, indem auf die entsprechende wiederkehrende Wartungszeit geklickt
wird und danach Downtime abbrechen.
Customization¶
Die Mobile Webseite ist in der Lage, sich der Identität des jeweiligen Unternehmens anzupassen. Dies betrifft das Login Logo, Header logo (Menüleiste oben), Favicon, Systemname (Menüleiste oben) sowie den Webseiten Titel.
Dazu muss ein Verzeichnis auf dem Hostsystem angelegt werden, in dem die entsprechenden Dateien auf einer Ebene abgelegt werden.
CustomConfigDir/HeaderLogo.pngLoginLogo.pnginterface.ymlfavicon.png
Die Datei interface.yml ist entsprechende Konfigurationsdatei, die alle Konfigurierbaren Parameter enthält. Eine Beispieldatei befindet sich im Repository interface.example.yml.
Damit die Änderungen wirksam werden, muss beim Aufruf des Docker Containers ein zusätzlicher Parameter hinzugefügt werden:
-v /my/path/to/CustomConfigDir:/var/www/localhost/htdocs/interface
Dabei ist zu beachten, dass der Container interne Pfad:
:/var/www/localhost/htdocs/interface immer gleich bleibt!
Änderungen können dann "on the fly" in der CustomConfigDir/interface.yml erfolgen. Es muss kein Neustart des Docker
Containers erfolgen - ein neu laden der Webseite genügt.
Beispielkonfiguration¶
Dies ist eine Beispielkonfiguration um zu veranschaulichen, wie sich eine Konfiguration der interface.yml Datei
auswirkt.
Hierzu haben wir die Bilder des Halloween theme
von openITCOCKPIT genutzt.
Konfiguration der interface.yml:
############
# CUSTOM INTERFACE CONFIGURATION
# All attributes are optional.
# Custom images needs to be placed in the same directory as this configuration file
############
# System name displayed in the website header
systemname: Mobile Monitoring
# Title of the Website
title: Mobile Monitoring title
# Logo used on the Login Screen
# filename only! - the complete path will be set automatically
login_logo: openitcockpit_login_logo.png
# Logo used on the main manu
# filename only! - the complete path will be set automatically
header_logo: openitcockpit_halloween_header.png
# favicon logo
# filename only - the complete path will be set automatically
favicon: openitcockpit_halloween_header.png