Skip to content

Commit f306e0a

Browse files
authored
Merge pull request #90 from openITCOCKPIT/ITC-3731
ITC-3731 First part of the documentation for the Mobile App
2 parents 2bab22a + 8520cd8 commit f306e0a

12 files changed

Lines changed: 163 additions & 2 deletions

de/docs/additional/mobile-app.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Mobile App <span class="badge badge-primary badge-outlined" title="Community Edition">CE</span>
2+
3+
!!! info "Geschlossene Beta"
4+
Die openITCOCKPIT Mobile App für iOS und Android befindet sich derzeit in einer geschlossenen Beta-Phase.
5+
Zum Zeitpunkt des Lesens ist die App möglicherweise noch nicht im App Store oder im Google Play Store verfügbar.
6+
7+
![openITCOCKPIT iOS App auf einem iPhone 16e](/images/mobile-app/openitcockpit-ios-app.png){ align=center }
8+
*Grafik: openITCOCKPIT iOS App auf einem iPhone 16e*
9+
10+
11+
## Voraussetzungen
12+
13+
- openITCOCKPIT 5.6.1 oder höher
14+
- iOS 17.5 oder höher
15+
- Der openITCOCKPIT-Server muss vom mobilen Endgerät aus erreichbar sein (z. B. über VPN oder eine öffentliche IP-Adresse)
16+
- Ein gültiges HTTPS-Zertifikat ist erforderlich. Selbstsignierte Zertifikate funktionieren in der Regel nicht.
17+
18+
19+
## App herunterladen
20+
21+
- Apple App Store
22+
- Google Play Store
23+
24+
(Links werden hinzugefügt, sobald die App in den Stores verfügbar ist)
25+
26+
## Push-Benachrichtigungen einrichten
27+
28+
Ein großer Vorteil der Mobile App im Vergleich zur webbasierten Variante ist die Möglichkeit, Push-Benachrichtigungen für Alarme zu erhalten.
29+
Um dies zu aktivieren, müssen Sie Ihren openITCOCKPIT-Server so konfigurieren, dass Benachrichtigungen über den **von der AVENDIS GmbH bereitgestellten Push Gateway Service** gesendet werden.
30+
Dieser Service ist für openITCOCKPIT-Nutzer kostenlos.
31+
32+
1. Navigieren Sie zu `System configuration -> System -> Push Notification Settings`
33+
2. Setzen Sie die Relay-Adresse auf `https://pushrelay.openitcockpit.io`
34+
3. Setzen Sie den Port auf `443`
35+
4. Klicken Sie auf `Request and test Auth-Key`.
36+
37+
openITCOCKPIT fordert nun einen Authentifizierungsschlüssel beim Push Gateway Service an. Der Push Gateway Service verwendet die übermittelte System-ID,
38+
um Ihren openITCOCKPIT-Server zu identifizieren, und erzeugt einen neuen Authentifizierungsschlüssel für Ihren Server.
39+
40+
Um die Einrichtung abzuschließen, klicken Sie nach der Schlüsselerstellung auf `Save configuration`.
41+
42+
![Auth-Key anfordern](/images/mobile-app/setup-push-gateway.png)
43+
44+
### Benutzer Kontakten zuweisen
45+
46+
Es ist wichtig, Ihrem openITCOCKPIT-Benutzer einen oder mehrere Kontakte zuzuweisen, um Push-Benachrichtigungen für Alarme zu erhalten.
47+
48+
Navigieren Sie zunächst zu `Monitoring -> Objects -> Contacts` und wählen Sie den Kontakt aus, den Sie Ihrem Benutzer zuweisen möchten, oder erstellen Sie einen neuen Kontakt.
49+
50+
Stellen Sie sicher, dass Ihr openITCOCKPIT-Benutzer im Feld `Users` der Kontaktkonfiguration ausgewählt ist.
51+
Aktivieren Sie außerdem die Checkbox `Push notifications to browser` für Hosts und Services. Diese Option sendet Benachrichtigungen dann sowohl an die Weboberfläche als auch an die Mobile App.
52+
53+
![Benutzer Kontakten zuweisen](/images/mobile-app/assign-users-to-contacts.png)
54+
55+
Damit die Änderungen wirksam werden, speichern Sie die Kontaktkonfiguration und aktualisieren Sie die Monitoring-Konfiguration.
56+
57+
![Monitoring-Konfiguration aktualisieren](/images/openITCOCKPIT-Refresh-Monitoring-Config.png)
58+
59+
## Mobile App einrichten
60+
61+
Sobald die App auf Ihren mobilen Endgeräten installiert ist, können Sie die App starten und die URL Ihres openITCOCKPIT-Servers eingeben.
62+
Die App verwendet die openITCOCKPIT-API für die Authentifizierung. Daher müssen Sie zuerst [einen API-Schlüssel erstellen](../../development/api/#api-keys).
63+
64+
![Mobile App Login](/images/mobile-app/iphone-login-docs.png)
65+
66+
Der Einfachheit halber können Sie auch den QR-Code aus der openITCOCKPIT-Weboberfläche scannen, um den API-Schlüssel automatisch zu übernehmen.
67+
68+
## Web Application Firewall (WAF) / Reverse Proxy
69+
70+
Für eine zusätzliche Sicherheitsebene stellen wir eine optionale Web Application Firewall (WAF) / Reverse-Proxy-Konfiguration für die openITCOCKPIT Mobile App bereit. Diese Konfiguration basiert auf Nginx und kann verwendet werden, um Ihren openITCOCKPIT-Server vor bösartigen Anfragen zu schützen.
71+
72+
TBD

de/docs/additional/mobile-website.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Mobile Webseite <span class="badge badge-danger badge-outlined" title="Enterprise Edition">EE</span>
22

3+
4+
!!! danger "End of Life"
5+
Die Mobile Webseite von openITCOCKPIT wird in dieser Form ab Version 5.6.1 als veraltet markiert.
6+
Bitte nutzen Sie die [Mobile App für iOS und Android Geräte](./mobile-app.md).
7+
8+
**Das End of Life ist mit der Version 5.7.0 geplant.**
9+
Danach wird es eine neue Version der mobilen Webseite geben, welche eine gemeinsame Codebasis mit der Mobilen App nutzt.
10+
311
## Installation
412

513
Die Mobile Webseite ist so konzipiert, dass Sie auf einem eigenen Server betrieben werden kann.
2.2 MB
Loading
251 KB
Loading
56.7 KB
Loading
253 KB
Loading
1.2 MB
Loading
44.7 KB
Loading

de/mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ nav:
106106
- 'Upgrade 4.x zu 5.x': 'additional/upgradev4-v5.md'
107107
- 'Lets Encrypt Zertifikate für openITCOCKPIT': 'additional/lets-encrypt-openitcockpit.md'
108108
- 'openITCOCKPIT hinter einem Reverse Proxy betreiben': 'additional/behind-reverse-proxy.md'
109-
- 'Mobile Webseite': 'additional/mobile-website.md'
109+
- 'Mobile App': 'additional/mobile-app.md'
110+
- 'Mobile Webseite (veraltet)': 'additional/mobile-website.md'
110111
- 'openITCOCKPIT-Desktop': 'additional/oitc-desktop.md'
111112
- 'Ports': 'additional/ports.md'
112113
- 'Kiosk Mode': 'additional/kiosk-mode.md'

en/docs/additional/mobile-app.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Mobile App <span class="badge badge-primary badge-outlined" title="Community Edition">CE</span>
2+
3+
!!! info "Closed Beta"
4+
The openITCOCKPIT Mobile App for iOS and Android is currently in closed beta.
5+
When reading this, the app maybe is not yet available in the App Store or Google Play Store.
6+
7+
![openITCOCKPIT iOS App running on an iPhone 16e](/images/mobile-app/openitcockpit-ios-app.png){ align=center }
8+
*Graphic: openITCOCKPIT iOS App running on an iPhone 16e*
9+
10+
11+
## Requirements
12+
13+
- openITCOCKPIT 5.6.1 or higher
14+
- iOS 17.5 or higher
15+
- The openITCOCKPIT server must be reachable from the mobile device (e.g. via VPN or public IP address)
16+
- A valid HTTPS certificate is required. Self-signed certificates will most likely not work.
17+
18+
19+
## Download the App
20+
21+
- Apple App Store
22+
- Google Play Store
23+
24+
(Links will be added once the app is available in the stores)
25+
26+
## Setup Push Notifications
27+
28+
A huge benefit of the mobile app, compared to its web-based counterpart is, the ability to receive push notifications for alerts.
29+
To enable this, you need to configure your openITCOCKPIT server to send notifications though the **Push Gateway Service provided by AVENDIS GmbH**.
30+
This service is free of charge for openITCOCKPIT users.
31+
32+
1. Navigate to `System configuration -> System -> Push Notification Settings`
33+
2. Set Relay address to `https://pushrelay.openitcockpit.io`
34+
3. Set Port to `443`
35+
4. Click on `Request and test Auth-Key`.
36+
37+
openITCOCKPIT will now request an authentication key from the Push Gateway Service. The Push Gateway Service will use the provided System ID
38+
to identify your openITCOCKPIT server and will generate a new authentication key for your server.
39+
40+
To complete the setup, make sure to click on `Save configuration` after the key has been generated.
41+
42+
![Request Auth-Key](/images/mobile-app/setup-push-gateway.png)
43+
44+
### Assign Users to Contacts
45+
46+
It is important to assign your openITCOCKPIT user one (or more) contact(s) in order to receive push notifications for alerts.
47+
48+
First, navigate to `Monitoring -> Objects -> Contacts` and select the contact you want to assign to your user, or create a new contact.
49+
50+
Make sure to select your openITCOCKPIT user in the `Users` field of the contact configuration.
51+
Also tick the checkbox `Push notifications to browser` for hosts and services. This option will now send Notifications to both, the web interface and the mobile app.
52+
53+
![Assign Users to Contacts](/images/mobile-app/assign-users-to-contacts.png)
54+
55+
To apply the changes, make sure to save the contact configuration and refresh the monitoring configuration.
56+
57+
![Refresh monitoring configuration](/images/openITCOCKPIT-Refresh-Monitoring-Config.png)
58+
59+
## Setup the Mobile App
60+
61+
Once the app is installed on your mobile devices, you can start the app and enter the URL of your openITCOCKPIT server.
62+
The app uses the openITCOCKPIT API for authentication, so you have to [create an API key first](../../development/api/#api-keys).
63+
64+
![Mobile App Login](/images/mobile-app/iphone-login-docs.png)
65+
66+
For convenience, you can also scan the QR code from the openITCOCKPIT web interface to automatically fill in the API key.
67+
68+
## Web Application Firewall (WAF) / Reverse Proxy
69+
70+
For adding an extra layer of security, we provide an optional Web Application Firewall (WAF) / Reverse Proxy configuration for the openITCOCKPIT Mobile App. This configuration is based on Nginx and can be used to protect your openITCOCKPIT server from malicious requests.
71+
72+
TBD

0 commit comments

Comments
 (0)