summaryrefslogtreecommitdiffstats
path: root/documentation/webapp/modules.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/webapp/modules.md')
-rw-r--r--documentation/webapp/modules.md49
1 files changed, 48 insertions, 1 deletions
diff --git a/documentation/webapp/modules.md b/documentation/webapp/modules.md
index 459e972..883b781 100644
--- a/documentation/webapp/modules.md
+++ b/documentation/webapp/modules.md
@@ -1,6 +1,53 @@
# Modules
-## Group / Clients
+## Groups / Clients
+
+<a :href="$withBase('/img/groups_home.png')" target="_blank"><img :src="$withBase('/img/groups_home.png')" alt="BAS Groups and Clients"></a>
+
+Listed in the home view of the "Groups / Clients" module, accessible by the home icon in the top left <span class="tutorial-label">1</span>,
+are all groups and clients that have no parent group.
+The data can be refreshed without reloading the page by clicking on the refresh button in the top right corner <span class="tutorial-label">2</span>.
+
+Enabling the "All" switch <span class="tutorial-label">3</span> shows all groups and clients instead of top-level groups and clients only.
+This switch also works in a group to show all subgroups and clients within this group instead of direct children only.
+
+::: tip
+By clicking on the collapse button <span class="tutorial-label">5</span> the view can be switched from column to tabbed.
+:::
+
+To naviate to a group or client click on the arrow on the right <span class="tutorial-label">4</span> or double click the row.
+
+### Subgroup / Client
+
+<a :href="$withBase('/img/groups_group.png')" target="_blank"><img :src="$withBase('/img/groups_group.png')" alt="BAS Groups and Clients"></a>
+
+After naviating to a group or client general information about this group/client is displayed at the top.
+The information can be edited by clicking on edit button <span class="tutorial-label">1</span>.
+In edit mode this button is replaced with a save button to confirm the changes.
+
+The group or client can be deleted by pressing the delete button <span class="tutorial-label">2</span>.
+
+### Tables with Groups and Clients
+
+In the home view and in a group the groups and clients are displayed in two tables.
+By clicking the checkbox on the left (or anywhere on the row) a group/client can be selected.
+Below these tables are buttons for additional actions.
+
+Home view:
+* CREATE GROUP - Create a new group
+* CREATE CLIENT - Create a new client
+* DELETE X GROUPS - Permanently delete the selected groups
+* DELETE X CLIENTS - Permanently delete the selected clients
+
+Group view:
+* ADD SUBGROUPS - Add already existing groups to this group
+* ADD CLIENTS - Add already existing clients to this group
+* REMOVE X SUBGROUPS - Remove the selected groups from this group (Does not permanently delete the groups)
+* REMOVE X CLIENTS - Remove the selected clients from this group (Does not permanently delete the clients)
+
+Both:
+* WAKE X CLIENTS UP - Start the selected clients via Wake On Lan (Experimental feature: Does not work on all clients)
+
## IP Ranges
## iPXE Configurator
## Event Manager