From 1ddf73cff31fe34ff09081e38dfa95537d85e4d6 Mon Sep 17 00:00:00 2001
From: Pascal Bouquet <pascal@bouquet24.de>
Date: Sat, 10 Jan 2026 10:40:57 +0100
Subject: [PATCH] =?UTF-8?q?Doku:=20README=20mit=20Installation=20und=20Nut?=
 =?UTF-8?q?zung=20erg=C3=A4nzt?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 117 +++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 89 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index 90a5d3d..7d0e06c 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,105 @@
-# VMail Manager Tool
+k# VMail Manager Tool
 
-Ein CLI-Tool zur einfachen Verwaltung von virtuellen Mail-Usern, Aliasen und Domains für Postfix/Dovecot Mailserver.
+Ein interaktives CLI-Tool zur Verwaltung von virtuellen Mail-Benutzern, Aliasen und Domains für **Postfix/Dovecot**-Mailserver.  
+Das Tool nutzt modernes **Argon2id**-Passwort-Hashing und zeigt dynamisch den Hostnamen des Systems an.
 
-## Features
-- Erstellen von Mail-Accounts mit **Argon2id** Passwort-Hashing (128MB, 4 Threads).
-- Verwaltung von Aliasen und Domains.
-- Aktivieren/Deaktivieren von Accounts.
-- Standard-Quota von 1024MB voreingestellt.
-- Dynamische Hostnamen-Anzeige.
+---
 
-## Installation
-1. Repository klonen
-2. Virtuelle Umgebung erstellen:
-   ```
-   python3 -m venv vmail-env
-   source vmail-env/bin/activate
-   pip install mysql-connector-python argon2-cffi
-   ```
+## ✨ Features
 
-## Systemweite Einrichtung (Globaler Befehl)
+- **Domain-Verwaltung**
+  - Anzeigen vorhandener Domains
+  - Hinzufügen neuer Domains
+  - Löschen bestehender Domains
 
-Damit das Tool von überall im System aufgerufen werden kann und automatisch die virtuelle Umgebung nutzt, gibt es zwei Möglichkeiten:
+- **Account-Verwaltung**
+  - Erstellen von Mail-Usern mit automatischem Argon2id-Hashing
+  - Standard-Quota: **1024 MB**
+  - Aktivieren / Deaktivieren von Accounts (Toggle)
+  - Passwortänderung für bestehende Benutzer
 
-### 1. Automatischer Interpreter (Shebang)
-Stelle sicher, dass die erste Zeile der `vmailtool.py` auf den Python-Interpreter deines venv zeigt:
-```
-#!/root/sql/vmail-env/bin/python3
+- **Alias-Verwaltung**
+  - Anlegen von E-Mail-Aliasen
+  - Löschen von Aliasen anhand der ID
+
+- **Sicherheit**
+  - Verdeckte Passworteingabe
+  - Datenbank-Zugangsdaten in separater Konfigurationsdatei
+
+---
+
+## 🧩 Voraussetzungen
+
+Beispiel für **Debian / Ubuntu**:
+
+```bash
+apt update
+apt install python3-venv python3-full
 ```
 
-### 2. Globaler Wrapper (Empfohlen)
-Erstelle eine Datei in /usr/local/bin, um das Tool systemweit mit dem Befehl vmailtool zu starten:
+---
 
-Datei erstellen: `nano /usr/local/bin/vmailtool`
+## 🚀 Installation
 
-Folgenden Inhalt einfügen:
+### 1. Repository klonen
 
+```bash
+git clone https://git.bouquet24.de/paase/vmailtool.git
+cd vmailtool
 ```
+
+### 2. Virtuelle Python-Umgebung erstellen
+
+```bash
+python3 -m venv vmail-env
+source vmail-env/bin/activate
+pip install mysql-connector-python argon2-cffi
+```
+
+---
+
+## ⚙️ Konfiguration
+
+Das Tool benötigt eine `config.ini`.
+
+```bash
+cp config.ini.example config.ini
+nano config.ini
+```
+
+---
+
+## 🌍 Globale Einrichtung (empfohlen)
+
+Damit das Tool systemweit verfügbar ist, kannst du ein Wrapper-Skript anlegen.
+
+### Wrapper anlegen
+
+```bash
+nano /usr/local/bin/vmailtool
+```
+
+### Inhalt (Pfade ggf. anpassen)
+
+```bash
 #!/bin/bash
 /root/sql/vmail-env/bin/python3 /root/sql/vmailtool.py
 ```
-Ausführbar machen: `chmod +x /usr/local/bin/vmailtool`
 
-Nun kann das Tool einfach durch die Eingabe von vmailtool gestartet werden, ohne manuell in den Ordner zu wechseln oder das venv zu aktivieren.
+### Ausführbar machen
+
+```bash
+chmod +x /usr/local/bin/vmailtool
+```
+
+Danach kannst du das Tool einfach starten mit:
+
+```bash
+vmailtool
+```
+
+---
+
+## 📌 Hinweis
+
+Dieses Tool ist für den Einsatz auf Servern mit **Postfix + Dovecot + MariaDB/MySQL** konzipiert und richtet sich an Administratoren, die Mailkonten komfortabel per CLI verwalten möchten.