10 :Date:           2010-01-26

    10 :Date:           2010-01-30

    16     :backlinks: top

    16   :backlinks: top

    17     :class: htmlout

    17   :class: htmlout

    25 **vmm**\(1) reads its configuration data from *vmm.cfg*.

    26 |vmm(1)|_ reads its configuration data from *vmm.cfg*.

    57     [database]

    58   [database]

    58     user = me

    59   user = me

    59     pass = xxxxxxxx

    60   pass = xxxxxxxx

    60 

    61 

    61     [config]

    62   [config]

    62     done = true

    63   done = true

    64 

    66 By default **vmm**\(1) looks for *vmm.cfg* in the following directories in the

    68 By default |vmm(1)|_ looks for *vmm.cfg* in the following directories in the

    69      | */root*

    71   | */root*

    70      | */usr/local/etc*

    72   | */usr/local/etc*

    71      | */etc*

    73   | */etc*

    85     Determines the behavior of **vmm**\(1) when an account is deleted. If

    91   Determines the behavior of |vmm(1)|_ when an account is deleted

    86     this option is set to *true* the user's home directory will be deleted

    92   (|userdelete|_). If this option is set to *true* the user's home directory

    87     recursively.

    93   will be deleted  recursively.

    94 

    95 .. _account.directory_mode:

    90     Access mode for a user's home directory and all directories inside.

    98   Access mode for a user's home directory and all directories inside. The

    91     The value has to be specified in decimal (base 10) notation.

    99   value has to be specified in decimal (base 10) notation.

    92 

   100 

    93     | For example: 'drwx------' -> octal 0700 -> decimal 448

   101   | For example: 'drwx------' -> octal 0700 -> decimal 448

   102 

   103 .. _account.disk_usage:

    96     Determines whether the disk usage of a user's Maildir always should be

   106   Determines whether the disk usage of a user's Maildir always should be

    97     summarized, using **du**\(1), and displayed with account information.

   107   summarized, using **du**\(1), and displayed with account information.

    98 

   108 

    99     This could be slow on large Maildirs. When you have enabled quotas,

   109   This could be slow on large Maildirs. When you have enabled quotas,

   100     **vmm**'s **userinfo** subcomammand will also display the current quota

   110   **vmm**'s |userinfo|_ subcomammand will also display the current quota

   101     usage of the account. You may also use **userinfo**'s optional argument

   111   usage of the account. You may also use |userinfo|_'s optional argument

   102     **du** or **full**, in order to display the current disk usage of an

   112   **du** or **full**, in order to display the current disk usage of an

   103     account.

   113   account's Maildir.

   114 

   115 .. _account.imap:

   106     Determines whether a newly created user can log in via IMAP.

   118   Determines whether a newly created user can log in via IMAP.

   119 

   120 .. _account.password_length:

   109     Determines how many characters and/or numbers should be used for

   123   Determines how many characters and/or numbers should be used for randomly

   110     randomly generated passwords. Any value less than 8 will be

   124   generated passwords. Any value less than 8 will be increased to 8.

   111     increased to 8.

   125 

   126 .. _account.pop3:

   117     Determines whether **vmm** should generate a random password when no

   134   Determines whether **vmm** should generate a random password when no

   118     password was given for the **useradd** subcommand. If this option is

   135   password was given for the |useradd|_ subcommand. If this option is set to

   119     set to *false* **vmm** will prompt you to enter a password for the new

   136   *false* **vmm** will prompt you to enter a password for the new account.

   120     account.

   137 

   121 

   138   You can specify the password length of generated passwords with the

   122     You can specify the password length of generated passwords with the

   139   |account.password_length|_ option.

   123     **password_length** option.

   140 

   141 .. _account.sieve:

   126     Determines whether a newly created user can log in via ManageSieve.

   144   Determines whether a newly created user can log in via ManageSieve.

   145 

   146 .. _account.smtp:

   129      Determines whether a newly created user can log in via SMTP (SMTP AUTH).

   149   Determines whether a newly created user can log in via SMTP (SMTP AUTH).

   130 

   150 

   131 Example::

   151 Example::

   132 

   152 

   133     [account]

   153   [account]

   134     delete_directory = false

   154   delete_directory = false

   135     directory_mode = 448

   155   directory_mode = 448

   136     disk_usage = false

   156   disk_usage = false

   137     random_password = true

   157   random_password = true

   138     password_length = 10

   158   password_length = 10

   139     smtp = true

   159   smtp = true

   140     pop3 = true

   160   pop3 = true

   141     imap = true

   161   imap = true

   142     sieve = true

   162   sieve = true

   163 

   147 by **vmm**\(1).

   168 by |vmm(1)|_.

   169 

   170 .. _bin.dovecotpw:

   150     The absolute path to the dovecotpw binary. This binary is used to

   173   The absolute path to the dovecotpw binary. This binary is used to

   151     generate a password hash, if **misc.password_scheme** is set to one of

   174   generate a password hash, if |misc.password_scheme|_ is set to one of

   152     'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.

   175   'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.

   176 

   177 .. _bin.du:

   155     The absolute path to **du**\(1). This binary is used to summarize the

   180   The absolute path to **du**\(1). This binary is used to summarize the disk

   156     disk usage of a user's Maildir.

   181   usage of a user's Maildir.

   182 

   183 .. _bin.postconf:

   159     The absolute path to Postfix' **postconf**\(1). This binary is required

   186   The absolute path to Postfix' |postconf(1)|_. This binary is required when

   160     when **vmm**\(1) has to check for some Postfix settings, e.g.

   187   |vmm(1)|_ has to check for some Postfix settings, e.g.

   161     `virtual_alias_expansion_limit`.

   188   |virtual_alias_expansion_limit|_.

   162 

   189 

   163 Example::

   190 Example::

   164 

   191 

   165     [bin]

   192   [bin]

   166     dovecotpw = /usr/sbin/dovecotpw

   193   dovecotpw = /usr/sbin/dovecotpw

   167     du = /usr/bin/du

   194   du = /usr/bin/du

   168     postconf = /usr/sbin/postconf

   195   postconf = /usr/sbin/postconf

   196 

   175     This option is set to *false* when **vmm**\(1) is installed for the first

   205   This option is set to *false* when |vmm(1)|_ is installed for the first

   176     time. When you edit *vmm.cfg*, set this option to *true*. This option is

   206   time. When you edit *vmm.cfg*, set this option to *true*. This option is

   177     also set to *true* when you configure **vmm**\(1) with the command **vmm

   207   also set to *true* when you configure |vmm(1)|_ with the command |vmm

   178     configure**.

   208   configure|_.

   179 

   209 

   180     If this option is set to *false*, **vmm**\(1) will start in the

   210   If this option is set to *false*, |vmm(1)|_ will start in the interactive

   181     interactive configurations mode.

   211   configurations mode.

   182 

   212 

   183 Example::

   213 Example::

   184 

   214 

   185     [config]

   215   [config]

   186     done = true

   216   done = true

   217 

   194     Hostname or IP address of the database server.

   227   Hostname or IP address of the database server.

   228 

   229 .. _database.name:

   197     Name of the database.

   232   Name of the database.

   233 

   234 .. _database.pass:

   200     Database password.

   237   Database password.

   238 

   239 .. _database.user:

   203     Name of the database user.

   242   Name of the database user.

   204 

   243 

   205 Example::

   244 Example::

   206 

   245 

   207     [database]

   246   [database]

   208     host = localhost

   247   host = localhost

   209     user = vmm

   248   user = vmm

   210     pass = PY_SRJ}L/0p-oOk

   249   pass = PY_SRJ}L/0p-oOk

   211     name = mailsys

   250   name = mailsys

   251 

   218     Determines if **vmm**\(1) should create also a postmaster account when a

   260   Determines if |vmm(1)|_ should create also a postmaster account when a new

   219     new domain is created.

   261   domain is created (|domainadd|_).

   262 

   263 .. _domain.delete_directory:

   222     Specifies whether the domain directory and all user directories inside

   266   Specifies whether the domain directory and all user directories inside

   223     should be deleted when a domain is deleted.

   267   should be deleted when a domain is deleted (|domaindelete|_).

   268 

   269 .. _domain.directory_mode:

   226     Access mode for the domain directory in decimal (base 10) notation.

   272   Access mode for the domain directory in decimal (base 10) notation.

   227 

   273 

   228     | For example: 'drwxrwx---' -> octal 0770 -> decimal 504

   274   | For example: 'drwxrwx---' -> octal 0770 -> decimal 504

   275 

   276 .. _domain.force_deletion:

   231     Force deletion of accounts and aliases when a domain is deleted.

   279   Force deletion of accounts and aliases when a domain is deleted

   232 

   280   (|domaindelete|_).

   233 Example::

   281 

   234 

   282 Example::

   235     [domain]

   283 

   236     auto_postmaster = true

   284   [domain]

   237     delete_directory = false

   285   auto_postmaster = true

   238     directory_mode = 504

   286   delete_directory = false

   239     force_deletion = false

   287   directory_mode = 504

   288   force_deletion = false

   289 

   247     A colon separated list of folder names, that should be created. If no

   299   A colon separated list of folder names, that should be created. If no

   248     folders should be created inside the Maildir, set the value of this

   300   folders should be created inside the Maildir, set the value of this option

   249     option to a single colon ('**:**').

   301   to a single colon ('**:**').

   250 

   302 

   251     If you want to create folders containing one or more subfolders, separate

   303   If you want to create folders containing one or more subfolders, separate

   252     them with a single dot ('**.**').

   304   them with a single dot ('**.**').

   305 

   306 .. _maildir.name:

   255     Default name of the Maildir folder in users home directories.

   309   Default name of the Maildir folder in users home directories.

   256 

   310 

   257 Example::

   311 Example::

   258 

   312 

   259     [maildir]

   313   [maildir]

   260     folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix

   314   folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix

   261     name = Maildir

   315   name = Maildir

   316 

   317 .. _imap_uft7:

   318 

   319 .. note:: If you want to use internationalized mailbox names in the

   320   **folders** setting, you have to specify them in a modified version of the

   321   UTF-7 encoding (see :RFC:`3501`, section 5.1.3).

   322 

   323   Dovecot provides a useful utility for mUTF-7 <-> UTF-8 conversion:

   324   **imap-utf7**, it's available since Dovecot version 1.2.0.

   325 ..

   326 

   327 imap-utf7 example::

   328 

   329   user@host:~$ /usr/local/libexec/dovecot/imap-utf7 -r Wysłane

   330   Wys&AUI-ane

   331   user@host:~$ /usr/local/libexec/dovecot/imap-utf7 "&AVo-mietnik"

   332   Śmietnik

   333 

   268     All domain directories will be created inside this directory.

   342   All domain directories will be created inside this directory.

   343 

   344 .. _misc.password_scheme:

   271     Password scheme to use (see also: **dovecotpw -l**).

   347   Password scheme to use (see also: **dovecotpw -l**).

   348 

   349 .. _misc.gid_mail:

   274     Numeric group ID of group mail (`mail_privileged_group` from

   352   Numeric group ID of group mail (`mail_privileged_group` from

   275     *dovecot.conf*)

   353   *dovecot.conf*)

   354 

   355 .. _misc.transport:

   278     Default transport for domains and accounts. For details see

   358   Default transport for domains and accounts. For details see

   279     **transport**\(5).

   359   |transport(5)|_.

   360 

   361 .. _misc.dovecot_version:

   282     The concatenated major and minor version number of the currently used

   364   The concatenated major and minor version number of the currently used

   283     Dovecot version. (see: **dovecot --version**).

   365   Dovecot version. (see: **dovecot --version**).

   284 

   366 

   285     When, for example, the command **dovecot --version** prints *1.1.18*, set

   367   When, for example, the command **dovecot --version** prints *1.1.18*, set

   286     the value of this option to **11**.

   368   the value of this option to **11**.

   287 

   369 

   288 Example::

   370 Example::

   289 

   371 

   290     [misc]

   372   [misc]

   291     base_directory = /srv/mail

   373   base_directory = /srv/mail

   292     password_scheme = PLAIN

   374   password_scheme = PLAIN

   293     gid_mail = 8

   375   gid_mail = 8

   294     transport = dovecot:

   376   transport = dovecot:

   295     dovecot_version = 11

   377   dovecot_version = 11

   378 

   300     | will be used when found.

   383   | will be used when found.

   302     | will be used when the above file doesn't exist.

   385   | will be used when the above file doesn't exist.

   304     | will be used when none of the both above mentioned files exists.

   387   | will be used when none of the both above mentioned files exists.

   388 

   308 vmm(1), command line tool to manage email domains/accounts/aliases

   392 |vmm(1)|_

   393