summaryrefslogtreecommitdiffstats
path: root/documentation
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
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')
-rw-r--r--documentation/.vuepress/public/img/account.pngbin0 -> 209437 bytes
-rw-r--r--documentation/.vuepress/public/img/account_de.pngbin0 -> 218175 bytes
-rw-r--r--documentation/.vuepress/public/img/dark_light_theme.pngbin0 -> 193392 bytes
-rw-r--r--documentation/.vuepress/public/img/dark_light_theme2.pngbin0 -> 204895 bytes
-rw-r--r--documentation/.vuepress/public/img/home.pngbin232012 -> 231021 bytes
-rw-r--r--documentation/.vuepress/public/img/registration_manual_rooms.pngbin0 -> 29318 bytes
-rw-r--r--documentation/.vuepress/public/img/registration_menu.pngbin0 -> 21883 bytes
-rw-r--r--documentation/.vuepress/public/img/registration_semi_ips.pngbin0 -> 22792 bytes
-rw-r--r--documentation/.vuepress/public/img/registration_semi_name.pngbin0 -> 20327 bytes
-rw-r--r--documentation/.vuepress/public/img/registration_semi_overview.pngbin0 -> 21603 bytes
-rw-r--r--documentation/.vuepress/public/img/settings.pngbin0 -> 231304 bytes
-rw-r--r--documentation/.vuepress/public/img/settings_de.pngbin0 -> 241068 bytes
-rw-r--r--documentation/.vuepress/public/img/user_menu.pngbin0 -> 25143 bytes
-rw-r--r--documentation/de/webapp/README.md41
-rw-r--r--documentation/de/webapp/faq.md54
-rw-r--r--documentation/webapp/README.md40
-rw-r--r--documentation/webapp/faq.md54
17 files changed, 181 insertions, 8 deletions
diff --git a/documentation/.vuepress/public/img/account.png b/documentation/.vuepress/public/img/account.png
new file mode 100644
index 0000000..ba60287
--- /dev/null
+++ b/documentation/.vuepress/public/img/account.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/account_de.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/dark_light_theme.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/dark_light_theme2.png
Binary files differ
diff --git a/documentation/.vuepress/public/img/home.png b/documentation/.vuepress/public/img/home.png
index f22054a..812f516 100644
--- a/documentation/.vuepress/public/img/home.png
+++ b/documentation/.vuepress/public/img/home.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/registration_manual_rooms.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/registration_menu.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/registration_semi_ips.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/registration_semi_name.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/registration_semi_overview.png
Binary files differ
diff --git a/documentation/.vuepress/public/img/settings.png b/documentation/.vuepress/public/img/settings.png
new file mode 100644
index 0000000..207270c
--- /dev/null
+++ b/documentation/.vuepress/public/img/settings.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/settings_de.png
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/user_menu.png
Binary files 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
+<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.
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.
+
+<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>
+
+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.
+
<a :href="$withBase('/img/home.png')" target="_blank"><img :src="$withBase('/img/home.png')" alt="BAS Home"></a>
+On the left side there is a sidepanel <span class="tutorial-label">1</span> with all the modules inside.
+The sidepanel can be opened and closed with <span class="tutorial-label">2</span>.
+There are diffent appearances of the sidepanel which can be configured in the [Settings](/webapp/README.md#settings).
+<span class="tutorial-label">3</span> changes the style of the webapplication between a light and a dark theme.
+<span class="tutorial-label">4</span> opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications.
+<span class="tutorial-label">5</span> 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.
+
+<a :href="$withBase('/img/user_menu.png')" target="_blank"><img :src="$withBase('/img/user_menu.png')" alt="BAS Home"></a>
+
+
+## User Account
+In the user account module the user is able to change some of his informations.
+
+<a :href="$withBase('/img/account.png')" target="_blank"><img :src="$withBase('/img/account.png')" alt="BAS Account"></a>
+
+With the edit Button <span class="tutorial-label">1</span> 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 <span class="tutorial-label">2</span> button. The requirements for a password are ```>= 8 characters```.
+
+With <span class="tutorial-label">3</span> the user can delete his account.
+::: danger
+Deleting your account with <span class="tutorial-label">3</span> can **NOT** be undone.
+:::
+
+## Settings
+
+<a :href="$withBase('/img/settings.png')" target="_blank"><img :src="$withBase('/img/settings.png')" alt="BAS Settings"></a>
+
## 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.
+
+<a :href="$withBase('/img/registration_menu.png')" target="_blank"><img :src="$withBase('/img/registration_menu.png')" alt="BAS Registration"></a>
+
+::: 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_<UUID>```.
+
+
+### 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.
+
+<a :href="$withBase('/img/registration_semi_ips.png')" target="_blank"><img :src="$withBase('/img/registration_semi_ips.png')" alt="BAS Registration IP Selection"></a>
+
+
+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.
+:::
+
+<a :href="$withBase('/img/registration_semi_name.png')" target="_blank"><img :src="$withBase('/img/registration_semi_name.png')" alt="BAS Registration Name"></a>
+
+After those step an overview menu is provided, where the registration can be canceled or confirmed.
+
+<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 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.
+
+<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
+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).