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/.vuepress/public/img/account.png | Bin 0 -> 209437 bytes documentation/.vuepress/public/img/account_de.png | Bin 0 -> 218175 bytes .../.vuepress/public/img/dark_light_theme.png | Bin 0 -> 193392 bytes .../.vuepress/public/img/dark_light_theme2.png | Bin 0 -> 204895 bytes documentation/.vuepress/public/img/home.png | Bin 232012 -> 231021 bytes .../public/img/registration_manual_rooms.png | Bin 0 -> 29318 bytes .../.vuepress/public/img/registration_menu.png | Bin 0 -> 21883 bytes .../.vuepress/public/img/registration_semi_ips.png | Bin 0 -> 22792 bytes .../public/img/registration_semi_name.png | Bin 0 -> 20327 bytes .../public/img/registration_semi_overview.png | Bin 0 -> 21603 bytes documentation/.vuepress/public/img/settings.png | Bin 0 -> 231304 bytes documentation/.vuepress/public/img/settings_de.png | Bin 0 -> 241068 bytes documentation/.vuepress/public/img/user_menu.png | Bin 0 -> 25143 bytes documentation/de/webapp/README.md | 41 +++++++++++++++- documentation/de/webapp/faq.md | 54 ++++++++++++++++++++- documentation/webapp/README.md | 40 ++++++++++++++- documentation/webapp/faq.md | 54 +++++++++++++++++++-- 17 files changed, 181 insertions(+), 8 deletions(-) create mode 100644 documentation/.vuepress/public/img/account.png create mode 100644 documentation/.vuepress/public/img/account_de.png create mode 100644 documentation/.vuepress/public/img/dark_light_theme.png create mode 100644 documentation/.vuepress/public/img/dark_light_theme2.png create mode 100644 documentation/.vuepress/public/img/registration_manual_rooms.png create mode 100644 documentation/.vuepress/public/img/registration_menu.png create mode 100644 documentation/.vuepress/public/img/registration_semi_ips.png create mode 100644 documentation/.vuepress/public/img/registration_semi_name.png create mode 100644 documentation/.vuepress/public/img/registration_semi_overview.png create mode 100644 documentation/.vuepress/public/img/settings.png create mode 100644 documentation/.vuepress/public/img/settings_de.png create mode 100644 documentation/.vuepress/public/img/user_menu.png (limited to 'documentation') diff --git a/documentation/.vuepress/public/img/account.png b/documentation/.vuepress/public/img/account.png new file mode 100644 index 0000000..ba60287 Binary files /dev/null and b/documentation/.vuepress/public/img/account.png differ diff --git a/documentation/.vuepress/public/img/account_de.png b/documentation/.vuepress/public/img/account_de.png new file mode 100644 index 0000000..8af17da Binary files /dev/null and b/documentation/.vuepress/public/img/account_de.png differ diff --git a/documentation/.vuepress/public/img/dark_light_theme.png b/documentation/.vuepress/public/img/dark_light_theme.png new file mode 100644 index 0000000..5491561 Binary files /dev/null and b/documentation/.vuepress/public/img/dark_light_theme.png differ diff --git a/documentation/.vuepress/public/img/dark_light_theme2.png b/documentation/.vuepress/public/img/dark_light_theme2.png new file mode 100644 index 0000000..ea16457 Binary files /dev/null and b/documentation/.vuepress/public/img/dark_light_theme2.png differ diff --git a/documentation/.vuepress/public/img/home.png b/documentation/.vuepress/public/img/home.png index f22054a..812f516 100644 Binary files a/documentation/.vuepress/public/img/home.png and b/documentation/.vuepress/public/img/home.png differ diff --git a/documentation/.vuepress/public/img/registration_manual_rooms.png b/documentation/.vuepress/public/img/registration_manual_rooms.png new file mode 100644 index 0000000..eedf90e Binary files /dev/null and b/documentation/.vuepress/public/img/registration_manual_rooms.png differ diff --git a/documentation/.vuepress/public/img/registration_menu.png b/documentation/.vuepress/public/img/registration_menu.png new file mode 100644 index 0000000..4fa0ca0 Binary files /dev/null and b/documentation/.vuepress/public/img/registration_menu.png differ diff --git a/documentation/.vuepress/public/img/registration_semi_ips.png b/documentation/.vuepress/public/img/registration_semi_ips.png new file mode 100644 index 0000000..fa07c2a Binary files /dev/null and b/documentation/.vuepress/public/img/registration_semi_ips.png differ diff --git a/documentation/.vuepress/public/img/registration_semi_name.png b/documentation/.vuepress/public/img/registration_semi_name.png new file mode 100644 index 0000000..cdf27e0 Binary files /dev/null and b/documentation/.vuepress/public/img/registration_semi_name.png differ diff --git a/documentation/.vuepress/public/img/registration_semi_overview.png b/documentation/.vuepress/public/img/registration_semi_overview.png new file mode 100644 index 0000000..90e7dce Binary files /dev/null and b/documentation/.vuepress/public/img/registration_semi_overview.png differ diff --git a/documentation/.vuepress/public/img/settings.png b/documentation/.vuepress/public/img/settings.png new file mode 100644 index 0000000..207270c Binary files /dev/null and b/documentation/.vuepress/public/img/settings.png differ diff --git a/documentation/.vuepress/public/img/settings_de.png b/documentation/.vuepress/public/img/settings_de.png new file mode 100644 index 0000000..f78ef15 Binary files /dev/null and b/documentation/.vuepress/public/img/settings_de.png differ diff --git a/documentation/.vuepress/public/img/user_menu.png b/documentation/.vuepress/public/img/user_menu.png new file mode 100644 index 0000000..3eec088 Binary files /dev/null and b/documentation/.vuepress/public/img/user_menu.png differ 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. diff --git a/documentation/webapp/README.md b/documentation/webapp/README.md index 473f161..17d06cc 100644 --- a/documentation/webapp/README.md +++ b/documentation/webapp/README.md @@ -1,6 +1,42 @@ # Webapplication -The webapplikation is the frontend for the BAS. It uses the same API calls, so everything which can be done in the frontend can also be done with the API. + +BAS Dark and Light Theme + +The webapplication is the frontend for the BAS. It uses the same API calls, so everything which can be done in the frontend can also be done with the API. + BAS Home +On the left side there is a sidepanel 1 with all the modules inside. +The sidepanel can be opened and closed with 2. +There are diffent appearances of the sidepanel which can be configured in the [Settings](/webapp/README.md#settings). +3 changes the style of the webapplication between a light and a dark theme. +4 opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications. +5 opens a small menu where you can go to the [User Settings](/webapp/README.md#user-account-settings), the [Settings](/webapp/README.md#settings) or Logout of the webapplication. + +BAS Home + + +## User Account +In the user account module the user is able to change some of his informations. + +BAS Account + +With the edit Button 1 the user is able to change his ```NAME``` and his ```E-MAIL```. +The change of the ```USERNAME``` is not possible in the account settings. + +::: tip +The ```USERNAME``` can only be changed in the [User Management](/webapp/modules.md#user-management) module where the ```EDIT``` permission is required. +::: + +The ```PASSWORD``` can be changed with pressing the 2 button. The requirements for a password are ```>= 8 characters```. + +With 3 the user can delete his account. +::: danger +Deleting your account with 3 can **NOT** be undone. +::: + +## Settings + +BAS Settings + ## Notifications -## Profile \ No newline at end of file diff --git a/documentation/webapp/faq.md b/documentation/webapp/faq.md index ef38a38..dbf0ec0 100644 --- a/documentation/webapp/faq.md +++ b/documentation/webapp/faq.md @@ -1,8 +1,54 @@ # [FAQ] How to ... -## Register a pc-pool -* Add Ip-Range for automatic sorting -* Create registration hooks +## Register a client +If a client netboots the BAS for the first time, it will boot the registration iPXE menu seen in the picture below. +Besides the registration of a client you can also direct boot the local installed OS or boot bwLehrpool without the need to register the client. + +BAS Registration + +::: tip +If you add an [IP-Range](/webapp/modules.md#ip-ranges) to a group before the registration, the client will automaticly sorted in as a child of the corresponding group. +::: +There are three ways to register a client: +* [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 the automatic registration the client will get the next free IP of the subnet in the DHCP as the fixed IP address. +It's added to the BAS with a default name ```Client_```. + + +### Semi-Automatic Registration +In the semi automatic registration a list of the next 20 free IPs of the subnet is provided and can be selected. +It will also be set as a fixed IP address in the DHCP. + +BAS Registration IP Selection + + +After the IP selection the registration asks the user for a client name. +::: warning +This name will also be the prefix of the hostname in the DHCP. +::: + +BAS Registration Name + +After those step an overview menu is provided, where the registration can be canceled or confirmed. + +BAS Registration Overview + +### Manual Registration +In the manual registration the room where the client will be sorted in can be selected. A list of all the rooms with the parent / client structure is provided. + +BAS Registration Room Selection + + +### Registration hooks +With the initial registration the client is added with the name, IP, MAC and UUID to the BAS and the backends. +To make further custom registration steps registration hooks can be configured, which will be executed rigth after the initial registration. +For more information about the registration hooks and how to create them go to [Registration Hooks](/webapp/modules.md#client-registration) + ## Move a pc-pool from one location to another -## Create an Event \ No newline at end of file +## Create an Event +The information on how events are created can be found in the [Eventmanager](/webapp/modules.md#event-manager). -- cgit v1.2.3-55-g7522