vmm configuration file

vmm reads configuration data from vmm.cfg. (vmm.cfg)

The configuration file is split in multiple sections. A section starts with the section name, enclosed in square brackets '[' and ']' (e.g. [database]), followed by 'option=value' pairs (e.g. host = 127.0.0.1).

Whitespace around the '=' and at the end of a value is ignored.

Empty lines and lines starting with '#' or ';' will be ignored.

Each value uses one of the following data types:

• Boolean, to indicate if something is enabled/activated (true) or disabled/deactivated (false).
  Accepted values for true are: 1, yes, true and on.
  Accepted values for false are: 0, no, false and off.

• Int, an integer number, written without a fractional or decimal component.
  For example 1, 50 or 321 are integers.

• String, a sequence of characters and numbers. For example 'word', 'hello world' or '/usr/bin/strings' are strings.

Search order

By default vmm looks for vmm.cfg in the following directories in the order listed:

• /root
  /usr/local/etc
  /etc
  

The first match it finds will be used.

• Until vmm-0.5 (revision 105) the configuration directory is hard coded. Hence, vmm looks only for /usr/local/etc/vmm.cfg.

database section

The database section is used to specify some options required to connect to the database.

host

(String) Hostname or IP address of the database server

user

(String) Name of the database user

pass

(String) Database password

name

(String) Name of the database

Example:

[database]
host = localhost
user = vmm
pass = T~_:L4OYyl]TU?)
name = mailsys

maildir section

The maildir section is used to specify some options for the Maildirs.

name

(String) Default name of the Maildir folder in users home directory

folders

(String) A colon separated list of folder names, that should be created
If no folders should be created inside the Maildir, set the value of this option to a single colon (':')

mode

(Int) Access mode for the Maildir in decimal (base 10) notation
For example: 'drwx------' → octal 0700 → decimal 448

diskusage

(Boolean) Decides if the disk usage of users Maildir always should be summarized and displayed with account information

delete

(Boolean) Decides if the Maildir should be deleted recursive when the account is deleted

Example:

[maildir]
name = Maildir
folders = Drafts:Sent:Templates:Trash:INBOX.News
mode = 448
diskusage = false
delete = false

services section

The services section is used to specify the default restrictions for all accounts.

smtp

(Boolean) Decides if users can login via smtp by default

pop3

(Boolean) Decides if users can login via pop3 by default

imap

(Boolean) Decides if users can login via imap by default

sieve

(Boolean) Decides if users can login via managesieve by default

Example:

[services]
smtp = true
pop3 = false
imap = true
sieve = true

domdir section

The domdir section is used to specify options for the directories of the domains.

base

(String) All domain directories will be created inside this directory

mode

(Int) Access mode for the domain directory in decimal (base 10) notation
For example: 'drwxrwx---' → octal 0770 → decimal 504

delete

(Boolean) Decides if the domain directory and all user directories inside should be deleted when a domain is deleted

Example:

[domdir]
base = /srv/mail
mode = 504
delete = false

bin section

The bin section is used to specify some paths to some binaries required by vmm.

dovecotpw

(String) The absolute path to the dovecotpw binary
This binary is used to generate a password hash, if the passwdscheme is one of 'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.

du

(String) The absolute path to du This binary is used to summarize the disk usage of a Maildir

postconf

(String) The absolute path to Postfix' postconf(1)
This binary is required if vmm has to check for some Postfix settings, e.g. virtual_alias_expansion_limit.

Example:

[bin]
dovecotpw = /usr/sbin/dovecotpw
du = /usr/bin/du
postconf = /usr/sbin/postconf

misc section

The misc section is used to define miscellaneous settings.

passwdscheme

(String) Password scheme used to store passwords
For possible values see: dovecotpw -l

gid_mail

(Int) Numeric group ID of group mail (mail_privileged_group from dovecot.conf)

forcedel

(Boolean) Force deletion of accounts and aliases when a domain is deleted

transport

(String) Default transport for domains and accounts

dovecotvers

(Int) The concatenated major and minor version number of the currently used Dovecot version. (see: dovecot --version).
This option affects various database operations. There are some differences between Dovecot v1.0.x/v1.1.x and v1.2.x. For example, when the command dovecot --version shows 1.1.18, set the value of this option to 11.

Example:

[misc]
passwdscheme = CRAM-MD5
gid_mail = 8
forcedel = false
transport = dovecot:
dovecotvers = 11

config section

The config section is a internal used control section.

done

(Boolean) This option is set to false when vmm is installed for the first time. When you edit vmm.cfg, set this option to true
This option is also set to true when you configure vmm with the command vmm configure. If this option is set to false, vmm will start in the interactive configuration mode.

Example:

[config]
done = true