Files
vmailtool/README.md

106 lines
2.0 KiB
Markdown

k# VMail Manager Tool
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
- **Domain-Verwaltung**
- Anzeigen vorhandener Domains
- Hinzufügen neuer Domains
- Löschen bestehender Domains
- **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
- **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
```
---
## 🚀 Installation
### 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
```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.