.TH "VMM" "1" "2011-10-26" "vmm 0.6" "vmm"

.SH NAME

vmm \- Kommandozeilenprogramm zur Verwaltung von E\-Mail\-Domains/\-Konten

und \-Aliase.

.\" -----------------------------------------------------------------------

.SH ÜBERSICHT

.B vmm

.IR Unterbefehl " [" "Argument ..." ]

.\" -----------------------------------------------------------------------

.SH BESCHREIBUNG

.B vmm

(a virtual mail manager) ist das einfach zu bedienende

Kommandozeilenprogramm für Administratoren und Postmaster, zur Verwaltung

von (Alias\-) Domains, Konten, Alias\-Adressen und sogenannten Relocated

Users.

Es ermöglicht die schnelle und einfache Verwaltung des Mailservers.

.br

Es wurde für Dovecot und Postfix mit einem PostgreSQL\-Backend entwickelt.

.PP

Von jedem

.I Unterbefehl

gibt es jeweils eine lange und kurze Variante.

Die Kurzform ist in Klammern geschrieben.

Bei beiden Formen ist die Groß-/Kleinschreibung zu berücksichtigen.

.PP

Die meisten

.IR Unterbefehl e

erwarten ein oder mehrere

.IR Argument e.

.\" -----------------------------------------------------------------------

.SH ARGUMENTE

.TP 13

.I Adresse

Die komplette E\-Mail\-Adresse

.RI ( local\-part @ FQDN )

eines Kontos, Aliases oder Relocated Users.

.\" --------------------------

.TP

.I FQDN

