1 .TH vmm.cfg 5 "17 Aug 2009" "Pascal Volk"

     1 .\" Man page generated from reStructeredText.

     2 .

     3 .TH VMM.CFG 5 "2010-01-18" "vmm-0.6.0" "vmm Manual"

     7 \fBvmm\fR(1) reads configuration data from \fIvmm.cfg\fP.

    40 .sp

     8 .br

    41 \fBvmm\fP(1) reads its configuration data from \fIvmm.cfg\fP.

     9 The configuration file is split in multiple sections. A section starts with the

    42 .sp

    10 section  name, enclosed in square brackets '[' and ']' (e.g. \fB[database]\fP),

    43 The configuration file is split into multiple sections. A section starts with

    11 followed by \'option=value' pairs (e.g. \fBhost = 127.0.0.1\fP).

    44 the section name, enclosed in square brackets \(aq\fB[\fP\(aq and \(aq\fB]\fP\(aq, followed

    12 .br

    45 by \(aq\fIoption\fP = \fIvalue\fP\(aq pairs:

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

    46 .sp

    14 .PP

    47 .nf

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

    48 .ft C

    16 .PP

    49 [database]

    50 host = 127.0.0.1

    51 .ft P

    52 .fi

    53 .sp

    54 Whitespace around the \(aq=\(aq and at the end of a value is ignored.

    55 .sp

    56 Empty lines and lines starting with \(aq#\(aq or \(aq;\(aq will be ignored.

    57 .sp

    18 .IP \(bu

    59 .INDENT 0.0

    19 .I Boolean

    60 .IP \(bu 2

    20 to indicate if something is enabled/activated (true) or disabled/deactivated

    61 .

    21 (false).

    62 \fIBoolean\fP to indicate if something is enabled/activated (true) or

    22 .br

    63 disabled/deactivated (false).

    23 Accepted values for \fBtrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and \fBon\fP.

    64 .nf

    24 .br

    65 Accepted values for \fItrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and \fBon\fP.

    25 Accepted values for \fBfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and

    66 Accepted values for \fIfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and \fBoff\fP.

    26 \fBoff\fP.

    67 .fi

    27 .IP \(bu

    68 .sp

    28 .I Int

    69 .IP \(bu 2

    29 an integer number, written without a fractional or decimal component. For

    70 .

    30 example \fB1\fP, \fB50\fP or \fB321\fP are integers.

    71 \fIInt\fP an integer number, written without a fractional or decimal component.

    31 .IP \(bu

    72 .nf

    32 .I String

    73 For example \fB1\fP, \fB50\fP or \fB321\fP are integers.

    33 a sequence of characters and numbers. For example '\fBword\fP', '\fBhello

    74 .fi

    34 world\fP' or '\fB/usr/bin/strings\fP'

    75 .sp

    76 .IP \(bu 2

    77 .

    78 \fIString\fP a sequence of characters and numbers.

    79 .nf

    80 For example \(aq\fBword\fP\(aq, \(aq\fBhello world\fP\(aq or \(aq\fB/usr/bin/strings\fP\(aq

    81 .fi

    82 .sp

    83 .UNINDENT

    36 By default vmm looks for \fIvmm.cfg\fP in the following directories in the

    85 .sp

    86 By default \fBvmm\fP(1) looks for \fIvmm.cfg\fP in the following directories in the

    38 .RS

    88 .INDENT 0.0

    39 .PD 0

    89 .INDENT 3.5

    40 .TP

    90 .nf

    41 .I

    91 \fI/root\fP

    42 /root

    92 \fI/usr/local/etc\fP

    43 .TP

    93 \fI/etc\fP

    44 .I

    94 .fi

    45 /usr/local/etc

    95 .sp

    46 .TP

    96 .UNINDENT

    47 .I

    97 .UNINDENT

    48 /etc

    98 .sp

    49 .PD

    99 The first configuration file found will be used.

    50 .RE

   100 .SH SECTIONS

    51 .PP

   101 .sp

    52 The first match it finds will be used.

   102 This section describes all sections and their options of the \fIvmm.cfg\fP.

    53 .\" -----

   103 .SS ACCOUNT

    54 .SH DATABASE SECTION

   104 .sp

   105 The options in the section \fBaccount\fP are used to specify user account

   106 related settings.

   107 .INDENT 0.0

   108 .TP

   109 .B \fCdelete_directory\fP

   110 \fIBoolean\fP

   111 .sp

   112 Determines the behavior of \fBvmm\fP(1) when an account is deleted. If

   113 this option is set to \fItrue\fP the user\(aqs home directory will be deleted

   114 recursively.

   115 .TP

   116 .B \fCdirectory_mode\fP

   117 \fIInt\fP

   118 .sp

   119 Access mode for a user\(aqs home directory and all directories inside.

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

   121 .nf

   122 For example: \(aqdrwx\-\-\-\-\-\-\(aq \-> octal 0700 \-> decimal 448

   123 .fi

   124 .sp

   125 .TP

   126 .B \fCdisk_usage\fP

   127 \fIBoolean\fP

   128 .sp

   129 Determines whether the disk usage of a user\(aqs Maildir always should be

   130 summarized, using \fBdu\fP(1), and displayed with account information.

   131 .sp

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

   133 \fBvmm\fP\(aqs \fBuserinfo\fP subcomammand will also display the current quota

   134 usage of the account. You may also use \fBuserinfo\fP\(aqs optional argument

   135 \fBdu\fP or \fBfull\fP, in order to display the current disk usage of an

   136 account.

   137 .TP

   138 .B \fCimap\fP

   139 \fIBoolean\fP

   140 .sp

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

   142 .TP

   143 .B \fCpassword_length\fP

   144 \fIInt\fP

   145 .sp

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

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

   148 .TP

   149 .B \fCpop3\fP

   150 \fIBoolean\fP

   151 .sp

   152 Determines whether a newly created user can log in via POP3.

   153 .TP

   154 .B \fCrandom_password\fP

   155 \fIBoolean\fP

   156 .sp

   157 Determines whether \fBvmm\fP should generate a random password when no

   158 password was given for the \fBuseradd\fP subcommand. If this option is

   159 set to \fIfalse\fP \fBvmm\fP will prompt you to enter a password for the new

   160 account.

   161 .sp

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

   163 \fBpassword_length\fP option.

   164 .TP

   165 .B \fCsieve\fP

   166 \fIBoolean\fP

   167 .sp

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

   169 .TP

   170 .B \fCsmtp\fP

   171 \fIBoolean\fP

   172 .sp

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

   174 .UNINDENT

   175 .sp

   176 Example:

   177 .sp

   178 .nf

   179 .ft C

   180 [account]

   181 delete_directory = false

   182 directory_mode = 448

   183 disk_usage = false

   184 random_password = true

   185 password_length = 10

   186 smtp = true

   187 pop3 = true

   188 imap = true

   189 sieve = true

   190 .ft P

   191 .fi

   192 .SS BIN

   193 .sp

   194 The \fBbin\fP section is used to specify some paths to some binaries required

   195 by \fBvmm\fP(1).

   196 .INDENT 0.0

   197 .TP

   198 .B \fCdovecotpw\fP

   199 \fIString\fP

   200 .sp

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

   202 generate a password hash, if \fBmisc.password_scheme\fP is set to one of

   203 \(aqSMD5\(aq, \(aqSSHA\(aq, \(aqCRAM\-MD5\(aq, \(aqHMAC\-MD5\(aq, \(aqLANMAN\(aq, \(aqNTLM\(aq or \(aqRPA\(aq.

   204 .TP

   205 .B \fCdu\fP

   206 \fIString\fP

   207 .sp

   208 The absolute path to \fBdu\fP(1). This binary is used to summarize the

   209 disk usage of a user\(aqs Maildir.

   210 .TP

   211 .B \fCpostconf\fP

   212 \fIString\fP

   213 .sp

   214 The absolute path to Postfix\(aq \fBpostconf\fP(1). This binary is required

   215 when \fBvmm\fP(1) has to check for some Postfix settings, e.g.

   216 \fIvirtual_alias_expansion_limit\fP.

   217 .UNINDENT

   218 .sp

   219 Example:

   220 .sp

   221 .nf

   222 .ft C

   223 [bin]

   224 dovecotpw = /usr/sbin/dovecotpw

   225 du = /usr/bin/du

   226 postconf = /usr/sbin/postconf

   227 .ft P

   228 .fi

   229 .SS CONFIG

   230 .sp

   231 The \fBconfig\fP section is an internal used control section.

   232 .INDENT 0.0

   233 .TP

   234 .B \fCdone\fP

   235 \fIBoolean\fP

   236 .sp

   237 This option is set to \fIfalse\fP when \fBvmm\fP(1) is installed for the first

   238 time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is

   239 also set to \fItrue\fP when you configure \fBvmm\fP(1) with the command \fBvmm

   240 configure\fP.

   241 .sp

   242 If this option is set to \fIfalse\fP, \fBvmm\fP(1) will start in the

   243 interactive configurations mode.

   244 .UNINDENT

   245 .sp

   246 Example:

   247 .sp

   248 .nf

   249 .ft C

   250 [config]

   251 done = true

   252 .ft P

   253 .fi

   254 .SS DATABASE

   255 .sp

    57 .TP

   258 .INDENT 0.0

    58 \fBhost\fP (\fIString\fP)

   259 .TP

   260 .B \fChost\fP

   261 \fIString\fP

   262 .sp

    61 \fBuser\fP (\fIString\fP)

   265 .B \fCname\fP

   266 \fIString\fP

   267 .sp

   268 Name of the database.

   269 .TP

   270 .B \fCpass\fP

   271 \fIString\fP

   272 .sp

   273 Database password.

   274 .TP

   275 .B \fCuser\fP

   276 \fIString\fP

   277 .sp

    63 .TP

   279 .UNINDENT

    64 \fBpass\fP (\fIString\fP)

   280 .sp

    65 Database password

   281 Example:

    66 .TP

   282 .sp

    67 \fBname\fP (\fIString\fP)

   283 .nf

    68 Name of the database.

   284 .ft C

    69 .TP

    70 \fBExample\fP:

    76 .br

   288 pass = PY_SRJ}L/0p\-oOk

    77 pass = T~_:L4OYyl]TU?)

    78 .br

    80 .\" -----

   290 .ft P

    81 .SH MAILDIR SECTION

   291 .fi

    82 The \fBmaildir\fP section is used to specify some options for the Maildirs.

   292 .SS DOMAIN

    83 .TP

   293 .sp

    84 \fBname\fP (\fIString\fP)

   294 The \fBdomain\fP section specifies some domain related settings.

    85 Default name of the maildir folder in users home directory.

   295 .INDENT 0.0

    86 .TP

   296 .TP

    87 \fBfolders\fP (\fIString\fP)

   297 .B \fCauto_postmaster\fP

    88 A colon separated list of folder names, that should be created.

   298 \fIBoolean\fP

    89 .br

   299 .sp

    90 If no folders should be created inside the Maildir, set the value of this option

   300 Determines if \fBvmm\fP(1) should create also a postmaster account when a

    91 to a single colon (':').

   301 new domain is created.

    92 .TP

   302 .TP

    93 \fBmode\fP (\fIInt\fP)

   303 .B \fCdelete_directory\fP

    94 Access mode for the maildir in decimal (base 10) notation. For example:

   304 \fIBoolean\fP

    95 \'drwx------' -> octal 0700 -> decimal 448

   305 .sp

    96 .TP

   306 Specifies whether the domain directory and all user directories inside

    97 \fBdiskusage\fP (\fIBoolean\fP)

   307 should be deleted when a domain is deleted.

    98 Decides if the disk usage of users maildir always should be summarized and

   308 .TP

    99 displayed with account information.

   309 .B \fCdirectory_mode\fP

   100 .TP

   310 \fIInt\fP

   101 \fBdelete\fP (\fIBoolean\fP)

   311 .sp

   102 Decides if the maildir should be deleted recursive when the account is deleted.

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

   103 .TP

   313 .nf

   104 \fBExample\fP:

   314 For example: \(aqdrwxrwx\-\-\-\(aq \-> octal 0770 \-> decimal 504

   315 .fi

   316 .sp

   317 .TP

   318 .B \fCforce_deletion\fP

   319 \fIBoolean\fP

   320 .sp

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

   322 .UNINDENT

   323 .sp

   324 Example:

   325 .sp

   326 .nf

   327 .ft C

   328 [domain]

   329 auto_postmaster = true

   330 delete_directory = false

   331 directory_mode = 504

   332 force_deletion = false

   333 .ft P

   334 .fi

   335 .SS MAILDIR

   336 .sp

   337 The \fBmaildir\fP section is used to specify some default options for new

   338 created Maildirs and folders inside.

   339 .INDENT 0.0

   340 .TP

   341 .B \fCfolders\fP

   342 \fIString\fP

   343 .sp

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

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

   346 option to a single colon (\(aq\fB:\fP\(aq).

   347 .sp

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

   349 them with a single dot (\(aq\fB.\fP\(aq).

   350 .TP

   351 .B \fCname\fP

   352 \fIString\fP

   353 .sp

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

   355 .UNINDENT

   356 .sp

   357 Example:

   358 .sp

   359 .nf

   360 .ft C

   106 .br

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

   108 .br

   364 .ft P

   109 folders = Drafts:Sent:Templates:Trash:INBOX.News

   365 .fi

   110 .br

   366 .SS MISC

   111 mode = 448

   367 .sp

   112 .br

   368 The \fBmisc\fP section is used to define miscellaneous settings.

   113 diskusage = false

   369 .INDENT 0.0

   114 .br

   370 .TP

   115 delete = false

   371 .B \fCbase_directory\fP

   116 .\" -----

   372 \fIString\fP

   117 .SH SERVICES SECTION

   373 .sp

   118 The \fBservices\fP section is used to specify the default restrictions for

   119 all accounts.

   120 .TP

   121 \fBsmtp\fP (\fIBoolean\fP)

   122 Decides if users can login via smtp by default. 

   123 .TP

   124 \fBpop3\fP (\fIBoolean\fP)

   125 Decides if users can login via pop3 by default. 

   126 .TP

   127 \fBimap\fP (\fIBoolean\fP)

   128 Decides if users can login via imap by default. 

   129 .TP

   130 \fBsieve\fP (\fIBoolean\fP)

   131 Decides if users can login via managesieve by default. 

   132 .TP

   133 \fBExample\fP:

   134 [services]

   135 .br

   136 smtp = true

   137 .br

   138 pop3 = true

   139 .br

   140 imap = false

   141 .br

   142 sieve = false

   143 .\" -----

   144 .SH DOMDIR SECTION

   145 The \fBdomdir\fP section is used to specify options for the directories of the

   146 domains.

   147 .TP

   148 \fBbase\fP (\fIString\fP)

   151 \fBmode\fP (\fIInt\fP)

   376 .B \fCpassword_scheme\fP

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

   377 \fIString\fP

   153 example: 'drwxrwx---' -> octal 0770 -> decimal 504

   378 .sp

   154 .TP

   379 Password scheme to use (see also: \fBdovecotpw \-l\fP).

   155 \fBdelete\fP (\fIBoolean\fP)

   380 .TP

   156 Decides if the domain directory and all user directories inside should be

   381 .B \fCgid_mail\fP

   157 deleted when a domain is deleted.

   382 \fIInt\fP

   158 .TP

   383 .sp

   159 \fBExample\fP:

   384 Numeric group ID of group mail (\fImail_privileged_group\fP from

   160 [domdir]

   385 \fIdovecot.conf\fP)

   161 .br

   386 .TP

   162 base = /srv/mail

   387 .B \fCtransport\fP

   163 .br

   388 \fIString\fP

   164 mode = 504

   389 .sp

   165 .br

   390 Default transport for domains and accounts. For details see

   166 delete = false

   391 \fBtransport\fP(5).

   167 .\" -----

   392 .TP

   168 .SH BIN SECTION

   393 .B \fCdovecot_version\fP

   169 The \fBbin\fP section is used to specify some paths to some binaries required

   394 \fIInt\fP

   170 by \fBvmm\fP.

   395 .sp

   171 .TP

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

   172 \fBdovecotpw\fP (\fIString\fP)

   397 Dovecot version. (see: \fBdovecot \-\-version\fP).

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

   398 .sp

   174 password hash, if the \fIpasswdscheme\fP is one of 'SMD5', 'SSHA', 'CRAM-MD5',

   399 This option affects various database operations. There are some

   175 \'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.

   400 differences between Dovecot v1.1.x and v1.2.x. For example, when the

   176 .TP

   401 command \fBdovecot \-\-version\fP shows 1.1.18, set the value of this option

   177 \fBdu\fP (\fIString\fP)

   402 to \fB11\fP.

   178 The absolute path to \fBdu\fR(1). This binary is used to summarize the disk

   403 .UNINDENT

   179 usage of a maildir.

   404 .sp

   180 .TP

   405 Example:

   181 \fBpostconf\fP (\fIString\fP)

   406 .sp

   182 The absolute path to Postfix' \fBpostconf\fR(1).

   407 .nf

   183 .br

   408 .ft C

   184 This binary is required if \fBvmm\fR(1) has to check for some Postfix settings,

   185 e.g. virtual_alias_expansion_limit.

   186 .TP

   187 \fBExample\fP:

   188 [bin]

   189 .br

   190 dovecotpw = /usr/sbin/dovecotpw

   191 .br

   192 du = /usr/bin/du

   193 .br

   194 postconf = /usr/sbin/postconf

   195 .\" -----

   196 .SH MISC SECTION

   197 The \fBmisc\fP section is used to define miscellaneous settings.

   198 .TP

   199 \fBpasswdscheme\fP (\fIString\fP)

   200 Password scheme to use (see also: dovecotpw -l)

   201 .TP

   202 \fBgid_mail\fP (\fIInt\fP)

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

   204 .TP

   205 \fBforcedel\fP (\fIBoolean\fP)

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

   207 .TP

   208 \fBtransport\fP (\fIString\fP)

   209 Default transport for domains and accounts.

   210 .TP

   211 \fBdovecotvers\fP (\fIInt\fP)

   212 The concatenated major and minor version number of the currently used Dovecot

   213 version. (see: dovecot --version).

   214 .br

   215 This option affects various database operations. There are some differences

   216 between Dovecot v1.1.x and v1.2.x. For example, when the command \fBdovecot

   217 --version\fP shows \fB1.1\fP.18, set the value of this option to \fB11\fP.

   218 .TP

   219 \fBExample\fP:

   221 .br

   410 base_directory = /srv/mail

   222 passwdscheme = CRAM-MD5

   411 password_scheme = CRAM\-MD5

   223 .br

   229 .br

   414 dovecot_version = 11

   230 dovecotvers = 11

   415 .ft P

   231 .\" -----

   416 .fi

   232 .SH CONFIG SECTION

   233 The \fBconfig\fP section is a internal used control section.

   234 .TP

   235 \fBdone\fP (\fIBoolean\fP)

   236 This option is set to \fIfalse\fP when \fBvmm\fP is installed for the first

   237 time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is

   238 also set to \fItrue\fP when you configure vmm with the command \fBvmm

   239 configure\fP.

   240 .br

   241 If this option is set to \fIfalse\fP, \fBvmm\fP will start in the interactive

   242 configurations mode.

   243 .TP

   244 \fBExample\fP:

   245 [config]

   246 .br

   247 done = true

   248 .\" -----

   250 vmm.cfg

   418 .INDENT 0.0

   419 .TP

   420 .B \fI/root/vmm.cfg\fP

   421 .nf

   422 will be used when found.

   423 .fi

   424 .sp

   425 .TP

   426 .B \fI/usr/local/etc/vmm.cfg\fP

   427 .nf

   428 will be used when the above file doesn\(aqt exist.

   429 .fi

   430 .sp

   431 .TP

   432 .B \fI/etc/vmm.cfg\fP

   433 .nf

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

   435 .fi

   436 .sp

   437 .UNINDENT

   254 \fBvmm\fP and its man pages were written by Pascal Volk

   446 Pascal Volk <neverseen@users.sourceforge.net>

   255 <\fIneverseen@users.sourceforge.net\fP> and are licensed under the terms of the

   447 .\" Generated by docutils manpage writer.

   256 BSD License.

   448 .\" 

   449 .