man/man5/vmm.cfg.5.rst
author Pascal Volk <neverseen@users.sourceforge.net>
Wed, 09 Feb 2011 22:09:35 +0000
branchv0.6.x
changeset 389 5f7e9f778b29
parent 384 d3a97f7fb98a
permissions -rw-r--r--
VMM/account: Removed unused method Account.set_transport().
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     1
=========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     2
 vmm.cfg
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     3
=========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     4
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     5
--------------------------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     6
configuration file for vmm
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     7
--------------------------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     8
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     9
:Author:         Pascal Volk <neverseen@users.sourceforge.net>
269
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
    10
:Date:           |today|
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    11
:Version:        vmm-0.6.0
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    12
:Manual group:   vmm Manual
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    13
:Manual section: 5
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    14
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    15
.. contents::
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    16
  :backlinks: top
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    17
  :class: htmlout
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    18
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    19
SYNOPSIS
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    20
========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    21
vmm.cfg
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    22
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    23
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    24
DESCRIPTION
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    25
===========
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    26
|vmm(1)|_ reads its configuration data from *vmm.cfg*.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    27
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    28
The configuration file is split into multiple sections. A section starts with
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    29
the section name, enclosed in square brackets '**[**' and '**]**', followed
177
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    30
by '*option* = *value*' pairs.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    31
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    32
Whitespace around the '=' and at the end of a value is ignored.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    33
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    34
Empty lines and lines starting with '#' or ';' will be ignored.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    35
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    36
Each value uses one of the following data types:
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    37
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    38
* *Boolean* to indicate if something is enabled/activated (true) or
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    39
  disabled/deactivated (false).
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    40
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    41
  | Accepted values for *true* are: **1**, **yes**, **true** and **on**.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    42
  | Accepted values for *false* are: **0**, **no**, **false** and **off**.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    43
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    44
* *Int* an integer number, written without a fractional or decimal component.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    45
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    46
  | For example **1**, **50** or **321** are integers.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    47
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    48
* *String* a sequence of characters and numbers.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    49
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    50
  | For example '**word**', '**hello world**' or '**/usr/bin/strings**'
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    51
177
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    52
Most options have a default value, shown in parentheses after the option's
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    53
name. In order to use a option's default setting, comment out the line,
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    54
either with a **#** or **;** or simply remove the setting from *vmm.cfg*.
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    55
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    56
A minimal *vmm.cfg* would be::
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    57
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    58
  [database]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    59
  user = me
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    60
  pass = xxxxxxxx
177
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    61
288
01cb71c1ae33 man5: added misc.dovecot_version to the minimal config example.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 286
diff changeset
    62
  [misc]
01cb71c1ae33 man5: added misc.dovecot_version to the minimal config example.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 286
diff changeset
    63
  dovecot_version = 1.2.11
01cb71c1ae33 man5: added misc.dovecot_version to the minimal config example.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 286
diff changeset
    64
177
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    65
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    66
SEARCH ORDER
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    67
-------------
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    68
By default |vmm(1)|_ looks for *vmm.cfg* in the following directories in the
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    69
order listed:
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    70
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    71
  | */root*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    72
  | */usr/local/etc*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    73
  | */etc*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    75
