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/webapp/README.md | 40 +++++++++++++++++++++++++++++-- documentation/webapp/faq.md | 54 ++++++++++++++++++++++++++++++++++++++---- 2 files changed, 88 insertions(+), 6 deletions(-) (limited to 'documentation/webapp') 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