man/de/man5/vmm.cfg.5
author Pascal Volk <neverseen@users.sourceforge.net>
Sat, 07 Aug 2010 05:16:26 +0000
branchv0.6.x
changeset 351 4bba5fb90b78
parent 170 d9ca5c46c1fa
child 433 c2543ddde9f5
permissions -rw-r--r--
VMM/handler: Small code cleanups.

.\" Man page generated from reStructeredText.
.
.TH VMM.CFG 5 "2010-01-18" "vmm-0.6.0" "vmm Manual"
.SH NAME
vmm.cfg \- Konfigurationsdatei für vmm
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
vmm.cfg
.SH BESCHREIBUNG
.sp
\fBvmm\fP(1) liest seine Konfigurationsparameter aus der Datei \fIvmm.cfg\fP.
.sp
Die Konfigurationsdatei ist in mehrere Abschnitte unterteilt. Jeder Abschnitt
wird mit dem, in eckigen Klammern \(aq\fB[\fP\(aq und \(aq\fB]\fP\(aq eingefassten, Namen des
Abschnitts eingeleitet, gefolgt von \(aq\fIOption\fP = \fIWert\fP\(aq Einträgen:
.sp
.nf
.ft C
[database]
host = 127.0.0.1
.ft P
.fi
.sp
Leerräume um das Gleichheitszeichen \(aq=\(aq und am Ende eines Wertes werden
ignoriert.
.sp
Leerzeilen und Zeilen, die mit einer \(aq#\(aq oder einem \(aq;\(aq anfangen, werden
ignoriert.
.sp
Jeder Wert ist von einem der folgenden Datentypen:
.INDENT 0.0
.IP \(bu 2
.
\fIBoolean\fP um zu bestimmen, ob etwas eingeschaltet/aktiviert (true) oder
ausgeschaltet/deaktiviert (false) ist.
.nf
Mögliche Werte für \fItrue\fP sind: \fB1\fP, \fByes\fP, \fBtrue\fP und \fBon\fP.
Mögliche Werte für \fIfalse\fP sind: \fB0\fP, \fBno\fP, \fBfalse\fP und \fBoff\fP.
.fi
.sp
.IP \(bu 2
.
\fIInt\fP eine Integer\-Zahl, geschrieben ohne eine gebrochene oder dezimale
Komponente.
.nf
Beispielsweise \fB1\fP, \fB50\fP oder \fB321\fP sind Integer\-Zahlen.
.fi
.sp
.IP \(bu 2
.
\fIString\fP eine Folge von Buchstaben und Zahlen.
.nf
Zum Beispiel: \(aq\fBWort\fP\(aq, \(aq\fBHallo Welt\fP\(aq oder \(aq\fB/usr/bin/strings\fP\(aq
.fi
.sp
.UNINDENT
.SS SUCHREIHENFOLGE
.sp
Standardmäßig sucht \fBvmm\fP(1) die \fIvmm.cfg\fP in folgenden Verzeichnissen,
in der angegebenen Reihenfolge:
.INDENT 0.0
.INDENT 3.5
.nf
\fI/root\fP
\fI/usr/local/etc\fP
\fI/etc\fP
.fi
.sp
.UNINDENT
.UNINDENT
.sp
Die zuerst gefundene Datei wird verwendet.
.SH ABSCHNITTE
.sp
Im Folgenden werden die Abschnitte der \fIvmm.cfg\fP und deren Optionen
beschrieben.
.SS ACCOUNT
.sp
Die Optionen des Abschnitts \fBaccount\fP legen Konto\-spezifische
Einstellungen fest.
.INDENT 0.0
.TP
.B \fCdelete_directory\fP
\fIBoolean\fP
.sp
Bestimmt das Verhalten von \fBvmm\fP(1) beim Löschen eines Kontos.
Wenn der Wert dieser Option \fItrue\fP ist, wird das Home\-Verzeichnis des
zu löschenden Anwenders rekursiv gelöscht.
.TP
.B \fCdirectory_mode\fP
\fIInt\fP
.sp
Zugriffsbits des Home\-Verzeichnisses, sowie aller enthaltenen
Verzeichnisse, in Dezimal\-Schreibweise (Basis 10).
.nf
Beispiel: \(aqdrwx\-\-\-\-\-\-\(aq \-> oktal 0700 \-> dezimal 448
.fi
.sp
.TP
.B \fCdisk_usage\fP
\fIBoolean\fP
.sp
Legt fest, ob die Festplattenbelegung des Maildirs eines Benutzers jedes
Mal mit \fBdu\fP(1) ermittelt und mit den Konto\-Informationen ausgegeben
werden soll.
.sp
Bei umfangreichen Maildirs kann das langsam sein. Falls Sie Quotas
aktiviert haben, wird der \fBvmm\fP\-Unterbefehl \fBuserinfo\fP ebenfalls
die aktuelle Quota\-Nutzung des Kontos mit ausgegeben. Sie können auch
eines der optionalen Argumente \fBdu\fP oder \fBfull\fP an \fBuserinfo\fP
übergeben, um sich die aktuelle Festplattenbelegung anzeigen zu lassen.
.TP
.B \fCimap\fP
\fIBoolean\fP
.sp
Bestimmt, ob sich neu angelegte Benutzer per IMAP anmelden können sollen.
.TP
.B \fCpassword_length\fP
\fIInt\fP
.sp
Diese Option legt die Anzahl der Zeichen für automatisch erzeugte
Passwörter fest. Alle Werte kleiner als 8 werden auf 8 erhöht.
.TP
.B \fCpop3\fP
.sp
Bestimmt, ob sich neu angelegte Benutzer per POP3 anmelden können sollen.
.TP
.B \fCrandom_password\fP
\fIBoolean\fP
.sp
Mit dieser Option wird bestimmt , ob \fBvmm\fP(1) ein zufälliges Passwort
generieren soll, wenn kein Passwort an den \fBuseradd\fP Unterbefehl
übergeben wurde. Ist der Wert dieser Option \fIfalse\fP, wird \fBvmm\fP Sie
auffordern, ein Passwort für den neun Account einzugeben.
.sp
Sie können die Länge für automatisch generierte Passwörter mit der
Option \fBpassword_length\fP konfigurieren.
.TP
.B \fCsieve\fP
\fIBoolean\fP
.sp
Bestimmt, ob sich neu angelegte Benutzer per ManageSieve anmelden
können sollen.
.TP
.B \fCsmtp\fP
\fIBoolean\fP
.sp
Bestimmt, ob sich neu angelegte Benutzer per SMTP (SMTP AUTH) anmelden
können sollen.
.UNINDENT
.sp
Beispiel:
.sp
.nf
.ft C
[account]
delete_directory = false
directory_mode = 448
disk_usage = false
random_password = true
password_length = 10
smtp = true
pop3 = true
imap = true
sieve = true
.ft P
.fi
.SS BIN
.sp
Im \fBbin\fP\-Abschnitt werden Pfade zu Binaries angegeben, die von
\fBvmm\fP(1) benötigt werden.
.INDENT 0.0
.TP
.B \fCdovecotpw\fP
\fIString\fP
.sp
Der absolute Pfad zum dovecotpw Binary. Dieses Binary wird zur
Hash\-Erzeugung verwendet, wenn \fBmisc.password_scheme\fP einen der
nachfolgenden Werte hat: \(aqSMD5\(aq, \(aqSSHA\(aq, \(aqCRAM\-MD5\(aq, \(aqHMAC\-MD5\(aq,
\(aqLANMAN\(aq, \(aqNTLM\(aq oder \(aqRPA\(aq.
.TP
.B \fCdu\fP
\fIString\fP
.sp
Der absolute Pfad zu \fBdu\fP(1). Dieses Binary wird verwendet, wenn
die Festplattenbelegung eines Kontos ermittelt wird.
.TP
.B \fCpostconf\fP
\fIString\fP
.sp
Der absolute Pfad zu Postfix\(aq \fBpostconf\fP(1). Dieses Binary wird
verwendet, wenn \fBvmm\fP(1) diverse Postfix\-Einstellungen prüft, zum
Beispiel das \fIvirtual_alias_expansion_limit\fP.
.UNINDENT
.sp
Beispiel:
.sp
.nf
.ft C
[bin]
dovecotpw = /usr/sbin/dovecotpw
du = /usr/bin/du
postconf = /usr/sbin/postconf
.ft P
.fi
.SS CONFIG
.sp
Beim \fBconfig\fP\-Abschnitt handelt es sich um einen internen
Steuerungs\-Abschnitt.
.INDENT 0.0
.TP
.B \fCdone\fP
\fIBoolean\fP
.sp
Diese Option hat den Wert \fIfalse\fP, wenn \fBvmm\fP(1) zum ersten Mal
installiert wurde. Wenn Sie die Datei \fIvmm.cfg\fP von Hand editieren,
weisen Sie dieser Option abschließend den Wert \fItrue\fP zu. Wird die
Konfiguration über das Kommando \fBvmm configure\fP angepasst, wird der
Wert dieser Option automatisch auf \fItrue\fP gesetzt.
.sp
Ist der Wert dieser Option  \fIfalse\fP, so startet \fBvmm\fP(1) beim
nächsten Aufruf im interaktiven Konfigurations\-Modus.
.UNINDENT
.sp
Beispiel:
.sp
.nf
.ft C
[config]
done = true
.ft P
.fi
.SS DATABASE
.sp
Der \fBdatabase\fP\-Abschnitt wird verwendet, um die für den Datenbankzugriff
benötigten Optionen festzulegen.
.INDENT 0.0
.TP
.B \fChost\fP
\fIString\fP
.sp
Der Hostname oder die IP\-Adresse des Datenbank\-Servers.
.TP
.B \fCname\fP
\fIString\fP
.sp
Der Name der zu verwendenden Datenbank.
.TP
.B \fCpass\fP
\fIString\fP
.sp
Das Passwort des Datenbank\-Benutzers.
.TP
.B \fCuser\fP
\fIString\fP
.sp
Der Name des Datenbank\-Benutzers.
.UNINDENT
.sp
Beispiel:
.sp
.nf
.ft C
[database]
host = localhost
user = vmm
pass = PY_SRJ}L/0p\-oOk
name = mailsys
.ft P
.fi
.SS DOMAIN
.sp
Im \fBdomain\fP\-Abschnitt werden Domain\-spezifische Informationen konfiguriert.
.INDENT 0.0
.TP
.B \fCauto_postmaster\fP
\fIBoolean\fP
.sp
Ist der Wert dieser Option \fItrue\fP, wird \fBvmm\fP(1) beim Anlegen einer
Domain automatisch einen postmaster\-Account erstellen.
.TP
.B \fCdelete_directory\fP
\fIBoolean\fP
.sp
Bestimmt, ob beim Löschen einer Domain das Verzeichnis einer Domain,
inklusive aller Anwender\-Verzeichnisse, rekursiv gelöscht werden soll.
.TP
.B \fCdirectory_mode\fP
\fIInt\fP
.sp
Zugriffsbits des Domain\-Verzeichnisses in Dezimal\-Schreibweise (Basis
10).
.nf
Beispiel: \(aqdrwxrwx\-\-\-\(aq \-> oktal 0770 \-> dezimal 504
.fi
.sp
.TP
.B \fCforce_deletion\fP
\fIBoolean\fP
.sp
Erzwingt das Löschen von Konten und Aliase beim Löschen einer Domain.
.UNINDENT
.sp
Beispiel:
.sp
.nf
.ft C
[domain]
auto_postmaster = true
delete_directory = false
directory_mode = 504
force_deletion = false
.ft P
.fi
.SS MAILDIR
.sp
Im \fBmaildir\fP\-Abschnitt werden die für die Maildirs erforderlichen Optionen
festgelegt.
.INDENT 0.0
.TP
.B \fCfolders\fP
\fIString\fP
.sp
Eine durch Doppelpunkten getrennte Liste mit Verzeichnisnamen, die
innerhalb des Maildirs erstellt werden sollen. Sollen innerhalb des
Maildirs keine Verzeichnisse angelegt werden, ist dieser Optionen ein
einzelner Doppelpunkt (\(aq\fB:\fP\(aq) als Wert zuzuweisen.
.sp
Sollen Verzeichnisse mit Unterverzeichnissen angelegt werden, ist ein
einzelner Punkt (\(aq\fB.\fP\(aq) als Separator zu verwenden.
.TP
.B \fCname\fP
\fIString\fP
.sp
Der Standard\-Name des Maildir\-Verzeichnisses im Verzeichnis des
jeweiligen Anwenders.
.UNINDENT
.sp
Beispiel:
.sp
.nf
.ft C
[maildir]
folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
name = Maildir
.ft P
.fi
.SS MISC
.sp
Im \fBmisc\fP\-Abschnitt werden verschiedene Einstellungen festgelegt.
.INDENT 0.0
.TP
.B \fCbase_directory\fP
\fIString\fP
.sp
Alle Domain\-Verzeichnisse werden innerhalb dieses Basis\-Verzeichnisses
angelegt.
.TP
.B \fCpassword_scheme\fP
\fIString\fP
.sp
Das zu verwendende Passwort\-Schema (siehe auch: \fBdovecotpw \-l\fP).
.TP
.B \fCgid_mail\fP
\fIInt\fP
.sp
Die numerische Gruppen\-ID der Gruppe mail, bzw. der Gruppe aus
\fImail_privileged_group\fP der Datei \fIdovecot.conf\fP.
.TP
.B \fCtransport\fP
\fIString\fP
.sp
Der Standard\-Transport aller Domains und Konten. Siehe auch:
\fBtransport\fP(5)
.TP
.B \fCdovecot_version\fP
\fIInt\fP
.sp
Die verketteten Major\- und Minor\-Teile der eingesetzten Dovecot\-Version
(siehe: \fBdovecot \-\-version\fP).
.sp
Wenn das Kommando \fBdovecot \-\-version\fP zum Beispiel \fI1.1.18\fP ausgibt,
ist dieser Option der Wert \fB11\fP zuzuweisen.
.UNINDENT
.sp
Beispiel:
.sp
.nf
.ft C
[misc]
base_directory = /srv/mail
password_scheme = CRAM\-MD5
gid_mail = 8
transport = dovecot:
dovecot_version = 11
.ft P
.fi
.SH DATEIEN
.INDENT 0.0
.TP
.B \fI/root/vmm.cfg\fP
.nf
Wird verwendet, falls vorhanden.
.fi
.sp
.TP
.B \fI/usr/local/etc/vmm.cfg\fP
.nf
Wird verwendet, sollte obige Datei nicht gefunden werden.
.fi
.sp
.TP
.B \fI/etc/vmm.cfg\fP
.nf
Wird verwendet, falls obengenannte Dateien nicht existieren.
.fi
.sp
.UNINDENT
.SH SIEHE AUCH
.sp
vmm(1), Programm für die Kommandozeile, um E\-Mail\-Domains, \-Konten und \-Aliase
zu verwalten.
.SH COPYING
.sp
vmm und die dazugehörigen Manualseiten wurden von Pascal Volk geschrieben
und sind unter den Bedingungen der BSD Lizenz lizenziert.
.SH AUTHOR
Pascal Volk <neverseen@users.sourceforge.net>
.\" Generated by docutils manpage writer.
.\" 
.