Der voll qualifizierten Domain\-Namen \(em ohne den abschließenden Punkt

\(em einer Domain oder Alias\-Domain.

.\" --------------------------

.TP

.I Nachrichten

Ein Integer\-Wert, der das maximal nutzbare Kontingent als Anzahl von

Nachrichten festlegt.

.br

Der Wert

.B 0

(null) bedeutet unbegrenzt \(em kein Quota\-Limit als Anzahl von

Nachrichten.

.\" --------------------------

.TP

.I Option

ist der Name einer Konfigurationsoption mit vorangestellter

Konfigurations\-Sektion, getrennt durch einen Punkt.

Zum Beispiel:

.IB misc . transport

.br

Alle Konfigurationsoptionen werden in

.BR vmm.cfg (5)

beschrieben.

.\" --------------------------

.TP

.I Service

Der Name eines Services, der gewöhnlicherweise in Verbindung mit Dovecot

genutzt wird.

Folgende Services werden unterstützt:

.BR imap ", " pop3 ", " sieve " und " smtp .

.\" --------------------------

.TP

.I Speicher

Bestimmt das maximal nutzbare Kontingent in Bytes.

Eines der folgenden Präfixe kann dem dem ganzzahligen Wert angehängt

werden:

.BR b " (Bytes), " k " (Kilobytes), " M " (Megabytes) oder " G

(Gigabytes).

.br

Der Wert

.B 0

(null) bedeutet unbegrenzt \(em kein Quota\-Limit in Bytes.

.\" --------------------------

.TP

.I Transport

ein Transport für Postfix, angegeben in der Form:

.IB transport :

oder

.IB transport :\c

.IR nexthop .

Siehe

.BR transport (5)

für weitere Details.

.\" --------------------------

.TP

.I Ziel\-Adresse

Ist entweder eine

.RI E\-Mail\- Adresse ,

wenn sie in Verbindung mit

.I "ALIAS UNTERBEFEHLEN"

verwendet wird, oder ein

.I FQDN

in Verbindung mit

.IR "ALIASDOMAIN UNTERBEFEHLEN" .

.\" -----------------------------------------------------------------------

.SH ALLGEMEINE UNTERBEFEHLE

.SS configget (cg)

.BI "vmm configget" " Option"

.PP

Dieser Unterbefehl wird verwendet, um den aktuellen Wert der übergebenen

.I Option

anzuzeigen.

.PP

Beispiel:

.PP

.nf

.B vmm configget misc.crypt_sha512_rounds

misc.crypt_sha512_rounds = 5000

.fi

.\" --------------------------

.SS configset (cs)

.B vmm configset

.I Option Wert

.PP

Verwenden Sie diesen Unterbefehl, um einer einzelnen Konfigurationsoption

einen neuen

.I Wert

zuzuweisen.

.I Option

ist der Name der Konfigurationsoption,

.I Wert

ist der Wert, der der Konfigurationsoption zugewiesen wird.

.IP Hinweis:

Diese Unterbefehl erstellt eine neue

.IR vmm.cfg ,

ohne Kommentare.

Die aktuelle Konfigurationsdatei wird als

.IR vmm.cfg.bak

gesichert.

.PP

Beispiel:

.PP

.nf

.B vmm configget misc.transport

misc.transport = dovecot:

.B vmm configset misc.transport lmtp:unix:private/dovecot\-lmtp

.B vmm cg misc.transport

misc.transport = lmtp:unix:private/dovecot\-lmtp

.fi

.\" ------------------------------------

.SS configure (cf)

.B vmm configure

.RI [ Sektion ]

.PP

Startet die interaktiven Konfiguration für alle Konfigurationssektionen.

.PP

Dabei wird der aktuell konfigurierte Wert einer jeden Option in eckigen

Klammern ausgegeben.

Sollte kein Wert konfiguriert sein, wird der Vorgabewert der jeweiligen

Option in in eckigen Klammern angezeigt.

Um den angezeigten Wert unverändert zu übernehmen, ist dieser mit der

Eingabe\-Taste zu bestätigen.

.PP

Wurde das optionale Argument

.I Sektion

angegeben, werden nur die Optionen der angegebenen Sektion angezeigt und

können geändert werden.

Folgende Sektionen sind vorhanden:

.RS

.TP 10

.B account

Konto Einstellungen

.TP

.B bin

Pfade zu externen Binär\-Dateien

.TP

.B database

Datenbank Einstellungen

.TP

.B domain

Domain Einstellungen

.TP

.B mailbox

Mailbox Einstellungen

.TP

.B misc

Verschiedene Einstellungen

.RE

.PP

Die Konfigurationsoptionen werden in

.BR vmm.cfg (5)

beschrieben.

.IP Hinweis:

Diese Unterbefehl erstellt eine neue

.IR vmm.cfg ,

ohne Kommentare.

Die aktuelle Konfigurationsdatei wird als

.IR vmm.cfg.bak

gesichert.

.PP

Beispiel:

.PP

.nf

.B vmm configure mailbox

Verwende Konfigurationsdatei: /usr/local/etc/vmm.cfg

* Konfigurations\-Sektion: „mailbox“

Neuer Wert für Option folders [Drafts:Sent:Templates:Trash]:

Neuer Wert für Option format [maildir]: mdbox

Neuer Wert für Option subscribe [True]:

Neuer Wert für Option root [Maildir]: mdbox

.fi

.\" ------------------------------------

.SS getuser (gu)

.BI "vmm getuser" " UID"

.PP

Wenn nur der

.I UID

eines Benutzers vorhanden ist, zum Beispiel aus der Prozessliste, kann mit

dem Unterbefehl

.B getuser

die E\-Mail\-Adresse des Benutzers ermittelt werden.

.PP

Beispiel:

.PP

.nf

.B vmm getuser 70772

Account Informationen

---------------------

        UID............: 70772

        GID............: 70312

        Address........: a.user@example.com

.fi

.\" ------------------------------------

.SS help (h)

.B vmm help

.RI [ Unterbefehl ]

.PP

Gibt ein Liste aller vorhandenen Unterbefehle mit einer kurzen Beschreibung

aus.

Wurde ein

.I Unterbefehl

angegeben, wird Hilfe zum Unterbefehl ausgegeben.

Danach wird

.B vmm

beendet.

.\" ------------------------------------

.SS listdomains (ld)

.B vmm listdomains

.RI [ Muster ]

.PP

Dieser Unterbefehl listet alle angelegten Domains auf.

Allen Domains wird ein Präfix vorangestellt.

Entweder ein `[+]', falls es sich um eine primäre Domain handelt, oder ein

`[-]', falls es sich um eine Alias\-Domain handelt.

Die Ausgabe kann reduziert werden, indem ein optionales

.I Muster

angegeben wird.

.PP

Um eine Wildcard\-Suche durchzuführen kann das %\-Zeichen am Anfang

und/oder Ende des

.I Musters

verwendet werden.

.PP

Beispiel:

.PP

.nf

.B vmm listdomains %example%

Übereinstimmende Domains

------------------------

        [+] example.com

        [\-]     e.g.example.com

        [\-]     example.name

        [+] example.org

        [+] sales.example.com

.fi

.\" ------------------------------------

.SS version (v)

.B vmm version

.PP

Gibt Versions\- und Copyright\-Informationen zu

.B vmm

aus.

Danach wird

.B vmm

beendet.

.\" -----------------------------------------------------------------------

.SH DOMAIN UNTERBEFEHLE

.SS domainadd (da)

.B vmm domainadd

.IR FQDN " [" Transport ]

.PP

Fügt eine neue Domain in die Datenbank ein und erstellt das

Domain\-Verzeichnis.

.PP

Wurde das optional Argument

.I Transport

angegeben, ersetzt der angegebene Transport den konfigurierten Transport

.RI ( misc.transport ") aus " vmm.cfg .

Der angegebene

.I Transport

ist der Vorgabe\-Transport für alle Konten, die dieser Domain zugeordnet

werden.

.PP

Konfigurationsbezogenes Verhalten:

.RS

.TP

.I domain.auto_postmaster

Wenn diese Option den Wert

.B true

(Vorgabe) hat, wird

.B vmm

nach erfolgreichem Anlegen der Domain auch das Konto für

.BI postmaster@ FQDN

erstellen.

.TP

.I account.random_password

Sollte dieser Option ebenfalls der Wert

.B true

zugewiesen sein, wird ein zufällig generiertes Passwort für den

Postmaster\-Account gesetzt und auf stdout ausgegeben.

.RE

.PP

Beispiele:

.PP

.nf

.B vmm domainadd support.example.com smtp:[mx1.example.com]:2025

Neues Passwort eingeben:

Neues Passwort wiederholen:

.B vmm cs account.random_password true

.B vmm domainadd vertrieb.example.com

Generiertes Passwort: Bg3eVmzKqtLn.Di7

.fi

.\" ------------------------------------

.SS domaindelete (dd)

.BI "vmm domaindelete " FQDN

.RB [ force ]

.PP

Dieser Unterbefehl löscht die Domain mit dem angegebenen

.IR FQDN .

.PP

Sollten der zu löschenden Domain Konten, Aliase und/oder Relocated User

zugeordnet sein, wird

.B vmm

die Ausführung des Befehls mit einer entsprechenden Fehlermeldung beenden.

Sollten Sie sich Ihres Vorhabens sicher sein, so kann optional das

Schlüsselwort

.B force

angegeben werden.

.PP

Sollten Sie wirklich immer wissen was Sie tun, so editieren Sie Ihre

.I vmm.cfg

und setzen den Wert der Option

.I domain.force_deletion

auf

.BR true .

Dann werden Sie zukünftig beim Löschen von Domains nicht mehr wegen

vorhanden Konten, Aliase und/oder Relocated User gewarnt.

.\" ------------------------------------

.SS domaininfo (di)

.B vmm domaininfo

.IR FQDN \ [ Details ]

.PP

Dieser Unterbefehl zeigt Informationen zur Domain mit dem angegebenen

.I FQDN

an.

.PP

Um detaillierte Informationen über die Domain zu erhalten, kann das

optionale Argument

.I Details

angegeben werden.

Ein möglicher Wert für

.I Details

kann eines der folgenden fünf Schlüsselwörter sein:

.RS

.TP 13

.B accounts

um alle eingerichteten Konten aufzulisten

.TP

.B aliasdomains

um alle zugeordneten Alias\-Domains aufzulisten

.TP

.B aliases

um alle vorhandenen Alias\-Adressen aufzulisten

.TP

.B relocated

um alle Adressen der Relocated Users aufzulisten

.TP

.B full

um alle oben genannten Informationen aufzulisten

.RE

.PP

Beispiel:

.PP

.nf

.B vmm domaininfo sales.example.com

Domain Informationen

--------------------

        Domainname.....: sales.example.com

        GID............: 70698

        Transport......: dovecot:

        Domaindir......: /srv/mail/k/70698

        Quota Limit....: Storage: 0; Messages: 0

        Aliasdomains...: 0

        Accounts.......: 1

        Aliases........: 0

        Relocated......: 0

.fi

.\" ------------------------------------

.SS domainquota (dq)

.B vmm domainquota

.IR "FQDN Speicher" " [" Nachrichten ]

.RB [ force ]

.PP

Dieser Unterbefehl wird verwendet, um für die Konten der Domain ein neues

Quota\-Limit festzulegen.

.PP

Standardmäßig gilt für Konten das Quota\-Limit der

.IR vmm.cfg " (" misc.quota_bytes " und " misc.quota_messages ).

Das neue Quota\-Limit wird für alle zukünftig angelegte Konten gelten.

Soll das neue Quota\-Limit auch auf bestehende Konten der Domain angewendet

werden, so ist das optionale Schlüsselwort

.B force

anzugeben.

.br

Wenn der Wert für das Argument

.I Nachrichten

ausgelassen wurde, wird der Vorgabewert

.B 0

(null) als Anzahl von Nachrichten angewendet werden.

.PP

Beispiel:

.PP

.nf

.B vmm domainquota example.com 1g force

.fi

.\" ------------------------------------

.SS domaintransport (dt)

.BI "vmm domaintransport" " FQDN Transport"

.RB [ force ]

.PP

Ein neuer

.I Transport

für die Domain mit dem angegebenen

.I FQDN

kann mit diesem Unterbefehl festgelegt werden.

.PP

Wurde das optionale Schlüsselwort

.B force

angegeben, so werden alle bisherigen Transport\-Einstellungen, der in

dieser Domain vorhandenen Konten, mit dem neuen

.I Transport

überschrieben.

Andernfalls gilt der neue

.I Transport

nur für Konten, die zukünftig erstellt werden.

.PP

Beispiel: