man/man5/vmm.cfg.5
branchv0.6.x
changeset 460 e57dd007d69a
parent 416 f32b323fd347
child 476 c30ce0e079b6
equal deleted inserted replaced
459:033a0436894f 460:e57dd007d69a
     1 .TH "VMM.CFG" "5" "2011-02-24" "vmm 0.6" "vmm"
     1 .TH "VMM.CFG" "5" "2011-11-06" "vmm 0.6" "vmm"
     2 .SH NAME
     2 .SH NAME
     3 vmm.cfg \- configuration file for vmm
     3 vmm.cfg \- configuration file for vmm
     4 .\" -----------------------------------------------------------------------
     4 .\" -----------------------------------------------------------------------
     5 .SH SYNOPSIS
     5 .SH SYNOPSIS
     6 vmm.cfg
     6 vmm.cfg
   133 account.
   133 account.
   134 You may also use userinfo's optional details\-argument
   134 You may also use userinfo's optional details\-argument
   135 .BR du " or " full ,
   135 .BR du " or " full ,
   136 in order to display the current disk usage of an account's mail directory.
   136 in order to display the current disk usage of an account's mail directory.
   137 .\" ------------------------------------
   137 .\" ------------------------------------
   138 .SS account.imap
       
   139 .BR imap " (default: true) :"
       
   140 .I Boolean
       
   141 .PP
       
   142 Determines whether a newly created user can log in via IMAP.
       
   143 .\" ------------------------------------
       
   144 .SS account.password_length
   138 .SS account.password_length
   145 .BR password_length " (default: 8) :"
   139 .BR password_length " (default: 8) :"
   146 .I Int
   140 .I Int
   147 .PP
   141 .PP
   148 Determines how many characters and/or numbers should be used for randomly
   142 Determines how many characters and/or numbers should be used for randomly
   149 generated passwords.
   143 generated passwords.
   150 Any value less than 8 will be increased to 8.
   144 Any value less than 8 will be increased to 8.
   151 .\" ------------------------------------
       
   152 .SS account.pop3
       
   153 .BR pop3 " (default: true) :"
       
   154 .I Boolean
       
   155 .PP
       
   156 Determines whether a newly created user can log in via POP3.
       
   157 .\" ------------------------------------
   145 .\" ------------------------------------
   158 .SS account.random_password
   146 .SS account.random_password
   159 .BR random_password " (default: false) :"
   147 .BR random_password " (default: false) :"
   160 .I Boolean
   148 .I Boolean
   161 .PP
   149 .PP
   169 will prompt you to enter a password for the new account.
   157 will prompt you to enter a password for the new account.
   170 .PP
   158 .PP
   171 You can specify the password length of generated passwords with the
   159 You can specify the password length of generated passwords with the
   172 .I account.password_length
   160 .I account.password_length
   173 option.
   161 option.
   174 .\" ------------------------------------
       
   175 .SS account.sieve
       
   176 .BR sieve " (default: true) :"
       
   177 .I Boolean
       
   178 .PP
       
   179 Determines whether a newly created user can log in via ManageSieve.
       
   180 .\" ------------------------------------
       
   181 .SS account.smtp
       
   182 .BR smtp " (default: true) :"
       
   183 .I Boolean
       
   184 .PP
       
   185 Determines whether a newly created user can log in via SMTP (SMTP AUTH).
       
   186 .\" -----------------------------------------------------------------------
   162 .\" -----------------------------------------------------------------------
   187 .SH SECTION BIN
   163 .SH SECTION BIN
   188 The
   164 The
   189 .B bin
   165 .B bin
   190 section is used to specify some paths to some binaries required by
   166 section is used to specify some paths to some binaries required by
   307 .\" -----------------------------------------------------------------------
   283 .\" -----------------------------------------------------------------------
   308 .SH SECTION DOMAIN
   284 .SH SECTION DOMAIN
   309 The
   285 The
   310 .B domain
   286 .B domain
   311 section specifies some domain related settings.
   287 section specifies some domain related settings.
       
   288 .PP
       
   289 The quota limit (quota_bytes and quota_messages), service settings (imap,
       
   290 pop3, sieve and smtp) and the transport setting will be applied when a
       
   291 domain is created.
       
   292 In order to modify those settings for an existing domain, use one of
       
   293 the following
       
   294 .BR vmm (1)
       
   295 subcommands:
       
   296 .PP
       
   297 .TP
       
   298 .B domainquota
       
   299 in order to update a domain's quota limit
       
   300 .TP
       
   301 .B domainservices
       
   302 in order to assign a different service set to a domain
       
   303 .TP
       
   304 .B domaintransport
       
   305 in order to set a new default domain transport
       
   306 .PP
       
   307 When an account is created, it inherits all the settings of the domain
       
   308 to which it is added.
       
   309 Different settings for an existing account can be set using the subcommands
       
   310 .BR userquota ", " userservices " and " usertransport .
       
   311 .\" ------------------------------------
   312 .SS domain.auto_postmaster
   312 .SS domain.auto_postmaster
   313 .BR auto_postmaster " (default: true) :"
   313 .BR auto_postmaster " (default: true) :"
   314 .I Boolean
   314 .I Boolean
   315 .PP
   315 .PP
   316 Determines if
   316 Determines if
   337 .BR force_deletion " (default: false) :"
   337 .BR force_deletion " (default: false) :"
   338 .I Boolean
   338 .I Boolean
   339 .PP
   339 .PP
   340 Force the deletion of accounts and aliases when a domain is deleted
   340 Force the deletion of accounts and aliases when a domain is deleted
   341 (domaindelete).
   341 (domaindelete).
       
   342 .\" ------------------------------------
       
   343 .SS domain.imap
       
   344 .BR imap " (default: true) :"
       
   345 .I Boolean
       
   346 .PP
       
   347 Determines whether newly created users can log in via IMAP.
       
   348 .\" ------------------------------------
       
   349 .SS domain.pop3
       
   350 .BR pop3 " (default: true) :"
       
   351 .I Boolean
       
   352 .PP
       
   353 Determines whether newly created users can log in via POP3.
       
   354 .\" ------------------------------------
       
   355 .SS domain.quota_bytes
       
   356 .BR quota_bytes " (default: 0) :"
       
   357 .I String
       
   358 .PP
       
   359 Quota limit in bytes.
       
   360 0 means unlimited.
       
   361 This limit will be applied to all newly created domains.
       
   362 .PP
       
   363 The option's value can be written as an integer value, e.g.:
       
   364 .BR 20480 .
       
   365 It's also possible to append one of the following prefixes to the limit:
       
   366 .BR b " (bytes), " k " (kilobytes), " M " (megabytes) or " G
       
   367 (gigabytes).
       
   368 .br
       
   369 1024 is the same as 1024b or 1k.
       
   370 .\" ------------------------------------
       
   371 .SS domain.quota_messages
       
   372 .BR quota_messages " (default: 0) :"
       
   373 .I Int
       
   374 .PP
       
   375 Quota limit in number of messages.
       
   376 0 means unlimited.
       
   377 This limit will be applied to all newly created domains.
       
   378 .\" ------------------------------------
       
   379 .SS domain.sieve
       
   380 .BR sieve " (default: true) :"
       
   381 .I Boolean
       
   382 .PP
       
   383 Determines whether newly created users can log in via SIEVE (ManageSieve).
       
   384 .\" ------------------------------------
       
   385 .SS domain.smtp
       
   386 .BR smtp " (default: true) :"
       
   387 .I Boolean
       
   388 .PP
       
   389 Determines whether newly created users can log in via SMTP (SMTP AUTH).
       
   390 .\" ------------------------------------
       
   391 .SS domain.transport
       
   392 .BR transport " (default: dovecot:) :"
       
   393 .I String
       
   394 .PP
       
   395 Default transport for domains and accounts.
       
   396 For details see
       
   397 .BR transport (5).
   342 .\" -----------------------------------------------------------------------
   398 .\" -----------------------------------------------------------------------
   343 .SH SECTION MAILBOX
   399 .SH SECTION MAILBOX
   344 The
   400 The
   345 .B mailbox
   401 .B mailbox
   346 section is used to specify some options for new created mailboxes in the
   402 section is used to specify some options for new created mailboxes in the
   478 With Dovecot \(>= v1.1.alpha1 it is also possible to append an encoding
   534 With Dovecot \(>= v1.1.alpha1 it is also possible to append an encoding
   479 suffix to the password_scheme.
   535 suffix to the password_scheme.
   480 Supported encoding suffixes are:
   536 Supported encoding suffixes are:
   481 .BR .b64 ", " .base64 " and " .hex .
   537 .BR .b64 ", " .base64 " and " .hex .
   482 For example: PLAIN.BASE64
   538 For example: PLAIN.BASE64
   483 .\" ------------------------------------
       
   484 .SS misc.quota_bytes
       
   485 .BR quota_bytes " (default: 0) :"
       
   486 .I String
       
   487 .PP
       
   488 Quota limit in bytes.
       
   489 0 means unlimited.
       
   490 This limit will be applied to all newly created domains.
       
   491 .PP
       
   492 The option's value can be written as an integer value, e.g.:
       
   493 .BR 20480 .
       
   494 It's also possible to append one of the following prefixes to the limit:
       
   495 .BR b " (bytes), " k " (kilobytes), " M " (megabytes) or " G
       
   496 (gigabytes).
       
   497 .br
       
   498 1024 is the same as 1024b or 1k.
       
   499 .\" ------------------------------------
       
   500 .SS misc.quota_messages
       
   501 .BR quota_messages " (default: 0) :"
       
   502 .I Int
       
   503 .PP
       
   504 Quota limit in number of messages.
       
   505 0 means unlimited.
       
   506 This limit will be
       
   507 applied to all newly created domains.
       
   508 .\" ------------------------------------
       
   509 .SS misc.transport
       
   510 .BR transport " (default: dovecot:) :"
       
   511 .I String
       
   512 .PP
       
   513 Default transport for domains and accounts.
       
   514 For details see
       
   515 .BR transport (5).
       
   516 .\" -----------------------------------------------------------------------
   539 .\" -----------------------------------------------------------------------
   517 .SH EXAMPLE
   540 .SH EXAMPLE
   518 An example configuration.
   541 An example configuration.
   519 All options that are not listed in the configuration file will have their
   542 All options that are not listed in the configuration file will have their
   520 default values.
   543 default values.
   532 pass = PY_SRJ}L/0p\-oOk
   555 pass = PY_SRJ}L/0p\-oOk
   533 port = 5433
   556 port = 5433
   534 sslmode = require
   557 sslmode = require
   535 user = vmm
   558 user = vmm
   536 
   559 
       
   560 [domain]
       
   561 quota_bytes = 500M
       
   562 quota_messages = 10000
       
   563 transport = lmtp:unix:private/dovecot\-lmtp
       
   564 
   537 [mailbox]
   565 [mailbox]
   538 folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
   566 folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
   539 
   567 
   540 [misc]
   568 [misc]
   541 crypt_sha512_rounds = 10000
   569 crypt_sha512_rounds = 10000
   542 dovecot_version = 2.0.beta4
   570 dovecot_version = 2.0.beta4
   543 password_scheme = SHA512\-CRYPT.hex
   571 password_scheme = SHA512\-CRYPT.hex
   544 quota_bytes = 500M
       
   545 quota_messages = 10000
       
   546 transport = lmtp:unix:private/dovecot\-lmtp
       
   547 .fi
   572 .fi
   548 .\" -----------------------------------------------------------------------
   573 .\" -----------------------------------------------------------------------
   549 .SH SEE ALSO
   574 .SH SEE ALSO
   550 .BR doveadm\-pw (1),
   575 .BR doveadm\-pw (1),
   551 .BR dovecotpw (1),
   576 .BR dovecotpw (1),