From 1eb40b40c99b4aed31da983332e8b44275c19dd9 Mon Sep 17 00:00:00 2001
From: Paul-Christian Volkmer
Date: Fri, 1 Mar 2024 14:02:50 +0100
Subject: docs: add documentation for user roles

---
 README.md          |  17 +++++++++++++++++
 docs/userroles.png | Bin 0 -> 16671 bytes
 2 files changed, 17 insertions(+)
 create mode 100644 docs/userroles.png

diff --git a/README.md b/README.md
index e033d69..2f1fc25 100644
--- a/README.md
+++ b/README.md
@@ -114,6 +114,23 @@ Weitere Informationen zur Konfiguration des OIDC-Providers
 sind [hier](https://docs.spring.io/spring-security/reference/servlet/oauth2/index.html#oauth2-client)
 zu finden.
 
+#### Rollenbasierte Berechtigungen
+
+Wird OpenID Connect verwendet, gibt es eine rollenbasierte Berechtigungszuweisung. 
+
+Die Standardrolle für neue OIDC-Benutzer kann mit der Option `APP_SECURITY_DEFAULT_USER_ROLE` festgelegt werden.
+Mögliche Werte sind `user` oder `guest`. Standardwert ist `user`.
+
+Benutzer mit der Rolle "Gast" sehen nur die Inhalte, die auch nicht angemeldete Benutzer sehen.
+
+Hierdurch ist es möglich, einzelne Benutzer einzuschränken oder durch Änderung der Standardrolle auf `guest` nur
+einzelne Benutzer als vollwertige Nutzer zuzulassen.
+
+![Rollenverwaltung](docs/userroles.png)
+
+Benutzer werden nach dem Entfernen oder der Änderung der vergebenen Rolle automatisch abgemeldet und müssen sich neu anmelden.
+Sie bekommen dabei wieder die Standardrolle zugewiesen.
+
 #### Auswirkungen auf den dargestellten Inhalt
 
 Nur Administratoren haben Zugriff auf den Konfigurationsbereich, nur angemeldete Benutzer können die anonymisierte oder
diff --git a/docs/userroles.png b/docs/userroles.png
new file mode 100644
index 0000000..cefb175
Binary files /dev/null and b/docs/userroles.png differ
-- 
cgit v1.2.3