summaryrefslogtreecommitdiffstats
path: root/documentation/webapp/faq.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/webapp/faq.md')
-rw-r--r--documentation/webapp/faq.md54
1 files changed, 50 insertions, 4 deletions
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).