add oitc-desktop

de/docs/additional/oitc-desktop.md

@@ -0,0 +1,147 @@
+# openITCOCKPIT-Desktop  
+Die openITCOCKPIT-Desktop-App ist eine Standalone-Application, die auf jedem modernen Betriebssystem installiert werden kann und einen Überblick über aktuelle Überwachungsereignisse und Statusaktualisierungen bietet. openITCOCKPIT-Desktop nutzt die openITCOCKPIT HTTP API zur Kommunikation mit dem openITCOCKPIT Server.
+
+![dashboard](../images/oitc-desktop/desktop-ligt.png)  
+
+![dashboard](../images/oitc-desktop/desktop-dark.png)
+
+
+### Installation
+* Es stehen für jedes Betriebssystem - Linux, Windows, Macos - entsprechende Installationspakete zur Verfügung.
+* Es kann in der App eingestellt werden, dass beim Start - oder manuell über die Settingsseite - automatisch nach Updates gesucht wird.
+
+## Anwendung   
+### Login
+
+![login](../images/oitc-desktop/login.png)
+
+Im ersten Feld `Ihre Server-URL` geben Sie bitte die URL oder IP-Adresse Ihres openITCOCKPIT Systems an.  
+Im zweiten Feld geben sie den Api-Key eines Benutzers des openITCOCKPIT Systems ein.
+#### Erstellung des API Keys
+Um sich einloggen zu können, müssen Sie zunächst einen API Key auf
+Ihrem openITCOCKPIT System erstellen ([siehe API Key erstellen](../../development/api/#api-keys)). Den Key können Sie einfach im Feld `Ihr Api-Key` einfügen.
+
+#### Autologin
+Ist auto login eingestellt (default) werden die Logindaten nach erfolgreichem Login automatisch gespeichert und beim nächsten Start der Application erfolgt das Login automatisch.
+
+#### Profile
+Über das Dropdown auf der Loginseite könnensie verschiedene Profile anlegen.
+Alle Einstellungen, die sie in der App vornehmen, werden in dem gerade aktiven Profil gespeichert.
+
+Nach erfolgreichem Login werden Sie auf das Dashboard weitergeleitet.
+
+### Settings
+Sämtliche Einstellungen auf der Settingsseite werden automatisch gespeichert!
+![settings](../images/oitc-desktop/settings.png)  
+
+* **Enable auto start**    
+Die Anwendung wird beim Start des Bestriebssystem mitgestartet (beta)
+
+* **Close to tray**  
+Beim Schliessen der Anwendung über die Anwendungsleiste wird die Anwendung nicht beendet sondern nur versteckt, kann über das Tray-Icon menü wieder zur Anzeige gebracht werden.
+
+* **Show widget on start**  
+Das Widget wird beim Starten der Anwendung angezeigt. 
+
+* **Show only widget on start**  
+Beim Starten der Anwendung wird nur das Widget zur Anzeige gebracht.  
+Die Hauptanwendung kann über das Menü im Tray zur Anzeige gebracht werden.
+
+* **State refresh interval**  
+Das interval der Abfrage der Daten für das Widget und das Dashboard (min. 1 Minute).
+
+* **Use slow pagination in lists**  
+Umschalten der Paginierung
+
+* **Activate widget position storage**  
+Speichert  automatisch die Position des Widgets
+
+* **Activate window posisiton storage**  
+Speichert automatisch die Postion und Größe der Anwendung  
+
+* **Disable automatic update checks**  
+Schaltet den Updatecheck beim Start der App aus.
+
+* **Enable push notifications**  
+Schaltet Pushbenarichtigungen an/aus.
+
+* **Enable dark mode**  
+ON/OFF schalten den Dark Mode explizt an/aus. Auto schaltet den Modus anhand der Betriebssystemeinstellung.
+
+* **Auto login enabled**  
+Die Anwendung loggt sich beim Start automatisch mit den letzten aktiven Anmeldedaten (Profil) ein.
+
+* **Logout**  
+Die Anwendung loggt sich aus und springt zur Loginseite, etwa um das Profil zu wechseln oder zu editieren.
+
+* **Check & save**  
+Prüft und speichert die Anmeldedaten des aktiven Profils
+
+* **Check for update**  
+Expliziter Check ob ein Update für die App vorhanden ist.
+
+### Widget settings
+* Über den **Widget settings** Tab auf der Settingsseite kann der Filter für das Widget definiert werden und die Reihenfolge der Widgetanzeige per Drag & Drop bestimmt werden.
+![tray](../images/oitc-desktop/widget-settings.png)
+
+### Widget
+* Die zweite Zeile des Widgets zeigt die unhandled Anteile. 
+* Mit Hilfe des Icons kann das Widget positioniert werden.
+* Beim Klicken uf einen Widgeteintag wird die entsprechende List in der Anwendung zur Anzeige gebracht.  
+![widget](../images/oitc-desktop/widget.png)
+
+### Tray
+![tray](../images/oitc-desktop/tray.png)  
+Über das Trayicon (Rechtsclick) können ebenfalls einige Einstellungen vorgenommen werden.
+
+## Personalisierung
+
+Die openITCOCKPIT-Desktop Anwnedung ist in der Lage, sich der Identität des jeweiligen Unternehmens anzupassen.  
+Dazu können das Appicon (Anwendungleiste, Tray, Widget), das Logo der Loginseite und das Hintergrundbild der Loginseite getauscht werden.
+
+![assets](../images/oitc-desktop/custom-assets.png)
+
+Dazu muss innerhalb des Konfigurationsverzeichnisses der Anwendung ein Ordner names **customAssets** angelegt (verlinkt) werden.
+
+Das Konfigurationsverzeichnis liegen je nach Betriebssystem an folgenden Orten:  
+
+Windows
+```bash  
+c:\Benutzer\<user>\AppData\Roaming\openITCOCKIT-Desktop
+```
+OSX
+```bash  
+/users/<user>/Library/Application Support/openITCOCKIT-Desktop
+```
+Linux  
+```bash
+/home/<user>/.config/openITCOCKIT-Desktop
+```
+
+### customAssets
+Innerhalb des Ordners customAssets müssen folgende Dateinamenkonventionen beachtet werden:
+
+**Icon**: favicon.png   
+Nur png als Endung erlaubt.  
+Je nach Betriebssystem sollten die Dimensionen etwas anders sein:  
+Windows: mindestens 64x64, besser 256x256
+Linux: gilt dasselbe wie für Windows
+OSX: maximal 32x32, besser 16x16 - da sonst das Icon oben in der Leiste zu groß wird.
+
+**logo**: logo.png (.svg,.jpg)  
+Auflösung beliebig, da skaliert wird  
+
+**background**: background.png (.svg, .jpg)  
+Auflösung im Prinzip auch beliebig, da skaliert wird, sollte aber mindestens FullHD sein.
+
+## Hosts, Services
+
+Die Host-, Services-Views und ihre Detailseiten sind von den entsprechenden Seiten der Weboberfläche des oitc-Servers abgeleitet und werden deshalb hier nicht näher ausgeführt.
+### Hostslist  
+![hostslist](../images/oitc-desktop/hostlist.png)  
+### Hostbrowser  
+![hostbrowser](../images/oitc-desktop/hostbrowser.png) 
+### Serviceslist  
+![serviceslist](../images/oitc-desktop/servicelist.png)
+### Servicebrowser
+![servicebrowser](../images/oitc-desktop/servicebrowser.png)

de/mkdocs.yml

@@ -91,6 +91,7 @@ nav:
     - 'Upgrade v3.x zu v4.x': 'additional/upgradev3-v4.md'
     - 'openITCOCKPIT hinter einem Reverse Proxy betreiben': 'additional/behind-reverse-proxy.md'
     - 'Mobile Webseite': 'additional/mobile-website.md'
+    - 'openITCOCKPIT-Desktop': 'additional/oitc-desktop.md'
     - 'Ports': 'additional/ports.md'
     - 'Kiosk Mode': 'additional/kiosk-mode.md'
 

en/docs/additional/oitc-desktop.md

@@ -0,0 +1,145 @@
+# openITCOCKPIT-Desktop  
+The openITCOCKPIT desktop app is a standalone application that can be installed on any modern operating system and provides an overview of current monitoring events and status updates. openITCOCKPIT desktop uses the openITCOCKPIT HTTP API to communicate with the openITCOCKPIT server.
+
+![dashboard](../images/oitc-desktop/desktop-ligt.png)  
+
+![dashboard](../images/oitc-desktop/desktop-dark.png)
+
+### Installation
+* Appropriate installation packages are available for every operating system - Linux, Windows, MacOS.
+* The app can be set to automatically search for updates when it starts - or manually via the settings page.
+
+## Usage
+
+### Login
+
+![login](../images/oitc-desktop/login.png)
+
+In the first field `your server URL` enter the URL or IP address of your openITCOCKPIT system.  
+In the second field, enter the API key of a user of the openITCOCKPIT system.
+
+#### Creation of API Keys
+In order to be able to log in, you must first obtain an API key created in your openITCOCKPIT system ([siehe API Key erstellen](../../development/api/#api-keys)). You can simply enter the key in the `Your Api-Key` field.
+
+#### Autologin
+If auto login is set (default), the login data will be saved automatically after a successful login and the login takes place automatically the next time the application is started.
+
+#### Profile
+You can create different profiles via the dropdown on the login page.
+All settings you make in the app are saved in the currently active profile.
+
+After successfully log in, you will be redirected to the dashboard.
+
+### Settings
+All settings on the settings page are saved automatically!
+![settings](../images/oitc-desktop/settings.png)  
+
+* **Enable auto start**  
+The application is started when the operating system is started (beta)
+
+* **Close to tray**  
+When closing the application via the application bar, the application is not terminated but only hidden, can be displayed again via the tray icon menu.
+* **Show widget on start**  
+The widget is displayed when the application starts.
+
+* **Show only widget on start**  
+When starting the application, only the widget is displayed.   
+![widget](../images/oitc-desktop/widget.png)  
+The main application can be displayed via the menu in the tray.
+
+* **State refresh interval**  
+Interval of data retrieval for widget and dashboard (min. 1 minute).
+
+* **Use slow pagination in lists**  
+Switch the pagination type
+
+* **Activate widget position storage**  
+Automatic save of the position of the widget
+
+* **Activate window posisiton storage**  
+Automatic save of the application position and size  
+
+* **Disable automatic update checks**  
+Turns off the update check when starting the app.
+
+* **Enable push notifications**  
+Turns push notifications on/off.
+
+* **Enable dark mode**  
+ON/OFF switch Dark Mode explicitly on/off. Auto switches the mode based on the operating system setting.
+
+* **Auto login enabled**   
+The application automatically logs in with the last active login data (profile) when it is started.
+
+* **Logout**  
+The application logs out and jumps to the login page, for example to change or edit the profile.
+
+* **Check & save**  
+Checks and saves the credentials of the active profile
+
+* **Check for update**  
+Explicit check whether an update is available for the app.
+
+### Widget settings
+* Via the **Widget settings** tab on the settings page, the filter for the widget can be defined and the order of the widget display can be determined using drag & drop.  
+![tray](../images/oitc-desktop/widget-settings.png)    
+
+### Widget
+The second line of the widget shows the unhandled shares.  
+The widget can be positioned using the icon.  
+Clicking on a widget entry brings up the corresponding list in the application.  
+  ![widget](../images/oitc-desktop/widget.png)  
+
+### Tray
+![tray](../images/oitc-desktop/tray.png)  
+Some settings can also be made via the tray icon (right-click).
+
+## Customization
+The openITCOCKPIT desktop application is able to adapt to the identity of the respective company.
+For this case the app icon (application bar, tray, widget), the logo of the login page and the background image of the login page can be changed.
+![assets](../images/oitc-desktop/custom-assets.png)
+
+To do this, a folder named **customAssets** must be created (linked) within the configuration directory of the application.  
+
+Depending on the operating system, the configuration directory is in the following locations:  
+
+Windows
+```bash  
+c:\Benutzer\<user>\AppData\Roaming\openITCOCKIT-Desktop
+```
+OSX
+```bash  
+/users/<user>/Library/Application Support/openITCOCKIT-Desktop
+```
+Linux  
+```bash
+/home/<user>/.config/openITCOCKIT-Desktop
+```
+
+### customAssets  
+Within the customAssets folder, the following file naming conventions must be observed:
+
+**Icon**: favicon.png   
+Only png as Endung allowed.  
+Depending on the operating system, the dimensions should be slightly different:  
+Windows: min. 64x64, better 256x256
+Linux: same as  Windows
+OSX: max. 32x32, better 16x16 - otherwise the icon at the top of the bar will be too big.
+
+**logo**: logo.png (.svg,.jpg)  
+Any resolution, since it is scaled 
+
+**background**: background.png (.svg, .jpg)  
+Resolution in principle also arbitrary, since it is scaled, but it should be at least FullHD.
+
+## Hosts, Services
+
+The host and services views and their detail pages are derived from the corresponding pages of the oitc server's web interface and are therefore not explained in more detail here.  
+### Hostslist  
+![hostslist](../images/oitc-desktop/hostlist.png)  
+### Hostbrowser  
+![hostbrowser](../images/oitc-desktop/hostbrowser.png) 
+### Serviceslist  
+![serviceslist](../images/oitc-desktop/servicelist.png)
+### Servicebrowser
+![servicebrowser](../images/oitc-desktop/servicebrowser.png)

en/mkdocs.yml

@@ -91,6 +91,7 @@ nav:
       - 'Upgrade v3.x to v4.x': 'additional/upgradev3-v4.md'
       - 'Running openITCOCKPIT behind a reverse proxy': 'additional/behind-reverse-proxy.md'
       - 'Mobile Website': 'additional/mobile-website.md'
+      - 'openITCOCKPIT-Desktop': 'additional/oitc-desktop.md'
       - 'Ports': 'additional/ports.md'
       - 'Kiosk Mode': 'additional/kiosk-mode.md'