The first configuration file found will be used.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    76
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    77
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
SECTIONS
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
This section describes all sections and their options of the *vmm.cfg*.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    82
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    83
ACCOUNT
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    84
-------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    85
The options in the section **account** are used to specify user account
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
related settings.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    87
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    88
.. _account.delete_directory:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    89
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    90
``delete_directory (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    91
  Determines the behavior of |vmm(1)|_ when an account is deleted
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    92
  (|userdelete|_). If this option is set to *true* the user's home directory
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    93
  will be deleted  recursively.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    94
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    95
.. _account.directory_mode:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    96
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    97
``directory_mode (default: 448)`` : *Int*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    98
  Access mode for a user's home directory and all directories inside. The
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    99
  value has to be specified in decimal (base 10) notation.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   100
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   101
  | For example: 'drwx------' -> octal 0700 -> decimal 448
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   102
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   103
.. _account.disk_usage:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   105
``disk_usage (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   106
  Determines whether the disk usage of a user's Maildir always should be
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   107
  summarized, using **du**\(1), and displayed with account information.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   108
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   109
  This could be slow on large Maildirs. When you have enabled quotas,
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   110
  **vmm**'s |userinfo|_ subcomammand will also display the current quota
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   111
  usage of the account. You may also use |userinfo|_'s optional argument
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   112
  **du** or **full**, in order to display the current disk usage of an
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   113
  account's Maildir.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   114
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   115
.. _account.imap:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   116
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   117
``imap (default: true)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   118
  Determines whether a newly created user can log in via IMAP.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   119
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   120
.. _account.password_length:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   121
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   122
``password_length (default: 8)`` : *Int*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   123
  Determines how many characters and/or numbers should be used for randomly
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   124
  generated passwords. Any value less than 8 will be increased to 8.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   125
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   126
.. _account.pop3:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   127
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   128
``pop3 (default: true)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129
    Determines whether a newly created user can log in via POP3.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   130
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   131
.. _account.random_password:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   132
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   133
``random_password (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   134
  Determines whether **vmm** should generate a random password when no
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   135
  password was given for the |useradd|_ subcommand. If this option is set to
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   136
  *false* **vmm** will prompt you to enter a password for the new account.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   137
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   138
  You can specify the password length of generated passwords with the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   139
  |account.password_length|_ option.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   140
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   141
.. _account.sieve:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   142
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   143
``sieve (default: true)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   144
  Determines whether a newly created user can log in via ManageSieve.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   145
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   146
.. _account.smtp:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   147
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   148
``smtp (default: true)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   149
  Determines whether a newly created user can log in via SMTP (SMTP AUTH).
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   150
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   151
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   152
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   153
  [account]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   154
  delete_directory = false
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   155
  directory_mode = 448
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   156
  disk_usage = false
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   157
  random_password = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   158
  password_length = 10
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   159
  smtp = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   160
  pop3 = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   161
  imap = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   162
  sieve = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   163
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   164
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   165
BIN
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   166
---
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   167
The **bin** section is used to specify some paths to some binaries required
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   168
by |vmm(1)|_.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   169
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   170
.. _bin.dovecotpw:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   171
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   172
``dovecotpw (default: /usr/sbin/dovecotpw)`` : *String*
269
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   173
  The absolute path to the dovecotpw binary. Use the absolute path to the
299
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   174
  **doveadm**\(1) binary, if you are using Dovecot v2.0. This binary is used
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   175
  to generate a password hash, if |misc.password_scheme|_ is set to one of
269
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   176
  'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'OTP', 'RPA' or 'SKEY'. This binary will
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   177
  be also required if your Python installation doesn't support the:
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   178
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   179
  * md4 hash algorithm (hashlib + OpenSSL or PyCrypto) used for the password
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   180
    schemes: 'PLAIN-MD4' and 'NTLM'
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   181
  * sha256 hash algorithm (hashlib or PyCrypto >= 2.1.0alpha1) used for the
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   182
    password schemes: 'SHA256' and 'SSHA256'
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   183
  * sha512 hash algorithm (hashlib) used for the password schemes 'SHA512'
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   184
    and 'SSHA512'
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   185
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   186
.. _bin.du:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   187
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   188
``du (default: /usr/bin/du)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   189
  The absolute path to **du**\(1). This binary is used to summarize the disk
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   190
  usage of a user's Maildir.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   191
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   192
.. _bin.postconf:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   193
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   194
``postconf (default: /usr/sbin/postconf)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   195
  The absolute path to Postfix' |postconf(1)|_. This binary is required when
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   196
  |vmm(1)|_ has to check for some Postfix settings, e.g.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   197
  |virtual_alias_expansion_limit|_.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   198
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   199
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   200
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   201
  [bin]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   202
  dovecotpw = /usr/sbin/dovecotpw
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   203
  du = /usr/bin/du
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   204
  postconf = /usr/sbin/postconf
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   205
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   206
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   207
DATABASE
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   208
--------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   209
The **database** section is used to specify some options required to
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   210
connect to the database.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   211
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   212
.. _database.host:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   213
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   214
``host (default: localhost)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   215
  Hostname or IP address of the database server.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   216
357
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   217
.. _database.module:
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   218
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   219
``module (default: psycopg2)`` : *String*
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   220
  The Python PostgreSQL database adapter module to be used. Supported modules
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   221
  are **psycopg2** and **pyPgSQL**.
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   222
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   223
.. _database.name:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   224
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   225
``name (default: mailsys)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   226
  Name of the database.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   227
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   228
.. _database.pass:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   229
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   230
``pass (default: None)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   231
  Database password.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   232
357
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   233
.. _database.port:
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   234
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   235
``port (default: 5432)`` : *Int*
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   236
  The TCP port, on which the database server is listening for connections.
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   237
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   238
.. _database.sslmode:
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   239
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   240
``sslmode (default: prefer)`` : *String*
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   241
  Determines whether and with what priority an SSL connection will be
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   242
  negotiated with the database server. Possible values are: **disabled**,
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   243
  **allow**, **prefer**, **require**, **verify-ca**, and **verify-full**.
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   244
  The modes **verify-ca** and **verify-full** are available since PostgreSQL
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   245
  8.4.
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   246
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   247
  This setting will be ignored when the pyPgSQL *module* is used.
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   248
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   249
.. _database.user:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   250
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   251
``user (default: None)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   252
  Name of the database user.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   253
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   254
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   255
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   256
  [database]
357
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   257
  host = dbsrv8.example.net
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   258
  port 5433
095b43faaba5 man5/vmm.cfg: Added description for new settings in section database.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 307
diff changeset
   259
  sslmode = require
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   260
  user = vmm
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   261
  pass = PY_SRJ}L/0p-oOk
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   262
  name = mailsys
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   263
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   264
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   265
DOMAIN
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   266
------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   267
The **domain** section specifies some domain related settings.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   268
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   269
.. _domain.auto_postmaster:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   270
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   271
``auto_postmaster (default: true)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   272
  Determines if |vmm(1)|_ should create also a postmaster account when a new
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   273
  domain is created (|domainadd|_).
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   274
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   275
.. _domain.delete_directory:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   276
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   277
``delete_directory (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   278
  Specifies whether the domain directory and all user directories inside
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   279
  should be deleted when a domain is deleted (|domaindelete|_).
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   280
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   281
.. _domain.directory_mode:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   282
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   283
``directory_mode (default: 504)`` : *Int*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   284
  Access mode for the domain directory in decimal (base 10) notation.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   285
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   286
  | For example: 'drwxrwx---' -> octal 0770 -> decimal 504
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   287
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   288
.. _domain.force_deletion:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   289
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   290
``force_deletion (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   291
  Force deletion of accounts and aliases when a domain is deleted
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   292
  (|domaindelete|_).
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   293
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   294
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   295
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   296
  [domain]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   297
  auto_postmaster = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   298
  delete_directory = false
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   299
  directory_mode = 504
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   300
  force_deletion = false
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   301
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   302
230
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   303
MAILBOX
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   304
-------
230
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   305
The **mailbox** section is used to specify some options for new created
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   306
mailboxes in the users home directories. The INBOX will be created always.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   307
230
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   308
.. _mailbox.folders:
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   309
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   310
``folders (default: Drafts:Sent:Templates:Trash)`` : *String*
299
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   311
  A colon separated list of mailboxes that should be created. If no
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   312
  additionally mailboxes should be created, set the value of this option to a
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   313
  single colon ('**:**').
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   314
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   315
  If you want to create folders containing one or more subfolders, separate
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   316
  them with a single dot ('**.**').
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   317
299
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   318
  If you want to use internationalized mailbox names (e.g. 'Wysłane' or
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   319
  'Gelöschte Objekte'), write their names UTF-8 encoded. |vmm(1)|_ will convert
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   320
  internationalized mailbox names to a modified  version of the UTF-7 encoding
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   321
  (see also: :RFC:`3501`, section 5.1.3).
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   322
230
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   323
.. _mailbox.format:
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   324
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   325
``format (default: maildir)`` : *String*
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   326
  The mailbox format to be used for a user's mailbox. Depending on the used
299
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   327
  Dovecot version there are up to three supported formats:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   328
230
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   329
    ``maildir``
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   330
      since Dovecot v1.0.0
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   331
    ``mdbox``
307
217b419d6561 VMM/maillocation: Dovecot >= 2.0.beta5 is required for `doveadm mailbox create -s …`
Pascal Volk <neverseen@users.sourceforge.net>
parents: 304
diff changeset
   332
      since Dovecot v2.0.beta5
299
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   333
    ``sdbox``
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   334
      since Dovecot v2.0.rc3
230
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   335
299
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   336
.. _mailbox.root:
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   337
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   338
``root (default: Maildir)`` : *String*
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   339
  Name of the mailbox root directory in a user's home directory. Commonly used
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   340
  names, depending on the used |mailbox.format|_, are **Maildir**, **mdbox**
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   341
  or **sdbox**.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   342
304
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   343
.. _mailbox.subscribe:
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   344
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   345
``subscribe (default: true)`` : *Boolean*
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   346
  When this option is set to **true**, the mailboxes from the
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   347
  |mailbox.folders|_ option will be listed in the user's subscriptions file.
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   348
  If you don't want to subscribe the created mailboxes, set this option to
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   349
  **false**.
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   350
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   351
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   352
230
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   353
  [mailbox]
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   354
  folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
230
eefbe052a135 man: updated configuration manual pages (maildir.* -> mailbox.*).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 180
diff changeset
   355
  format = maildir
299
d15a27eaa9d2 man/{,de/}man5/vmm.cfg.5.rst: Added mailbox.root, small updates.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 291
diff changeset
   356
  root = Maildir
304
df0f7b22540c VMM/Config: Added boolean option mailbox.subscribe.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 299
diff changeset
   357
  subscribe = false
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   358
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   359
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   360
MISC
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   361
----
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   362
The **misc** section is used to define miscellaneous settings.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   363
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   364
.. _misc.base_directory:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   365
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   366
``base_directory (default: /srv/mail)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   367
  All domain directories will be created inside this directory.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   368
284
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   369
.. _misc.crypt_blowfish_rounds:
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   370
291
7ef3f117a230 VMM/password: adapted Blowfish/SHA-256/SHA-512 crypt() to recent
Pascal Volk <neverseen@users.sourceforge.net>
parents: 288
diff changeset
   371
``crypt_blowfish_rounds (default: 5)`` : *Int*
7ef3f117a230 VMM/password: adapted Blowfish/SHA-256/SHA-512 crypt() to recent
Pascal Volk <neverseen@users.sourceforge.net>
parents: 288
diff changeset
   372
  Number of encryption rounds for the *password_scheme* **BLF-CRYPT**.
284
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   373
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   374
  The value must be in range **4** - **31**.
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   375
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   376
.. _misc.crypt_sha256_rounds:
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   377
291
7ef3f117a230 VMM/password: adapted Blowfish/SHA-256/SHA-512 crypt() to recent
Pascal Volk <neverseen@users.sourceforge.net>
parents: 288
diff changeset
   378
``crypt_sha256_rounds (default: 5000)`` : *Int*
7ef3f117a230 VMM/password: adapted Blowfish/SHA-256/SHA-512 crypt() to recent
Pascal Volk <neverseen@users.sourceforge.net>
parents: 288
diff changeset
   379
  Number of encryption rounds for the *password_scheme* **SHA256-CRYPT**.
284
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   380
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   381
  The value must be in range **1000** - **999999999**.
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   382
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   383
.. _misc.crypt_sha512_rounds:
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   384
291
7ef3f117a230 VMM/password: adapted Blowfish/SHA-256/SHA-512 crypt() to recent
Pascal Volk <neverseen@users.sourceforge.net>
parents: 288
diff changeset
   385
``crypt_sha512_rounds (default: 5000)`` : *Int*
7ef3f117a230 VMM/password: adapted Blowfish/SHA-256/SHA-512 crypt() to recent
Pascal Volk <neverseen@users.sourceforge.net>
parents: 288
diff changeset
   386
  Number of encryption rounds for the *password_scheme* **SHA512-CRYPT**.
284
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   387
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   388
  The value must be in range **1000** - **999999999**.
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   389
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   390
.. _misc.password_scheme:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   391
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   392
``password_scheme (default: CRAM-MD5)`` : *String*
269
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   393
  Password scheme to use. To get a list of all available password schemes
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   394
  execute the command **dovecotpw -l** (Dovecot v1.x) or **doveadm pw -l**
188ea8d6072f man/{,de/}man5/vmm.cfg.5.rst: Updated descriptions of dovecotpw
Pascal Volk <neverseen@users.sourceforge.net>
parents: 264
diff changeset
   395
  (Dovecot v2.0).
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   396
384
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   397
.. _misc.quota_bytes:
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   398
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   399
``quota_bytes (default: 0)`` : *String*
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   400
  Quota limit in bytes. 0 means unlimited. This limit will be applied to
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   401
  all newly created domains.
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   402
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   403
  The option's value can be written as an integer value, e.g.: **20480**.
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   404
  Its also possible to append one of the following suffixes to the limit:
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   405
  **b** (bytes), **k** (kilobytes), **M** (megabytes) or **G** (gigabytes).
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   406
  **1024** is the same as **1024b** or **1k**.
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   407
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   408
.. _misc.quota_messages:
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   409
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   410
``quota_messages (default: 0)`` : *Int*
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   411
  Quota limit in number of messages. 0 means unlimited. This limit will be
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   412
  applied to all newly created domains.
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   413
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   414
.. _misc.transport:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   415
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   416
``transport (default: dovecot:)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   417
  Default transport for domains and accounts. For details see
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   418
  |transport(5)|_.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   419
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   420
.. _misc.dovecot_version:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   421
286
e2046d47688b VMM/Config: removed the default value of misc.dovecot_version.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 284
diff changeset
   422
``dovecot_version (default: None)`` : *String*
264
04fea4d8b900 Use the complete Dovecot version, not only the concatenated major
Pascal Volk <neverseen@users.sourceforge.net>
parents: 230
diff changeset
   423
  The version number of the currently used Dovecot version.
04fea4d8b900 Use the complete Dovecot version, not only the concatenated major
Pascal Volk <neverseen@users.sourceforge.net>
parents: 230
diff changeset
   424
  (see: **dovecot --version**).
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   425
264
04fea4d8b900 Use the complete Dovecot version, not only the concatenated major
Pascal Volk <neverseen@users.sourceforge.net>
parents: 230
diff changeset
   426
  When, for example, the command **dovecot --version** prints
04fea4d8b900 Use the complete Dovecot version, not only the concatenated major
Pascal Volk <neverseen@users.sourceforge.net>
parents: 230
diff changeset
   427
  *2.0.beta4 (8818db00d347)*, set the value of this option to **2.0.beta4**.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   428
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   429
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   430
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   431
  [misc]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   432
  base_directory = /srv/mail
284
ec1966828246 VMM/password: Added support Blowfish/SHA-256/SHA-512 crypt().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 270
diff changeset
   433
  crypt_sha512_rounds = 10000
291
7ef3f117a230 VMM/password: adapted Blowfish/SHA-256/SHA-512 crypt() to recent
Pascal Volk <neverseen@users.sourceforge.net>
parents: 288
diff changeset
   434
  password_scheme = SHA512-CRYPT
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   435
  transport = dovecot:
264
04fea4d8b900 Use the complete Dovecot version, not only the concatenated major
Pascal Volk <neverseen@users.sourceforge.net>
parents: 230
diff changeset
   436
  dovecot_version = 2.0.beta4
384
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   437
  quota_bytes = 100M
d3a97f7fb98a VMM/config: Added quota_bytes and quota_messages settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 357
diff changeset
   438
  quota_messages = 10000
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   439
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   440
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   441
FILES
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   442
=====
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   443
*/root/vmm.cfg*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   444
  | will be used when found.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   445
*/usr/local/etc/vmm.cfg*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   446
  | will be used when the above file doesn't exist.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   447
*/etc/vmm.cfg*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   448
  | will be used when none of the both above mentioned files exists.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   449
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   450
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   451
SEE ALSO
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   452
========
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   453
|vmm(1)|_
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   454
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   455
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   456
COPYING
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   457
=======
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   458
vmm and its manual pages were written by Pascal Volk and are licensed under
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   459
the terms of the BSD License.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   460
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   461
.. include:: ../substitute_links.rst
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   462
.. include:: ../substitute_links_5.rst