summaryrefslogtreecommitdiffstats
path: root/documentation/de
diff options
context:
space:
mode:
authorJannik Schönartz2019-05-19 12:54:10 +0200
committerJannik Schönartz2019-05-19 12:54:10 +0200
commit55ffcfceefeb76ce8b25c91b7404be59cfd99ef8 (patch)
tree74b1b8ee5eb48957eeef6b6be0a4a834507ec70e /documentation/de
parent[webapp] Disable user management tutorial & disable tutorial margins when the... (diff)
downloadbas-55ffcfceefeb76ce8b25c91b7404be59cfd99ef8.tar.gz
bas-55ffcfceefeb76ce8b25c91b7404be59cfd99ef8.tar.xz
bas-55ffcfceefeb76ce8b25c91b7404be59cfd99ef8.zip
[documentation] Add FAQ registration and basic webapp docu stuff
webapp add Account tutorial overlay
Diffstat (limited to 'documentation/de')
-rw-r--r--documentation/de/webapp/README.md41
-rw-r--r--documentation/de/webapp/faq.md54
2 files changed, 93 insertions, 2 deletions
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
+<a :href="$withBase('/img/dark_light_theme.png')" target="_blank"><img :src="$withBase('/img/dark_light_theme.png')" alt="BAS Dark and Light Theme"></a>
-<a :href="$withBase('/img/home_de.png')" target="_blank"><img :src="$withBase('/img/home_de.png')" alt="BAS Home"></a> \ 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.
+
+<a :href="$withBase('/img/home_de.png')" target="_blank"><img :src="$withBase('/img/home_de.png')" alt="BAS Home"></a>
+
+Auf der linken Seite ist das Sidepanel <span class="tutorial-label">1</span>, welches alle Module beinhaltet.
+Das Sidepanel kann mit <span class="tutorial-label">2</span> geöffnet und geschlossen werden.
+Das Verhalten des Sidepanels kann in den [Settings](/webapp/README.md#settings) Konfiguriert werden.
+
+Mit <span class="tutorial-label">3</span> kann das Aussehen der Webapplikation zwischen einem hellen und einem dunklen Design gewechselt werden.
+<span class="tutorial-label">4</span> ö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 <span class="tutorial-label">5</span> 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.
+
+<a :href="$withBase('/img/user_menu.png')" target="_blank"><img :src="$withBase('/img/user_menu.png')" alt="BAS Home"></a>
+
+
+## Benutzeraccount
+Im Benutzeraccount Modul, kann der Benutzer einige seiner Informationen ändern.
+
+<a :href="$withBase('/img/account.png')" target="_blank"><img :src="$withBase('/img/account.png')" alt="BAS Account"></a>
+
+Mit dem Bearbeitungsbutton <span class="tutorial-label">1</span> 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 <span class="tutorial-label">2</span> geändert werden. Das Passwort muss aus mindestens ```>= 8 Zeichen``` bestehen.
+
+Mit <span class="tutorial-label">3</span> kann der Benutzer seinen Account endgültig Löschen.
+::: danger
+Das Löschen des Accounts <span class="tutorial-label">3</span> kann **NICHT** rückgängig gemacht werden.
+:::
+
+## Einstellungen
+
+<a :href="$withBase('/img/settings_de.png')" target="_blank"><img :src="$withBase('/img/settings_de.png')" alt="BAS Settings"></a>
+
+## 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.
+
+<a :href="$withBase('/img/registration_menu.png')" target="_blank"><img :src="$withBase('/img/registration_menu.png')" alt="BAS Registration"></a>
+
+::: 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_<UUID>```.
+
+### 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.
+
+<a :href="$withBase('/img/registration_semi_ips.png')" target="_blank"><img :src="$withBase('/img/registration_semi_ips.png')" alt="BAS Registration IP Selection"></a>
+
+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.
+:::
+
+<a :href="$withBase('/img/registration_semi_name.png')" target="_blank"><img :src="$withBase('/img/registration_semi_name.png')" alt="BAS Registration Name"></a>
+
+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.
+
+<a :href="$withBase('/img/registration_semi_overview.png')" target="_blank"><img :src="$withBase('/img/registration_semi_overview.png')" alt="BAS Registration Overview"></a>
+
+### 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.
+
+<a :href="$withBase('/img/registration_manual_rooms.png')" target="_blank"><img :src="$withBase('/img/registration_manual_rooms.png')" alt="BAS Registration Room Selection"></a>
+
+
+### 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.