.TH "VMM.CFG" "5" "2012-08-12" "vmm 0.6" "vmm"

.SH NAME

vmm.cfg \- Konfigurationsdatei für vmm

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

.SH ÜBERSICHT

vmm.cfg

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

.SH BESCHREIBUNG

.BR vmm (1)

liest seine Konfigurationsparameter aus der Datei

.IR vmm.cfg .

.PP

Die Konfigurationsdatei ist in mehrere Sektionen unterteilt.

Jede Sektion wird mit dem in eckigen Klammern

.RB ' [ "' und '" ] '

eingefassten Namen der Sektion eingeleitet, gefolgt von

.RI ' Option " = " Wert '

Einträgen.

.PP

Leerräume um das Gleichheitszeichen '=' und am Ende eines Wertes werden

ignoriert.

Leerzeilen und Zeilen, die mit einer '#' oder einem ';' anfangen, werden

ignoriert.

.PP

Jeder Wert ist von einem der folgenden Datentypen:

.PP

.TP 8

.I Boolean

um festzulegen, ob etwas eingeschaltet/aktiviert (true) oder

ausgeschaltet/deaktiviert (false) ist.

.br

Mögliche Werte für

.I true

sind:

.BR 1 , " yes" , " true" " und " on .

.br

Mögliche Werte für

.I false

sind:

.BR 0 , " no" , " false" " und " off .

.TP

.I Int

eine Integer\-Zahl, geschrieben ohne eine gebrochene oder dezimale

Komponente.

.br

Beispielsweise

.BR 1 , " 50" " oder " 321

sind Integer\-Zahlen.

.TP

.I String

eine Folge von Buchstaben und Zahlen.

.br

Zum Beispiel:

.RB ' Wort "', '" "Hallo Welt" "' oder '" /usr/bin/strings '

.PP

Die meisten Optionen haben einen Vorgabewert.

Dieser ist nach dem Namen der Option in Klammern angegebenen.

Um den Vorgabewert einer Option zu verwenden, wird die entsprechende Zeile

entweder mit

.BR # " oder " ;

auskommentiert oder die Zeile wird einfach aus der

.I vmm.cfg

entfernt.

.PP

Eine minimale

.I vmm.cfg

könnte so aussehen:

.PP

.nf

[database]

user = ich

pass = xxxxxxxx

[misc]

dovecot_version = 1.2.16

.fi

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

.SH SUCHREIHENFOLGE

Standardmäßig sucht

.BR vmm (1)

die

.I vmm.cfg

in folgenden Verzeichnissen, in der angegebenen Reihenfolge:

.RS

.PD 0

.TP

.I

/root

.TP

.I

/usr/local/etc

.TP

.I

/etc

.PD

.RE

.PP

Die zuerst gefundene Datei wird verwendet.

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

.SH SEKTION ACCOUNT

Die Optionen der Sektion

.B account

legen Konto\-spezifische Einstellungen fest.

.SS account.delete_directory

.BR delete_directory " (Vorgabe: false) :"

.I Boolean

.PP

Bestimmt das Verhalten von

.BR vmm (1)

beim Löschen eines Kontos (userdelete).

Wenn der Wert dieser Option

.I true

ist, wird das Home\-Verzeichnis des zu löschenden Anwenders rekursiv

gelöscht.

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

.SS account.directory_mode

.BR directory_mode " (Vorgabe: 448) :"

.I Int

.PP

Zugriffsbits des Home\-Verzeichnisses, sowie aller enthaltenen

Verzeichnisse, in Dezimal\-Schreibweise (Basis 10).

.br

