From 55ffcfceefeb76ce8b25c91b7404be59cfd99ef8 Mon Sep 17 00:00:00 2001 From: Jannik Schönartz Date: Sun, 19 May 2019 10:54:10 +0000 Subject: [documentation] Add FAQ registration and basic webapp docu stuff webapp add Account tutorial overlay --- documentation/de/webapp/README.md | 41 ++++++++++++++++++++++++++++- documentation/de/webapp/faq.md | 54 ++++++++++++++++++++++++++++++++++++++- 2 files changed, 93 insertions(+), 2 deletions(-) (limited to 'documentation/de') diff --git a/documentation/de/webapp/README.md b/documentation/de/webapp/README.md index 7bedeed..e460e8c 100644 --- a/documentation/de/webapp/README.md +++ b/documentation/de/webapp/README.md @@ -1,3 +1,42 @@ # Webapplikation +BAS Dark and Light Theme -BAS Home \ No newline at end of file +Die Webapplikation ist das Frontend des BAS. Es benutzt dieselben API-Calls, die einem Benutzer zur Verfügung stehen, sodass alles, was im Frontend passiert auch über die API gemacht werden kann. + +BAS Home + +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. + +Mit 3 kann das Aussehen der Webapplikation zwischen einem hellen und einem dunklen Design gewechselt werden. +4 öffnet das [Notifications](/webapp/README.md#notification) Menü. Der Button hat zusätzlich einen Zähler für ungelesene Benachrichtigungen in der unteren rechten ecke. +Mit 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. + +BAS Home + + +## Benutzeraccount +Im Benutzeraccount Modul, kann der Benutzer einige seiner Informationen ändern. + +BAS Account + +Mit dem Bearbeitungsbutton 1 kann der Benutzer seinen ```NAMEN``` und seine ```E-MAIL``` ändern. +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. +::: + +Das ```PASSWORT``` kann mit 2 geändert werden. Das Passwort muss aus mindestens ```>= 8 Zeichen``` bestehen. + +Mit 3 kann der Benutzer seinen Account endgültig Löschen. +::: danger +Das Löschen des Accounts 3 kann **NICHT** rückgängig gemacht werden. +::: + +## Einstellungen + +BAS Settings + +## Notifications diff --git a/documentation/de/webapp/faq.md b/documentation/de/webapp/faq.md index eb31b66..096eb4e 100644 --- a/documentation/de/webapp/faq.md +++ b/documentation/de/webapp/faq.md @@ -1 +1,53 @@ -# [FAQ] Häufig gestellte Fragen \ No newline at end of file +# [FAQ] Häufig gestellte Fragen + +## Wie registriere ich einen Client? +Wenn ein Client zum ersten Mal den BAS über das Netzwerk bootet, erscheint das Resgistrierung iPXE-Menü, zu sehen im Bild unten. +Neben der Registrierung, gibt es die Auswahl das lokal installierte OS zu oder bwLehrpool zu booten ohne das eine Registrierung notwendig ist. + +BAS Registration + +::: tip +Wenn du vorher [IP-Range](/webapp/modules.md#ip-ranges) zu einer Gruppe hinzufügst, wird der Client anhand der IP automatisch in die Gruppe mit dem passenden Subnetz eingeordnet. +::: +Es gibt drei möglichkeiten, einen Client zu registrieren: +* [Automatic Registration](/webapp/faq.md#automatic-registration) +* [Semi-Automatic Registration](/webapp/faq.md#semi-automatic-registration) +* [Manual Registration](/webapp/faq.md#manual-registration) + +### Automatic Registration: +In der automatischen Registrierung bekommt der Client die nächste freie IP des Subnetzes im DHCP als fixe IP. +Im BAS bekommt er einen Standard Namen, der sich aus einen Präfix und der UUID zusammen setzt ```Client_```. + +### Semi-Automatic Registration +In der semi-automatischen Registrierung kommt zuerst eine Liste mit den nächsten 20 freien IP-Adressen des Subnetzes im DHCP. +Davon kann eine ausgewählt werden, die am Ende der initialen Registrierung im DHCP als feste IP gesetzt wird. + +BAS Registration IP Selection + +Nachdem eine IP-Adresse ausgewählt wurde, kann ein Name für den Client gesetzt werden. +::: warning +Dieser Name wird ebenso der Präfix vom Hostname im DHCP. +::: + +BAS Registration Name + +Am Ende wird eine Übersicht angezeigt, in der alle Ausgewählten und eingegebenen Daten überprüft und bestätigt oder die Registrierung abgebrochen werden können. + +BAS Registration Overview + +### Manual Registration +In der manuellen Registrierung kann der Raum, in dem der Client einsortiert werden soll, ausgewählt werden. +Eine Liste mit allen Räumen in der im BAS angelegten Parent / Client Struktur steht zur Verfügung, durch die navigiert werden kann. + +BAS Registration Room Selection + + +### Registration hooks +Durch die initiale Registrierung wird der Client mit dem angegebenen Namen, der ausgewählten IP, MAC und UUID im BAS und den konfigurierten Backends erstellt. +Um weitere benutzerdefinierte Registrierung Schritte durchzuführen, können Registration Hooks erstellt werden. Diese werden direkt nach der initialen Registrierung ausgeführt. +Weitere Informationen über die Registration Hooks und ihre Erstellung kann im [Registration Hooks](/webapp/modules.md#client-registration) Kapitel gefunden werden. + +## Wie verschiebe ich einen PC in einen anderen Poolraum? + +## Wie erstelle ich ein Event +Die Anleitung wie ein Event erstellt und konfiguriert werden kann wird im [Eventmanager](/webapp/modules.md#event-manager) erklärt. -- cgit v1.2.3-55-g7522