.TH"VMM.CFG""5""2011-11-12""vmm 0.6""vmm".SHNAMEvmm.cfg \- configuration file for vmm.\" -----------------------------------------------------------------------.SHSYNOPSISvmm.cfg.\" -----------------------------------------------------------------------.SHDESCRIPTION.BRvmm(1)reads its configuration data from.IRvmm.cfg..PPThe configuration file is split into multiple sections.A section starts with the section name, enclosed in square brackets.RB`["' and `"]',followed by.RI`option" = "value'pairs..brWhitespace around the `=' and at the end of a value is ignored.Empty lines and lines starting with `#' or `;' will be ignored..PPEach value uses one of the following data types:.TP8.IBooleanto indicate if something is enabled/activated (true) ordisabled/deactivated (false)..brAccepted values for.Itrueare:.BR1," yes"," true"" and "on..brAccepted values for.Ifalseare:.BR0," no"," false"" and "off..TP.IIntan integer number, written without a fractional or decimal component..brFor example.BR1," 50"" or "321are integers..TP.IStringa sequence of characters and/or numbers..brFor example.RB`word"', `""hello world""' or `"/usr/bin/strings'are strings..PPMost options have a default value, shown in parentheses after the option'sname.In order to use a option's default setting, comment out the line, eitherwith a.BR#" or ";or simply remove the setting from.IRvmm.cfg..PPA minimal.Ivmm.cfgwould be:.PP.nf[database]user = mepass = xxxxxxxx[misc]dovecot_version = 1.2.16.fi.\" -----------------------------------------------------------------------.SHSEARCHORDERBy default.BRvmm(1)looks for the.Ivmm.cfgfile in the following directories in the order listed:.RS.PD0.TP.I/root.TP.I/usr/local/etc.TP.I/etc.PD.RE.PPThe first configuration file found will be used..\" -----------------------------------------------------------------------.SHSECTIONACCOUNTThe options in the section.Baccountare used to specify user account related settings..SSaccount.delete_directory.BRdelete_directory" (default: false) :".IBoolean.PPDetermines the behavior of.BRvmm(1)when an account is deleted (userdelete).If this option is set to.Itruethe user's home directory will be deleted recursively..\" ------------------------------------.SSaccount.directory_mode.BRdirectory_mode" (default: 448) :".IInt.PPAccess mode for a user's home directory and all directories inside.The value has to be specified in decimal (base 10) notation..brFor example: `drwx\-\-\-\-\-\-' \(-> octal 0700 \(-> decimal 448.\" ------------------------------------.SSaccount.disk_usage.BRdisk_usage" (default: false) :".IBoolean.PPDetermines whether the disk usage of a user's mail directory always shouldbe summarized, using.BRdu(1),and displayed with the account information (userinfo)..PPThis could be slow on large Maildirs.When you have enabled quotas,.BRvmm'suserinfo subcommand will also display the current quota usage of theaccount.You may also use userinfo's optional details\-argument.BRdu" or "full,in order to display the current disk usage of an account's mail directory..\" ------------------------------------.SSaccount.password_length.BRpassword_length" (default: 8) :".IInt.PPDetermines how many characters and/or numbers should be used for randomlygenerated passwords.Any value less than 8 will be increased to 8..\" ------------------------------------.SSaccount.random_password.BRrandom_password" (default: false) :".IBoolean.PPDetermines whether.BRvmm(1)should generate a random password when no password was given for theuseradd subcommand.If this option is set to.Ifalse.Bvmmwill prompt you to enter a password for the new account..PPYou can specify the password length of generated passwords with the.Iaccount.password_lengthoption..\" -----------------------------------------------------------------------.SHSECTIONBINThe.Bbinsection is used to specify some paths to some binaries required by.BRvmm(1)..SSbin.dovecotpw.BRdovecotpw" (default: /usr/sbin/dovecotpw) :".IString.PPThe absolute path to the.BRdovecotpw(1)binary.Use the absolute path to the.BRdoveadm(1)binary, if you are using Dovecot v2.0..PPThis binary is used to generate a password hash, if.Imisc.password_schemeis set to one of `CRAM\-MD5', `HMAC\-MD5', `LANMAN', `OTP', `RPA' or`SKEY'.This binary will be also required if your Python installation doesn'tsupport the:.IP\(bu4md4 hash algorithm (hashlib + OpenSSL or PyCrypto) used for the passwordschemes: `PLAIN\-MD4' and `NTLM'.IP\(busha256 hash algorithm (hashlib or PyCrypto \(>= 2.1.0alpha1) used for thepassword schemes: `SHA256' and `SSHA256'.IP\(busha512 hash algorithm (hashlib) used for the password schemes: `SHA512' and`SSHA512'.PPThe.BRdoveadm(1)binary is also used to create a user's INBOX and additional mailboxes.RI(mailbox.folders),when the.Imailbox.formatis set to.BRmdbox" or "sdbox..\" ------------------------------------.SSbin.du.BRdu" (default: /usr/bin/du) :".IString.PPThe absolute path to.BRdu(1).This binary is used to summarize the disk usage of a user's mail directory..\" ------------------------------------.SSbin.postconf.BRpostconf" (default: /usr/sbin/postconf) :".IString.PPThe absolute path to Postfix'.BRpostconf(1).This binary is required when.BRvmm(1)has to check for some Postfix settings, e.g. the.IRvirtual_alias_expansion_limit..\" -----------------------------------------------------------------------.SHSECTIONDATABASEThe.Bdatabasesection is used to specify some options required to connect to thedatabase..SSdatabase.host.BRhost" (default: localhost) :".IString.PPHostname or IP address of the database server..\" ------------------------------------.SSdatabase.module.BRmodule" (default: psycopg2) :".IString.PPThe Python PostgreSQL database adapter module to be used.Supported modules are.BRpsycopg2" and "pyPgSQL..\" ------------------------------------.SSdatabase.name.BRname" (default: mailsys) :".IString.PPName of the database..\" ------------------------------------.SSdatabase.pass.BRpass" (default: "None") :".IString.PPDatabase password..\" ------------------------------------.SSdatabase.port.BRport" (default: 5432) :".IInt.PPThe TCP port, on which the database server is listening for connections..\" ------------------------------------.SSdatabase.sslmode.BRsslmode" (default: prefer) :".IString.PPDetermines whether and with what priority an SSL connection will benegotiated with the database server.Possible values are:.BRdisabled", "allow", "prefer", "require", "verify\-ca" and ".BRverify\-full.The modes.BRverify\-ca" and "verify\-fullare available since PostgreSQL 8.4.PPThis setting will be ignored when the.Idatabase.moduleis set to.BRpyPgSQL..\" ------------------------------------.SSdatabase.user.BRuser" (default: "None") :".IString.PPName of the database user..\" -----------------------------------------------------------------------.SHSECTIONDOMAINThe.Bdomainsection specifies some domain related settings..PPThe quota limit (quota_bytes and quota_messages), service settings (imap,pop3, sieve and smtp) and the transport setting will be applied when adomain is created.In order to modify those settings for an existing domain, use one ofthe following.BRvmm(1)subcommands:.PP.TP.Bdomainquotain order to update a domain's quota limit.TP.Bdomainservicesin order to assign a different service set to a domain.TP.Bdomaintransportin order to set a new default domain transport.PPWhen an account is created, it inherits all the settings of the domainto which it is added.Different settings for an existing account can be set using the subcommands.BRuserquota", "userservices" and "usertransport..\" ------------------------------------.SSdomain.auto_postmaster.BRauto_postmaster" (default: true) :".IBoolean.PPDetermines if.BRvmm(1)should create also a postmaster account when a new domain is created(domainadd)..\" ------------------------------------.SSdomain.delete_directory.BRdelete_directory" (default: false) :".IBoolean.PPSpecifies whether the domain directory and all user directories insideshould be deleted when a domain is deleted (domaindelete)..\" ------------------------------------.SSdomain.directory_mode.BRdirectory_mode" (default: 504) :".IInt.PPAccess mode for the domain directory in decimal (base 10) notation..brFor example: `drwxrwx\-\-\-' \(-> octal 0770 \(-> decimal 504.\" ------------------------------------.SSdomain.force_deletion.BRforce_deletion" (default: false) :".IBoolean.PPForce the deletion of accounts and aliases when a domain is deleted(domaindelete)..\" ------------------------------------.SSdomain.imap.BRimap" (default: true) :".IBoolean.PPDetermines whether newly created users can log in via IMAP..\" ------------------------------------.SSdomain.pop3.BRpop3" (default: true) :".IBoolean.PPDetermines whether newly created users can log in via POP3..\" ------------------------------------.SSdomain.quota_bytes.BRquota_bytes" (default: 0) :".IString.PPQuota limit in bytes.0 means unlimited.This limit will be applied to all newly created domains..PPThe option's value can be written as an integer value, e.g.:.BR20480.It's also possible to append one of the following prefixes to the limit:.BRb" (bytes), "k" (kilobytes), "M" (megabytes) or "G(gigabytes)..br1024 is the same as 1024b or 1k..\" ------------------------------------.SSdomain.quota_messages.BRquota_messages" (default: 0) :".IInt.PPQuota limit in number of messages.0 means unlimited.This limit will be applied to all newly created domains..\" ------------------------------------.SSdomain.sieve.BRsieve" (default: true) :".IBoolean.PPDetermines whether newly created users can log in via SIEVE (ManageSieve)..\" ------------------------------------.SSdomain.smtp.BRsmtp" (default: true) :".IBoolean.PPDetermines whether newly created users can log in via SMTP (SMTP AUTH)..\" ------------------------------------.SSdomain.transport.BRtransport" (default: dovecot:) :".IString.PPDefault transport for domains and accounts.For details see.BRtransport(5)..\" -----------------------------------------------------------------------.SHSECTIONMAILBOXThe.Bmailboxsection is used to specify some options for new created mailboxes in theusers home directories.The INBOX will be created always..SSmailbox.folders.BRfolders" (default: Drafts:Sent:Templates:Trash) :".IString.PPA colon separated list of mailboxes that should be created.If no additionally mailboxes should be created, set the value of thisoption to a single colon.RB(`:')..PPIf you want to create folders containing one or more subfolders, separatethem with a single dot.RB(`.')..PPIf you want to use internationalized mailbox names (e.g. `Wysłane' or`Gelöschte Objekte'), write their names UTF\-8 encoded..BRvmm(1)will convert internationalized mailbox names to a modified version of theUTF\-7 encoding (see also: RFC 3501, section 5.1.3)..\" ------------------------------------.SSmailbox.format.BRformat" (default: maildir) :".IString.PPThe mailbox format to be used for a user's mailbox.Depending on the used Dovecot version.RI(misc.dovecot_version).BRvmm(1)supports up to three formats:.TP8.BmaildirDovecot \(>= v1.0.0.TP.BmdboxDovecot \(>= v2.0.beta5.TP.BsdboxDovecot \(>= v2.0.rc3.\" ------------------------------------.SSmailbox.root.BRroot" (default: Maildir) :".IString.PPName of the mailbox root directory in a user's home directory.Commonly used names, depending on the used.IRmailbox.format,are.BRMaildir", "mdbox" or "sdbox..\" ------------------------------------.SSmailbox.subscribe.BRsubscribe" (default: true) :".IBoolean.PPWhen this option is set to.BRtrue,the mailboxes from the.Imailbox.foldersoption will be listed in the user's subscriptions file.If you don't want to subscribe the created mailboxes, set this option to.BRfalse..\" -----------------------------------------------------------------------.SHSECTIONMISCThe.Imiscsection is used to define miscellaneous settings..SSmisc.base_directory.BRbase_directory" (default: /srv/mail) :".IString.PPAll domain directories will be created inside this directory..\" ------------------------------------.SSmisc.crypt_blowfish_rounds.BRcrypt_blowfish_rounds" (default: 5) :".IInt.PPNumber of encryption rounds for the.Ipassword_scheme.BRBLF\-CRYPT..PPThe value must be in range.BR4" \- "31..\" ------------------------------------.SSmisc.crypt_sha256_rounds.BRcrypt_sha256_rounds" (default: 5000) :".IInt.PPNumber of encryption rounds for the.Ipassword_scheme.BRSHA256\-CRYPT..PPThe value must be in range.BR1000" \- "999999999..\" ------------------------------------.SSmisc.crypt_sha512_rounds.BRcrypt_sha512_rounds" (default: 5000) :".IInt.PPNumber of encryption rounds for the.Ipassword_scheme.BRSHA512\-CRYPT..PPThe value must be in range.BR1000" \- "999999999..\" ------------------------------------.SSmisc.dovecot_version.BRdovecot_version" (default: "None") :".IString.PPThe version number of the currently used Dovecot version.(see:.BR"dovecot \-\-version").brWhen, for example, the command.Bdovecot\-\-versionprints.IR"2.0.beta4 (8818db00d347)",set the value of this option to.BR2.0.beta4..\" ------------------------------------.SSmisc.password_scheme.BRpassword_scheme" (default: CRAM\-MD5) :".IString.PPPassword scheme to use.To get a list of all usable password schemes execute the command.BR"vmm lp"..PPWith Dovecot \(>= v1.1.alpha1 it is also possible to append an encodingsuffix to the password_scheme.Supported encoding suffixes are:.BR.b64", ".base64" and ".hex.For example: PLAIN.BASE64.\" -----------------------------------------------------------------------.SHEXAMPLEAn example configuration.All options that are not listed in the configuration file will have theirdefault values..PP.nf[account]password_length = 10random_password = true[bin]dovecotpw = /usr/bin/doveadm[database]host = dbsrv8.example.netpass = PY_SRJ}L/0p\-oOkport = 5433sslmode = requireuser = vmm[domain]quota_bytes = 500Mquota_messages = 10000transport = lmtp:unix:private/dovecot\-lmtp[mailbox]folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix[misc]crypt_sha512_rounds = 10000dovecot_version = 2.0.beta4password_scheme = SHA512\-CRYPT.hex.fi.\" -----------------------------------------------------------------------.SHSEEALSO.BRpostconf(1),.BRvmm(1),.BRtransport(5).\" -----------------------------------------------------------------------.SHINTERNETRESOURCES.TPWikihttp://vmm.localdomain.org/.TPProject sitehttp://sf.net/projects/vmm/.TPBug trackerhttps://bitbucket.org/pvo/vmm/issues.\" -----------------------------------------------------------------------.SHCOPYINGvmm and its manual pages were written by Pascal Volk <neverseen ATusers.sourceforge.net> and are licensed under the terms of the BSD License.