Beispiel: 'drwx\-\-\-\-\-\-' \(-> oktal 0700 \(-> dezimal 448

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

.SS account.disk_usage

.BR disk_usage " (Vorgabe: false) :"

.I Boolean

.PP

Legt fest, ob die Festplattenbelegung des Maildirs eines Benutzers jedes

Mal mit

.BR du (1)

ermittelt und mit den Konto\-Informationen ausgegeben werden soll.

.PP

Bei umfangreichen Maildirs kann das langsam sein.

Falls Sie Quotas aktiviert haben, wird der

.BR vmm\-Unterbefehl

userinfo ebenfalls die aktuelle Quota\-Nutzung des Kontos mit ausgegeben.

Sie können auch eines der optionalen Argumente

.BR du " oder " full

an userinfo übergeben, um sich die aktuelle Festplattenbelegung anzeigen zu

lassen.

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

.SS account.password_length

.BR password_length " (Vorgabe: 8) :"

.I Int

.PP

Diese Option legt die Anzahl der Zeichen für automatisch erzeugte

Passwörter fest.

Alle Werte kleiner als 8 werden auf 8 erhöht.

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

.SS account.random_password

.BR random_password " (Vorgabe: false) :"

.I Boolean

.PP

Mit dieser Option wird bestimmt, ob

.BR vmm (1)

ein zufälliges Passwort generieren soll, wenn kein Passwort an den

Unterbefehl useradd übergeben wurde.

Ist der Wert dieser Option

.IR false ,

wird

.B vmm

Sie auffordern, ein Passwort für den neuen Account einzugeben.

.PP

Sie können die Länge für automatisch generierte Passwörter mit der Option

.I account.password_length

konfigurieren.

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

.SH SEKTION BIN

In der

.BR bin \-Sektion

werden die Pfade zu den von

.BR vmm (1)

benötigten Binaries angegeben.

.SS bin.dovecotpw

.BR dovecotpw " (Vorgabe: /usr/sbin/dovecotpw) :"

.I String

.PP

Der absolute Pfad zum dovecotpw Binary.

Geben Sie den absoluten Pfad zum

.BR doveadm (1)

Binary an, falls Sie Dovecot v2.0 verwenden.

.PP

Dieses Binary wird zur Hash\-Erzeugung verwendet, wenn

.I misc.password_scheme

einen der nachfolgenden Werte hat: 'CRAM\-MD5', 'HMAC\-MD5', 'LANMAN',

\(aqOTP', 'RPA' oder 'SKEY'.

Dieses Binary wird auch benötigt, wenn Ihre Python\-Installation einen der

folgenden Hash\-Algorithmen nicht unterstützt:

.IP \(bu 4

md4: (hashlib + OpenSSL oder PyCrypto) verwendet für die Passwort\-Schemen:

\(aqPLAIN\-MD4' und 'NTLM'

.IP \(bu

sha256: (hashlib oder PyCrypto \(>= 2.1.0alpha1) verwendet für die

Passwort\-Schemen: 'SHA256' und 'SSHA256'

.IP \(bu

sha512: (hashlib) verwendet für die Passwort\-Schemen: 'SHA512' und

\(aqSSHA512'

.PP

Das

.BR doveadm (1)

Binary wird auch gebraucht, um die INBOX und zusätzliche Mailboxen

.RI ( mailbox.folders )

für einen neuen Account zu erstellen, wenn die Option

.I mailbox.format

den Wert

.BR mdbox " oder " sdbox

hat.

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

.SS bin.du

.BR du " (Vorgabe: /usr/bin/du) :"

.I String

.PP

Der absolute Pfad zu

.BR du (1).

Dieses Binary wird verwendet, wenn die Festplattenbelegung eines Kontos

ermittelt wird.

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

.SS bin.postconf

.BR postconf " (Vorgabe: /usr/sbin/postconf) :"

.I String

.PP

Der absolute Pfad zu Postfix'

.BR postconf (1).

Dieses Binary wird verwendet, wenn

.BR vmm (1)

diverse Postfix\-Einstellungen prüft, zum Beispiel das

.IR virtual_alias_expansion_limit .

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

.SH SEKTION DATABASE

Die

.BR database \-Sektion

wird verwendet, um die für den Datenbankzugriff erforderlichen Optionen

festzulegen.

.SS database.host

.BR host " (Vorgabe: localhost) :"

.I String

.PP

Der Hostname oder die IP\-Adresse des Datenbankservers.

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

.SS database.module

.BR module " (Vorgabe: psycopg2) :"

.I String

.PP

Das für den Datenbankzugriff zu verwendende Python PostgreSQL Adapter

Modul.

Unterstützte Module sind

.BR psycopg2 " und " pyPgSQL .

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

.SS database.name

.BR name " (Vorgabe: mailsys) :"

.I String

.PP

Der Name der zu verwendenden Datenbank.

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

.SS database.pass

.BR pass " (Vorgabe: " None ") :"

.I String

.PP

Das Passwort des Datenbank\-Benutzers.

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

.SS database.port

.BR port " (Vorgabe: 5432) :"

.I Int

.PP

Der TCP\-Port, auf dem der Datenbankserver Verbindungen annimmt.

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

.SS database.sslmode

.BR sslmode " (Vorgabe: prefer) :"

.I String

.PP

Bestimmt, ob und mit welcher Priorität eine SSL\-Verbindung mit dem

Datenbankserver ausgehandelt wird.

Mögliche Werte sind:

.BR disabled ", " allow ", " prefer ", " require ", " verify\-ca " und "

.BR verify\-full .

Die Modi

.BR verify\-ca " und " verify\-full

stehen seit PostgreSQL 8.4 zur Verfügung.

.PP

Diese Option wird ignoriert, wenn das

.I database.module

.B pyPgSQL

verwendet wird.

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

.SS database.user

.BR user " (Vorgabe: " None ") :"

.I String

.PP

Der Name des Datenbank\-Benutzers.

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

.SH SEKTION DOMAIN

In der

.BR domain \-Sektion

werden Domain\-spezifische Einstellungen hinterlegt.

.PP

Das Quota\-Limit (quota_bytes und quota_messages), Service\-Einstellungen

(imap,  pop3, sieve und smtp) und der Transport werden angewendet, wenn

eine Domain angelegt wird.

Um die Einstellungen einer vorhandenen Domain zu ändern, verwenden Sie

einen der folgenden

.BR vmm (1)

Unterbefehle:

.PP

.TP

.B domainquota

um das Quota\-Limit einer Domain zu ändern

.TP

.B domainservices

um einer Domain einen abweichenden Satz von nutzbaren Services zuzuweisen

.TP

.B domaintransport

um einen neuen Vorgabe\-Transport für eine Domain festzulegen

.PP

Wenn ein Account angelegt wird, erbt er alle Einstellungen von der Domain,

zu der er hinzugefügt wird.

Abweichende Einstellungen für einen vorhandenen Account nehmen Sie mit

einem der Unterbefehle

.BR userquota ", " userservices " und " usertransport

vor.

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

.SS domain.auto_postmaster

.BR auto_postmaster " (Vorgabe: true) :"

.I Boolean

.PP

Ist der Wert dieser Option

.IR true ,

wird

.BR vmm (1)

beim Anlegen einer Domain (domainadd) automatisch einen postmaster\-Account

erstellen.

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

.SS domain.delete_directory

.BR delete_directory " (Vorgabe: false) :"

.I Boolean

.PP

Legt fest, ob beim Löschen einer Domain (domaindelete) das Verzeichnis der

zu löschenden Domain, inklusive aller Anwender\-Verzeichnisse, rekursiv

gelöscht werden soll.

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

.SS domain.directory_mode

.BR directory_mode " (Vorgabe: 504) :"

.I Int

.PP

Zugriffsbits des Domain\-Verzeichnisses in Dezimal\-Schreibweise

(Basis 10).

.br

Beispiel: 'drwxrwx\-\-\-' \(-> oktal 0770 \(-> dezimal 504

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

.SS domain.force_deletion

.BR force_deletion " (Vorgabe: false) :"

.I Boolean

.PP

Erzwingt das Löschen aller zugeordneten Konten und Aliase beim Löschen

einer Domain (domaindelete).

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

.SS domain.imap

.BR imap " (Vorgabe: true) :"

.I Boolean

.PP

Legt fest, ob sich neu angelegte Benutzer per IMAP anmelden können sollen.

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

.SS domain.pop3

.BR pop3 " (Vorgabe: true) :"

.I Boolean

.PP

Legt fest, ob sich neu angelegte Benutzer per POP3 anmelden können sollen.

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

.SS domain.quota_bytes

.BR quota_bytes " (Vorgabe: 0) :"

.I String

.PP

Quota Limit in Bytes.

0 bedeutet unbegrenzt.

Dieses Limit wird beim Anlegen von Domains angewendet.

.PP

Der Wert dieser Option kann als Integer\-Wert, zum Beispiel

.B 20480

geschrieben werden.

Es ist auch möglich dem Wert eines der folgenden

Suffixe anzuhängen:

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

(Gigabytes).

.br

1024 entspricht 1024b oder 1k.

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

.SS domain.quota_messages

.BR quota_messages " (Vorgabe: 0) :"

.I Int

.PP

Quota Limit als Anzahl von Nachrichten.

0 bedeutet unbegrenzt.

Dieses Limit wird beim Anlegen neuer Domains angewendet.

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

.SS domain.sieve

.BR sieve " (Vorgabe: true) :"

.I Boolean

.PP

Legt fest, ob sich neu angelegte Benutzer per SIEVE (ManageSieve) anmelden

können sollen.

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

.SS domain.smtp

.BR smtp " (Vorgabe: true) :"

.I Boolean

.PP

Legt fest, ob sich neu angelegte Benutzer per SMTP (SMTP AUTH) anmelden

können sollen.

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

.SS domain.transport

.BR transport " (Vorgabe: dovecot:) :"

.I String

.PP

Der Standard\-Transport aller neuen Domains.

Siehe auch:

.BR transport (5).

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

.SH SEKTION MAILBOX

In der

.BR mailbox \-Sektion

werden die für die Erstellung von Mailboxen erforderlichen Optionen

festgelegt.

Die INBOX wird in jedem Fall erstellt.

.SS mailbox.folders

.BR folders " (Vorgabe: Drafts:Sent:Templates:Trash) :"

.I String

.PP

Eine durch Doppelpunkte getrennte Liste mit Namen der zu erstellenden

Mailboxen.

Sollen keine zusätzlichen Mailboxen angelegt werden, ist dieser Option ein

einzelner Doppelpunkt

.RB (' : ')

als Wert zuzuweisen.

.PP

Sollen Verzeichnisse mit Unterverzeichnissen angelegt werden, ist ein

einzelner Punkt

.RB (' . ')

als Separator zu verwenden.

.PP

Sollen Mailboxen mit internationalisierten Namen erstellt werden (zum

Beispiel: 'Wysłane' oder 'Gelöschte Objekte'), ist der Name UTF\-8 kodiert

anzugeben.

.BR vmm (1)

wird die internationalisierten Mailboxnamen in eine modifizierten Variante

des UTF\-7\-Zeichensatzes (siehe auch: RFC 3501, Sektion 5.1.3)

konvertieren.

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

.SS mailbox.format

.BR format " (Vorgabe: maildir) :"

.I String

.PP

Das zu verwendende Mailbox\-Format für die Mailboxen der Benutzer.

Abhängig von der verwendeten Dovecot\-Version

.RI ( misc.dovecot_version ),