Files
vmailtool/README.md
2026-01-10 10:29:50 +01:00

45 lines
1.4 KiB
Markdown

# VMail Manager Tool
Ein CLI-Tool zur einfachen Verwaltung von virtuellen Mail-Usern, Aliasen und Domains für Postfix/Dovecot Mailserver.
## 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:
```bash
python3 -m venv vmail-env
source vmail-env/bin/activate
pip install mysql-connector-python argon2-cffi
## Systemweite Einrichtung (Globaler Befehl)
Damit das Tool von überall im System aufgerufen werden kann und automatisch die virtuelle Umgebung nutzt, gibt es zwei Möglichkeiten:
### 1. Automatischer Interpreter (Shebang)
Stelle sicher, dass die erste Zeile der `vmailtool.py` auf den Python-Interpreter deines venv zeigt:
```python
#!/root/sql/vmail-env/bin/python3
### 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`
Folgenden Inhalt einfügen:
```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.