From c0d05804e501fd1114e5b09a9735cac0ecaf4ab5 Mon Sep 17 00:00:00 2001
From: alf <service@wralto.org>
Date: Thu, 31 Jul 2025 10:12:10 +0000
Subject: [PATCH] =?UTF-8?q?README.md=20hinzugef=C3=BCgt?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..79bba56
--- /dev/null
+++ b/README.md
@@ -0,0 +1,83 @@
+# LUKS Unlock/Lock Scripts für OMV
+
+Diese beiden Bash-Skripte erleichtern das Entsperren und Aushängen von verschlüsselten LUKS-Volumes auf einem OpenMediaVault-System (OMV), ohne die Web-GUI nutzen zu müssen.
+
+## 🔓 unlock_luks.sh
+
+Dieses Skript:
+
+- listet bekannte verschlüsselte Geräte (manuell gepflegte Liste im Skript),
+- fragt für jedes nach dem Passwort,
+- entsperrt es via `cryptsetup`,
+- ermittelt automatisch den UUID-Mountpoint in `/srv/dev-disk-by-uuid-*`,
+- und mountet das entschlüsselte Gerät.
+
+### Beispiel-Ausgabe
+
+```bash
+>>> Verarbeite media (/dev/sdc)
+  🔐 Passwort für media eingeben:
+  📍 Ziel-Mountpoint: /srv/dev-disk-by-uuid-abc123...
+  📦 Hänge /dev/mapper/media in /srv/dev-disk-by-uuid-abc123... ein...
+  ✅ Erfolgreich eingehängt.
+```
+
+## 🔒 lock_luks.sh
+
+Dieses Skript:
+
+- hängt das gemountete Volume aus,
+- prüft, ob Prozesse es noch verwenden (via `lsof`),
+- versucht notfalls ein "lazy unmount",
+- schließt das LUKS-Mapping via `cryptsetup close`.
+
+### Beispiel-Ausgabe
+
+```bash
+>>> Verarbeite media
+  📤 Hänge /srv/dev-disk-by-uuid-abc123... aus...
+  ✅ Erfolgreich ausgehängt.
+  🔒 Schließe /dev/mapper/media...
+  ✅ Mapper entfernt.
+```
+
+## 📦 Installation
+
+1. Skripte nach `/usr/local/bin` oder in ein geeignetes Verzeichnis kopieren.
+2. Ausführbar machen:
+
+```bash
+chmod +x unlock_luks.sh lock_luks.sh
+```
+
+3. Bei Bedarf über `sudo` ausführen:
+
+```bash
+sudo ./unlock_luks.sh
+```
+
+## ⚙️ Konfiguration
+
+Die zu verarbeitenden Devices sind direkt im Skript in einer Liste wie folgt hinterlegt:
+
+```bash
+declare -A LUKS_DEVICES=(
+  [eintb]="/dev/sda"
+  [media]="/dev/sdc"
+  [kleine]="/dev/sdd1"
+)
+```
+
+Ändere diese Liste nach deinen Gegebenheiten.
+
+## 🔐 Anforderungen
+
+- `cryptsetup`
+- `lsblk`
+- `mount`
+- `lsof` (für lock)
+- `udisks2` (optional)
+
+## 🛟 Hinweis
+
+Nutze diese Skripte mit Bedacht, insbesondere `lock_luks.sh`, da ungespeicherte Daten bei laufenden Prozessen verloren gehen können.
\ No newline at end of file