From dc68a5f080f939b57834360504174385dd8be0b9 Mon Sep 17 00:00:00 2001 From: Jannik Schönartz Date: Wed, 15 Apr 2020 18:02:26 +0000 Subject: [documentation] Add documentation for external backends. --- documentation/de/webapp/README.md | 10 +++++----- documentation/de/webapp/modules.md | 40 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 5 deletions(-) (limited to 'documentation/de') diff --git a/documentation/de/webapp/README.md b/documentation/de/webapp/README.md index 2d93a88..ebc4f68 100644 --- a/documentation/de/webapp/README.md +++ b/documentation/de/webapp/README.md @@ -7,12 +7,12 @@ Die Webapplikation ist das Frontend des BAS. Es benutzt dieselben API-Calls, die Auf der linken Seite ist das Sidepanel 1, welches alle Module beinhaltet. Das Sidepanel kann mit 2 geöffnet und geschlossen werden. -Das Verhalten des Sidepanels kann in den [Settings](/webapp/README.md#settings) konfiguriert werden. +Das Verhalten des Sidepanels kann in den [Einstellungen](/de/webapp/#einstellungen) konfiguriert werden. > mit \ > 3 kann das Aussehen der Webapplikation zwischen einem hellen und einem dunklen Design gewechselt werden.\ -> 4 öffnet sich das [Notifications](/webapp/README.md#notification) Menü. Der Button hat zusätzlich einen Zähler für ungelesene Benachrichtigungen in der unteren rechten Ecke.\ -> 5 kann ein Menü ausgeklappt werden, mit dem man zu den [Benutzereinstellungen](/webapp/README.md#user-account-settings) und [Einstellungen](/webapp/README.md#settings) navigieren oder sich ausloggen kann. +> 4 öffnet sich das [Benachrichtigungsmenü](/de/webapp/README.md#benachrichtigungen). Der Button hat zusätzlich einen Zähler für ungelesene Benachrichtigungen in der unteren rechten Ecke.\ +> 5 kann ein Menü ausgeklappt werden, mit dem man zu den [Benutzereinstellungen](/de/webapp/README.md#benutzeraccount) und [Einstellungen](/de/webapp/#einstellungen) navigieren oder sich ausloggen kann. ## Benutzeraccount Im Benutzeraccount Modul, kann der Benutzer einige seiner Informationen ändern. @@ -23,7 +23,7 @@ Mit dem ```BEARBEITEN```-Button 1 kann der B In den Accounteinstellungen ist es nicht möglich seinen ```BENUTZERNAMEN``` zu ändern. ::: tip -Der ```BENUTZERNAME``` kann nur im [Benutzermanagement](/webapp/modules.md#user-management) geändert werden. Dafür benötigt man die ```EDIT```-Rechte. +Der ```BENUTZERNAME``` kann nur im [Benutzermanagement](/de/webapp/modules.html#nutzermanagement) geändert werden. Dafür benötigt man die ```EDIT```-Rechte. ::: Das ```PASSWORT``` kann mit dem ```BEARBEITEN```-Button 2 geändert werden. Das Passwort muss aus mindestens ```>= 8 Zeichen``` bestehen. @@ -37,4 +37,4 @@ Das Löschen des Accounts kann **NICHT** rückgängig gemacht werden. BAS Settings -## Notifications +## Benachrichtigungen diff --git a/documentation/de/webapp/modules.md b/documentation/de/webapp/modules.md index 8b34665..ba9d101 100644 --- a/documentation/de/webapp/modules.md +++ b/documentation/de/webapp/modules.md @@ -110,6 +110,46 @@ Wenn eine zuvor ausgewählte Gruppe innerhalb einer geblacklisteten Gruppe ist w ::: ## Externe Backends +In diesem Modul können externe Backends wie ```iDoIT``` oder ```Infoblox``` mit dem ```BAS``` Verbunden werden, um Daten zu importieren oder synchronisieren. + +Externe Backends + +Eine Verbindung, zu einem externen Backend, kann mit 1 erstellt oder mit 2 entfernt werden. +Wenn eine neue Backendverbindung hinzugefügt wird, öffnet sich ein Fenster, indem alle benötigten Daten eingegeben werden können. +Siehe [Externes Backend hinzufügen](/de/webapp/modules.html#add-edit-external-backend) für mehr Informationen über den Einrichtungsprozess. + +Um zu Überprüfen, ob eine erfolgreiche Verbindung zu einem externen Backend hergestellt wurde, kann 4 gedrückt werden. +Um mehrere externe Backends zu überprüfen, können die entsprechenden Backends ausgewählt und dann mit 3 gleichzeitig getestet werden. +Wenn die Verbindung erfolgreich ist, wechselt die Farbe vom Icon auf Grün, sollte die Verbindung fehlschlagen, wechselt die Farbe auf Rot. + + +5 öffnet die [Synchronisierungeinstellungen](/de/webapp/modules.html#synchronisierungeinstellungen) und +6 öffnet ein Fenster zum [Editieren](/de/webapp/modules.html#hinzufugen-editieren-von-externen-backends). + +### Hinzufügen/Editieren von externen Backends +Wenn ein neues Backend hinzugefügt wird, muss im ersten Schritt der Typ des externen Backends ausgewählt werden. +Externe Backends Hinzufügen Schritt 1 +Im zweiten Schritt können alle Zugangsdaten, die das Backend benötigt, eingegeben werden. + +::: danger +Die eingegebenen Zugangsdaten der Backends wird als Plaintext in der Datenbank gespeichert, da einige Backends zur Authentifizierung das Passwort als Plaintext benötigen. +Seihen sie vorsichtig, welche Daten sie angeben. Jeder mit Zugang zur Datenbank kann die Zugangsdaten auslesen. +::: + +External Backends Hinzufügen Schritt 2 +Da jedes Backend unterschiedliche Anforderungen hat, kann das Aussehen vom Bild abweichen. Das Beispiel im obigen Bild ist von einem ```iDoIT```-Backend. + +### Synchronisierungeinstellungen +In den Synchronisierungeinstellungen können die Objekte der externen Backends entweder als ```Gruppe``` oder als ```Client``` definiert werden. +Eine ```Gruppe``` ist wie ein Ort, sie kann andere Gruppen als Subgruppen enthalten oder Clients. Zum Beispiel kann ein Gebäude mehrere Räume enthalten. Räume können mehrere Clients haben. +Ein ```Client``` andererseits enthält keine Unterobjekte. Ein Client ist zum Beispiel ein PC oder ein Server. +Siehe [Gruppen / Clients](/de/webapp/modules.html#gruppen-clients) für mehr Informationen. + +::: warning +Synchronisierungstypen sind bisher noch nicht implementiert. +::: +External Backends Sync + ## Rechtemanager ## iPXE Builder Diese Modul umfasst das ```iPXE```, welches an die Clients, die über das Netzwerk booten, ausgeliefert wird. -- cgit v1.2.3-55-g7522