From 88e650aae7de23a0fde40a6b9ad79140fe2b160f Mon Sep 17 00:00:00 2001
From: Raphael Dannecker <raphael.dannecker@steinbeisschule-reutlingen.de>
Date: Wed, 26 Mar 2025 14:51:31 +0100
Subject: [PATCH] Improve documentation

---
 README.md           | 29 ++++++++++++++++++++++++++++-
 doc/custom_roles.md | 15 ++++++++++++---
 doc/localuser.md    | 19 +++++++++++++++++++
 3 files changed, 59 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 41e0e77..c96b0a8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,30 @@
 # lmn-client
 
-Ansible playbooks and roles to deploy Debian clients for LinuxMuster.
\ No newline at end of file
+Ansible playbooks and roles to deploy Debian clients for LinuxMuster.
+
+## Default tasks
+
+* **Install/Update Debian**
+* **Install KDE-Plasma Desktop**
+* **Join domain**
+* **Activate kerberos-support**
+* **Mount homes from server**
+* **Install printer**
+  Installs local cups (printserver) and configures/installs all subscribed printers on login. Printers can be subscribed by user or by machine
+
+## Following optional modules are available:
+
+* [custom_roles](doc/custom_roles.md)
+  Runs own ansible roles.
+* [exam_mode](doc/exam_mode.md)
+  Starts local firewall and removes local directories of exam users the day after.
+* [localhome](doc/localhome.md)
+  Sometimes a local home directory makes more sense than the home on a network share.
+* [localuser](doc/localuser.md)
+  Creates a local guest user with home on tmpfs.
+* [vm_support](doc/vm_support.md)
+  VMs based on Qemu/KVM in school network.
+* [vpn](doc/vpn.md)
+  Provides VPN access to school network.
+* [wlan](doc/wlan.md)
+  Provides WLAN access via WPA Personal/Enterprise.
diff --git a/doc/custom_roles.md b/doc/custom_roles.md
index 0513288..f99ff3d 100644
--- a/doc/custom_roles.md
+++ b/doc/custom_roles.md
@@ -1,10 +1,21 @@
 # Custom roles
 
 - Custom ansible roles can be stored in `roles/custom`
-- To include custom roles into, you can list them in `custom_roles`.
+- To include custom roles, you can list them in `custom_roles`.
+
+## Configuration / Variables
+
+  * **custom_roles**
+    List of roles which will be applied
+    Type: *List of Strings*
+    Default: []
+
 
 ## Example
 
+All hosts (e.g. 10.0.2.14) will get `role_a` and `role_c`,
+but hosts in group laptop (e.g. 10.0.32.14) will get `role_a` and `role_b`
+
 ```
 roles/custom/
 ├── role_a
@@ -38,5 +49,3 @@ laptops:
       - role_b
 ```
 
-All hosts (e.g. 10.0.2.14) will get `role_a` and `role_c`,
-but hosts in group laptop (e.g. 10.0.32.14) will get `role_a` and `role_b`
diff --git a/doc/localuser.md b/doc/localuser.md
index f30f6a6..1a38c24 100644
--- a/doc/localuser.md
+++ b/doc/localuser.md
@@ -13,6 +13,25 @@ The associated password can be determined using the variable `localuser_password
 
 Default: `Muster!`
 
+## Configuration / Variables
+
+  * **localuser**
+    Username of local guest account
+    If set to `false` no user will be created
+    Type: *String*/*Boolean*
+    Values:
+    * `false` <-- (default)
+    * "username"
+  * **localuser_password**
+    Password of local guest user
+    Default: "Muster!"
+    Type: *String*
+  * **localuser_secretsalt**
+    Salt for creation of password hash
+    Default: "4ANAxPycC3q"
+    Type: *String*
+
+
 ## Example
 
 * Create local guest user only on devices in group laptops.