1 .\" Man page generated from reStructeredText. |
1 .TH "VMM.CFG" "5" "2011-02-22" "vmm 0.6" "vmm" |
2 . |
|
3 .TH VMM.CFG 5 "2010-01-18" "vmm-0.6.0" "vmm Manual" |
|
4 .SH NAME |
2 .SH NAME |
5 vmm.cfg \- configuration file for vmm |
3 vmm.cfg \- configuration file for vmm |
6 . |
4 .\" ----------------------------------------------------------------------- |
7 .nr rst2man-indent-level 0 |
|
8 . |
|
9 .de1 rstReportMargin |
|
10 \\$1 \\n[an-margin] |
|
11 level \\n[rst2man-indent-level] |
|
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
13 - |
|
14 \\n[rst2man-indent0] |
|
15 \\n[rst2man-indent1] |
|
16 \\n[rst2man-indent2] |
|
17 .. |
|
18 .de1 INDENT |
|
19 .\" .rstReportMargin pre: |
|
20 . RS \\$1 |
|
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
|
22 . nr rst2man-indent-level +1 |
|
23 .\" .rstReportMargin post: |
|
24 .. |
|
25 .de UNINDENT |
|
26 . RE |
|
27 .\" indent \\n[an-margin] |
|
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
29 .nr rst2man-indent-level -1 |
|
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
|
32 .. |
|
33 .SH SYNOPSIS |
5 .SH SYNOPSIS |
34 .sp |
|
35 vmm.cfg |
6 vmm.cfg |
|
7 .\" ----------------------------------------------------------------------- |
36 .SH DESCRIPTION |
8 .SH DESCRIPTION |
37 .sp |
9 .BR vmm (1) |
38 \fBvmm\fP(1) reads its configuration data from \fIvmm.cfg\fP. |
10 reads its configuration data from |
39 .sp |
11 .IR vmm.cfg . |
40 The configuration file is split into multiple sections. A section starts with |
12 .PP |
41 the section name, enclosed in square brackets \(aq\fB[\fP\(aq and \(aq\fB]\fP\(aq, followed |
13 The configuration file is split into multiple sections. |
42 by \(aq\fIoption\fP = \fIvalue\fP\(aq pairs: |
14 A section starts with the section name, enclosed in square brackets |
43 .sp |
15 .RB ` [ "' and `" ] ', |
|
16 followed by |
|
17 .RI ` option " = " value ' |
|
18 pairs. |
|
19 .br |
|
20 Whitespace around the `=' and at the end of a value is ignored. |
|
21 Empty lines and lines starting with `#' or `;' will be ignored. |
|
22 .PP |
|
23 Each value uses one of the following data types: |
|
24 .TP 8 |
|
25 .I Boolean |
|
26 to indicate if something is enabled/activated (true) or |
|
27 disabled/deactivated (false). |
|
28 .br |
|
29 Accepted values for |
|
30 .I true |
|
31 are: |
|
32 .BR 1 , " yes" , " true" " and " on . |
|
33 .br |
|
34 Accepted values for |
|
35 .I false |
|
36 are: |
|
37 .BR 0 , " no" , " false" " and " off . |
|
38 .TP |
|
39 .I Int |
|
40 an integer number, written without a fractional or decimal component. |
|
41 .br |
|
42 For example |
|
43 .BR 1 , " 50" " or " 321 |
|
44 are integers. |
|
45 .TP |
|
46 .I String |
|
47 a sequence of characters and/or numbers. |
|
48 .br |
|
49 For example |
|
50 .RB ` word "', `" "hello world" "' or `" /usr/bin/strings ' |
|
51 are strings. |
|
52 .PP |
|
53 Most options have a default value, shown in parentheses after the option's |
|
54 name. |
|
55 In order to use a option's default setting, comment out the line, either |
|
56 with a |
|
57 .BR # " or " ; |
|
58 or simply remove the setting from |
|
59 .IR vmm.cfg . |
|
60 .PP |
|
61 A minimal |
|
62 .I vmm.cfg |
|
63 would be: |
|
64 .PP |
44 .nf |
65 .nf |
45 .ft C |
|
46 [database] |
66 [database] |
47 host = 127.0.0.1 |
67 user = me |
48 .ft P |
68 pass = xxxxxxxx |
|
69 |
|
70 [misc] |
|
71 dovecot_version = 1.2.16 |
49 .fi |
72 .fi |
50 .sp |
73 .\" ----------------------------------------------------------------------- |
51 Whitespace around the \(aq=\(aq and at the end of a value is ignored. |
74 .SH SEARCH ORDER |
52 .sp |
75 By default |
53 Empty lines and lines starting with \(aq#\(aq or \(aq;\(aq will be ignored. |
76 .BR vmm (1) |
54 .sp |
77 looks for the |
55 Each value uses one of the following data types: |
78 .I vmm.cfg |
56 .INDENT 0.0 |
79 file in the following directories in the order listed: |
57 .IP \(bu 2 |
80 .RS |
58 . |
81 .PD 0 |
59 \fIBoolean\fP to indicate if something is enabled/activated (true) or |
82 .TP |
60 disabled/deactivated (false). |
83 .I |
|
84 /root |
|
85 .TP |
|
86 .I |
|
87 /usr/local/etc |
|
88 .TP |
|
89 .I |
|
90 /etc |
|
91 .PD |
|
92 .RE |
|
93 .PP |
|
94 The first configuration file found will be used. |
|
95 .\" ----------------------------------------------------------------------- |
|
96 .SH SECTION ACCOUNT |
|
97 The options in the section |
|
98 .B account |
|
99 are used to specify user account related settings. |
|
100 .SS account.delete_directory |
|
101 .BR delete_directory " (default: false) :" |
|
102 .I Boolean |
|
103 .PP |
|
104 Determines the behavior of |
|
105 .BR vmm (1) |
|
106 when an account is deleted (userdelete). |
|
107 If this option is set to |
|
108 .I true |
|
109 the user's home directory will be deleted recursively. |
|
110 .\" ------------------------------------ |
|
111 .SS account.directory_mode |
|
112 .BR directory_mode " (default: 448) :" |
|
113 .I Int |
|
114 .PP |
|
115 Access mode for a user's home directory and all directories inside. |
|
116 The value has to be specified in decimal (base 10) notation. |
|
117 .br |
|
118 For example: `drwx\-\-\-\-\-\-' \(-> octal 0700 \(-> decimal 448 |
|
119 .\" ------------------------------------ |
|
120 .SS account.disk_usage |
|
121 .BR disk_usage " (default: false) :" |
|
122 .I Boolean |
|
123 .PP |
|
124 Determines whether the disk usage of a user's mail directory always should |
|
125 be summarized, using |
|
126 .BR du (1), |
|
127 and displayed with the account information (userinfo). |
|
128 .PP |
|
129 This could be slow on large Maildirs. |
|
130 When you have enabled quotas, |
|
131 .BR vmm 's |
|
132 userinfo subcommand will also display the current quota usage of the |
|
133 account. |
|
134 You may also use userinfo's optional details\-argument |
|
135 .BR du " or " full , |
|
136 in order to display the current disk usage of an account's mail directory. |
|
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 |
|
145 .BR password_length " (default: 8) :" |
|
146 .I Int |
|
147 .PP |
|
148 Determines how many characters and/or numbers should be used for randomly |
|
149 generated passwords. |
|
150 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 .\" ------------------------------------ |
|
158 .SS account.random_password |
|
159 .BR random_password " (default: false) :" |
|
160 .I Boolean |
|
161 .PP |
|
162 Determines whether |
|
163 .BR vmm (1) |
|
164 should generate a random password when no password was given for the |
|
165 useradd subcommand. |
|
166 If this option is set to |
|
167 .I false |
|
168 .B vmm |
|
169 will prompt you to enter a password for the new account. |
|
170 .PP |
|
171 You can specify the password length of generated passwords with the |
|
172 .I account.password_length |
|
173 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 .\" ----------------------------------------------------------------------- |
|
187 .SH SECTION BIN |
|
188 The |
|
189 .B bin |
|
190 section is used to specify some paths to some binaries required by |
|
191 .BR vmm (1). |
|
192 .SS bin.dovecotpw |
|
193 .BR dovecotpw " (default: /usr/sbin/dovecotpw) :" |
|
194 .I String |
|
195 .PP |
|
196 The absolute path to the |
|
197 .BR dovecotpw (1) |
|
198 binary. |
|
199 Use the absolute path to the |
|
200 .BR doveadm (1) |
|
201 binary, if you are using Dovecot v2.0. |
|
202 .PP |
|
203 This binary is used to generate a password hash, if |
|
204 .I misc.password_scheme |
|
205 is set to one of `CRAM\-MD5', `HMAC\-MD5', `LANMAN', `OTP', `RPA' or |
|
206 `SKEY'. |
|
207 This binary will be also required if your Python installation doesn't |
|
208 support the: |
|
209 .IP \(bu 4 |
|
210 md4 hash algorithm (hashlib + OpenSSL or PyCrypto) used for the password |
|
211 schemes: `PLAIN\-MD4' and `NTLM' |
|
212 .IP \(bu |
|
213 sha256 hash algorithm (hashlib or PyCrypto \(>= 2.1.0alpha1) used for the |
|
214 password schemes: `SHA256' and `SSHA256' |
|
215 .IP \(bu |
|
216 sha512 hash algorithm (hashlib) used for the password schemes: `SHA512' and |
|
217 `SSHA512' |
|
218 .PP |
|
219 The |
|
220 .BR doveadm (1) |
|
221 binary is also used to create a user's INBOX and additional mailboxes |
|
222 .RI ( mailbox.folders ), |
|
223 when the |
|
224 .I mailbox.format |
|
225 is set to |
|
226 .BR mdbox " or " sdbox . |
|
227 .\" ------------------------------------ |
|
228 .SS bin.du |
|
229 .BR du " (default: /usr/bin/du) :" |
|
230 .I String |
|
231 .PP |
|
232 The absolute path to |
|
233 .BR du (1). |
|
234 This binary is used to summarize the disk usage of a user's mail directory. |
|
235 .\" ------------------------------------ |
|
236 .SS bin.postconf |
|
237 .BR postconf " (default: /usr/sbin/postconf) :" |
|
238 .I String |
|
239 .PP |
|
240 The absolute path to Postfix' |
|
241 .BR postconf (1). |
|
242 This binary is required when |
|
243 .BR vmm (1) |
|
244 has to check for some Postfix settings, e.g. the |
|
245 .IR virtual_alias_expansion_limit . |
|
246 .\" ----------------------------------------------------------------------- |
|
247 .SH SECTION DATABASE |
|
248 The |
|
249 .B database |
|
250 section is used to specify some options required to connect to the |
|
251 database. |
|
252 .SS database.host |
|
253 .BR host " (default: localhost) :" |
|
254 .I String |
|
255 .PP |
|
256 Hostname or IP address of the database server. |
|
257 .\" ------------------------------------ |
|
258 .SS database.module |
|
259 .BR module " (default: psycopg2) :" |
|
260 .I String |
|
261 .PP |
|
262 The Python PostgreSQL database adapter module to be used. |
|
263 Supported modules are |
|
264 .BR psycopg2 " and " pyPgSQL . |
|
265 .\" ------------------------------------ |
|
266 .SS database.name |
|
267 .BR name " (default: mailsys) :" |
|
268 .I String |
|
269 .PP |
|
270 Name of the database. |
|
271 .\" ------------------------------------ |
|
272 .SS database.pass |
|
273 .BR pass " (default: " None ") :" |
|
274 .I String |
|
275 .PP |
|
276 Database password. |
|
277 .\" ------------------------------------ |
|
278 .SS database.port |
|
279 .BR port " (default: 5432) :" |
|
280 .I Int |
|
281 .PP |
|
282 The TCP port, on which the database server is listening for connections. |
|
283 .\" ------------------------------------ |
|
284 .SS database.sslmode |
|
285 .BR sslmode " (default: prefer) :" |
|
286 .I String |
|
287 .PP |
|
288 Determines whether and with what priority an SSL connection will be |
|
289 negotiated with the database server. |
|
290 Possible values are: |
|
291 .BR disabled ", " allow ", " prefer ", " require ", " verify\-ca " and " |
|
292 .BR verify\-full . |
|
293 The modes |
|
294 .BR verify\-ca " and " verify\-full |
|
295 are available since PostgreSQL 8.4 |
|
296 .PP |
|
297 This setting will be ignored when the |
|
298 .I database.module |
|
299 is set to |
|
300 .BR pyPgSQL . |
|
301 .\" ------------------------------------ |
|
302 .SS database.user |
|
303 .BR user " (default: " None ") :" |
|
304 .I String |
|
305 .PP |
|
306 Name of the database user. |
|
307 .\" ----------------------------------------------------------------------- |
|
308 .SH SECTION DOMAIN |
|
309 The |
|
310 .B domain |
|
311 section specifies some domain related settings. |
|
312 .SS domain.auto_postmaster |
|
313 .BR auto_postmaster " (default: true) :" |
|
314 .I Boolean |
|
315 .PP |
|
316 Determines if |
|
317 .BR vmm (1) |
|
318 should create also a postmaster account when a new domain is created |
|
319 (domainadd). |
|
320 .\" ------------------------------------ |
|
321 .SS domain.delete_directory |
|
322 .BR delete_directory " (default: false) :" |
|
323 .I Boolean |
|
324 .PP |
|
325 Specifies whether the domain directory and all user directories inside |
|
326 should be deleted when a domain is deleted (domaindelete). |
|
327 .\" ------------------------------------ |
|
328 .SS domain.directory_mode |
|
329 .BR directory_mode " (default: 504) :" |
|
330 .I Int |
|
331 .PP |
|
332 Access mode for the domain directory in decimal (base 10) notation. |
|
333 .br |
|
334 For example: `drwxrwx\-\-\-' \(-> octal 0770 \(-> decimal 504 |
|
335 .\" ------------------------------------ |
|
336 .SS domain.force_deletion |
|
337 .BR force_deletion " (default: false) :" |
|
338 .I Boolean |
|
339 .PP |
|
340 Force the deletion of accounts and aliases when a domain is deleted |
|
341 (domaindelete). |
|
342 .\" ----------------------------------------------------------------------- |
|
343 .SH SECTION MAILBOX |
|
344 The |
|
345 .B mailbox |
|
346 section is used to specify some options for new created mailboxes in the |
|
347 users home directories. |
|
348 The INBOX will be created always. |
|
349 .SS mailbox.folders |
|
350 .BR folders " (default: Drafts:Sent:Templates:Trash) :" |
|
351 .I String |
|
352 .PP |
|
353 A colon separated list of mailboxes that should be created. |
|
354 If no additionally mailboxes should be created, set the value of this |
|
355 option to a single colon |
|
356 .RB (` : '). |
|
357 .PP |
|
358 If you want to create folders containing one or more subfolders, separate |
|
359 them with a single dot |
|
360 .RB (` . '). |
|
361 .PP |
|
362 If you want to use internationalized mailbox names (e.g. `Wysłane' or |
|
363 `Gelöschte Objekte'), write their names UTF\-8 encoded. |
|
364 .BR vmm (1) |
|
365 will convert internationalized mailbox names to a modified version of the |
|
366 UTF\-7 encoding (see also: RFC 3501, section 5.1.3). |
|
367 .\" ------------------------------------ |
|
368 .SS mailbox.format |
|
369 .BR format " (default: maildir) :" |
|
370 .I String |
|
371 .PP |
|
372 The mailbox format to be used for a user's mailbox. |
|
373 Depending on the used Dovecot version |
|
374 .RI ( misc.dovecot_version ) |
|
375 .BR vmm (1) |
|
376 supports up to three formats: |
|
377 .TP 8 |
|
378 .B maildir |
|
379 Dovecot \(>= v1.0.0 |
|
380 .TP |
|
381 .B mdbox |
|
382 Dovecot \(>= v2.0.beta5 |
|
383 .TP |
|
384 .B sdbox |
|
385 Dovecot \(>= v2.0.rc3 |
|
386 .\" ------------------------------------ |
|
387 .SS mailbox.root |
|
388 .BR root " (default: Maildir) :" |
|
389 .I String |
|
390 .PP |
|
391 Name of the mailbox root directory in a user's home directory. |
|
392 Commonly used names, depending on the used |
|
393 .IR mailbox.format , |
|
394 are |
|
395 .BR Maildir ", " mdbox " or " sdbox . |
|
396 .\" ------------------------------------ |
|
397 .SS mailbox.subscribe |
|
398 .BR subscribe " (default: true) :" |
|
399 .I Boolean |
|
400 .PP |
|
401 When this option is set to |
|
402 .BR true , |
|
403 the mailboxes from the |
|
404 .I mailbox.folders |
|
405 option will be listed in the user's subscriptions file. |
|
406 If you don't want to subscribe the created mailboxes, set this option to |
|
407 .BR false . |
|
408 .\" ----------------------------------------------------------------------- |
|
409 .SH SECTION MISC |
|
410 The |
|
411 .I misc |
|
412 section is used to define miscellaneous settings. |
|
413 .SS misc.base_directory |
|
414 .BR base_directory " (default: /srv/mail) :" |
|
415 .I String |
|
416 .PP |
|
417 All domain directories will be created inside this directory. |
|
418 .\" ------------------------------------ |
|
419 .SS misc.crypt_blowfish_rounds |
|
420 .BR crypt_blowfish_rounds " (default: 5) :" |
|
421 .I Int |
|
422 .PP |
|
423 Number of encryption rounds for the |
|
424 .I password_scheme |
|
425 .BR BLF\-CRYPT . |
|
426 .PP |
|
427 The value must be in range |
|
428 .BR 4 " \- " 31 . |
|
429 .\" ------------------------------------ |
|
430 .SS misc.crypt_sha256_rounds |
|
431 .BR crypt_sha256_rounds " (default: 5000) :" |
|
432 .I Int |
|
433 .PP |
|
434 Number of encryption rounds for the |
|
435 .I password_scheme |
|
436 .BR SHA256\-CRYPT . |
|
437 .PP |
|
438 The value must be in range |
|
439 .BR 1000 " \- " 999999999 . |
|
440 .\" ------------------------------------ |
|
441 .SS misc.crypt_sha512_rounds |
|
442 .BR crypt_sha512_rounds " (default: 5000) :" |
|
443 .I Int |
|
444 .PP |
|
445 Number of encryption rounds for the |
|
446 .I password_scheme |
|
447 .BR SHA512\-CRYPT . |
|
448 .PP |
|
449 The value must be in range |
|
450 .BR 1000 " \- " 999999999 . |
|
451 .\" ------------------------------------ |
|
452 .SS misc.dovecot_version |
|
453 .BR dovecot_version " (default: " None ") :" |
|
454 .I String |
|
455 .PP |
|
456 The version number of the currently used Dovecot version. |
|
457 (see: |
|
458 .BR "dovecot \-\-version" ) |
|
459 .br |
|
460 When, for example, the command |
|
461 .B dovecot \-\-version |
|
462 prints |
|
463 .IR "2.0.beta4 (8818db00d347)" , |
|
464 set the value of this option to |
|
465 .BR 2.0.beta4 . |
|
466 .\" ------------------------------------ |
|
467 .SS misc.password_scheme |
|
468 .BR password_scheme " (default: CRAM\-MD5) :" |
|
469 .I String |
|
470 .PP |
|
471 Password scheme to use. |
|
472 To get a list of all available password schemes execute the command |
|
473 .B dovecotpw \-l |
|
474 (Dovecot v1.x) or |
|
475 .B doveadm pw \-l |
|
476 (Dovecot v2.0). |
|
477 .PP |
|
478 With Dovecot \(>= v1.1.alpha1 it is also possible to append an encoding |
|
479 suffix to the password_scheme. |
|
480 Supported encoding suffixes are: |
|
481 .BR .b64 ", " .base64 " and " .hex . |
|
482 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 .\" ----------------------------------------------------------------------- |
|
517 .SH EXAMPLE |
|
518 An example configuration. |
|
519 All options that are not listed in the configuration file will have their |
|
520 default values. |
|
521 .PP |
61 .nf |
522 .nf |
62 Accepted values for \fItrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and \fBon\fP. |
523 [account] |
63 Accepted values for \fIfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and \fBoff\fP. |
524 password_length = 10 |
|
525 random_password = true |
|
526 |
|
527 [bin] |
|
528 dovecotpw = /usr/bin/doveadm |
|
529 |
|
530 [database] |
|
531 host = dbsrv8.example.net |
|
532 pass = PY_SRJ}L/0p\-oOk |
|
533 port = 5433 |
|
534 sslmode = require |
|
535 user = vmm |
|
536 |
|
537 [mailbox] |
|
538 folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix |
|
539 |
|
540 [misc] |
|
541 crypt_sha512_rounds = 10000 |
|
542 dovecot_version = 2.0.beta4 |
|
543 password_scheme = SHA512\-CRYPT.hex |
|
544 quota_bytes = 500M |
|
545 quota_messages = 10000 |
|
546 transport = lmtp:unix:private/dovecot\-lmtp |
64 .fi |
547 .fi |
65 .sp |
548 .\" ----------------------------------------------------------------------- |
66 .IP \(bu 2 |
|
67 . |
|
68 \fIInt\fP an integer number, written without a fractional or decimal component. |
|
69 .nf |
|
70 For example \fB1\fP, \fB50\fP or \fB321\fP are integers. |
|
71 .fi |
|
72 .sp |
|
73 .IP \(bu 2 |
|
74 . |
|
75 \fIString\fP a sequence of characters and numbers. |
|
76 .nf |
|
77 For example \(aq\fBword\fP\(aq, \(aq\fBhello world\fP\(aq or \(aq\fB/usr/bin/strings\fP\(aq |
|
78 .fi |
|
79 .sp |
|
80 .UNINDENT |
|
81 .SS SEARCH ORDER |
|
82 .sp |
|
83 By default \fBvmm\fP(1) looks for \fIvmm.cfg\fP in the following directories in the |
|
84 order listed: |
|
85 .INDENT 0.0 |
|
86 .INDENT 3.5 |
|
87 .nf |
|
88 \fI/root\fP |
|
89 \fI/usr/local/etc\fP |
|
90 \fI/etc\fP |
|
91 .fi |
|
92 .sp |
|
93 .UNINDENT |
|
94 .UNINDENT |
|
95 .sp |
|
96 The first configuration file found will be used. |
|
97 .SH SECTIONS |
|
98 .sp |
|
99 This section describes all sections and their options of the \fIvmm.cfg\fP. |
|
100 .SS ACCOUNT |
|
101 .sp |
|
102 The options in the section \fBaccount\fP are used to specify user account |
|
103 related settings. |
|
104 .INDENT 0.0 |
|
105 .TP |
|
106 .B \fCdelete_directory\fP |
|
107 \fIBoolean\fP |
|
108 .sp |
|
109 Determines the behavior of \fBvmm\fP(1) when an account is deleted. If |
|
110 this option is set to \fItrue\fP the user\(aqs home directory will be deleted |
|
111 recursively. |
|
112 .TP |
|
113 .B \fCdirectory_mode\fP |
|
114 \fIInt\fP |
|
115 .sp |
|
116 Access mode for a user\(aqs home directory and all directories inside. |
|
117 The value has to be specified in decimal (base 10) notation. |
|
118 .nf |
|
119 For example: \(aqdrwx\-\-\-\-\-\-\(aq \-> octal 0700 \-> decimal 448 |
|
120 .fi |
|
121 .sp |
|
122 .TP |
|
123 .B \fCdisk_usage\fP |
|
124 \fIBoolean\fP |
|
125 .sp |
|
126 Determines whether the disk usage of a user\(aqs Maildir always should be |
|
127 summarized, using \fBdu\fP(1), and displayed with account information. |
|
128 .sp |
|
129 This could be slow on large Maildirs. When you have enabled quotas, |
|
130 \fBvmm\fP\(aqs \fBuserinfo\fP subcomammand will also display the current quota |
|
131 usage of the account. You may also use \fBuserinfo\fP\(aqs optional argument |
|
132 \fBdu\fP or \fBfull\fP, in order to display the current disk usage of an |
|
133 account. |
|
134 .TP |
|
135 .B \fCimap\fP |
|
136 \fIBoolean\fP |
|
137 .sp |
|
138 Determines whether a newly created user can log in via IMAP. |
|
139 .TP |
|
140 .B \fCpassword_length\fP |
|
141 \fIInt\fP |
|
142 .sp |
|
143 Determines how many characters and/or numbers should be used for random |
|
144 generated passwords. Any value less than 8 will be increased to 8. |
|
145 .TP |
|
146 .B \fCpop3\fP |
|
147 \fIBoolean\fP |
|
148 .sp |
|
149 Determines whether a newly created user can log in via POP3. |
|
150 .TP |
|
151 .B \fCrandom_password\fP |
|
152 \fIBoolean\fP |
|
153 .sp |
|
154 Determines whether \fBvmm\fP should generate a random password when no |
|
155 password was given for the \fBuseradd\fP subcommand. If this option is |
|
156 set to \fIfalse\fP \fBvmm\fP will prompt you to enter a password for the new |
|
157 account. |
|
158 .sp |
|
159 You can specify the password length of generated passwords with the |
|
160 \fBpassword_length\fP option. |
|
161 .TP |
|
162 .B \fCsieve\fP |
|
163 \fIBoolean\fP |
|
164 .sp |
|
165 Determines whether a newly created user can log in via ManageSieve. |
|
166 .TP |
|
167 .B \fCsmtp\fP |
|
168 \fIBoolean\fP |
|
169 .sp |
|
170 Determines whether a newly created user can log in via SMTP (SMTP AUTH). |
|
171 .UNINDENT |
|
172 .sp |
|
173 Example: |
|
174 .sp |
|
175 .nf |
|
176 .ft C |
|
177 [account] |
|
178 delete_directory = false |
|
179 directory_mode = 448 |
|
180 disk_usage = false |
|
181 random_password = true |
|
182 password_length = 10 |
|
183 smtp = true |
|
184 pop3 = true |
|
185 imap = true |
|
186 sieve = true |
|
187 .ft P |
|
188 .fi |
|
189 .SS BIN |
|
190 .sp |
|
191 The \fBbin\fP section is used to specify some paths to some binaries required |
|
192 by \fBvmm\fP(1). |
|
193 .INDENT 0.0 |
|
194 .TP |
|
195 .B \fCdovecotpw\fP |
|
196 \fIString\fP |
|
197 .sp |
|
198 The absolute path to the dovecotpw binary. This binary is used to |
|
199 generate a password hash, if \fBmisc.password_scheme\fP is set to one of |
|
200 \(aqSMD5\(aq, \(aqSSHA\(aq, \(aqCRAM\-MD5\(aq, \(aqHMAC\-MD5\(aq, \(aqLANMAN\(aq, \(aqNTLM\(aq or \(aqRPA\(aq. |
|
201 .TP |
|
202 .B \fCdu\fP |
|
203 \fIString\fP |
|
204 .sp |
|
205 The absolute path to \fBdu\fP(1). This binary is used to summarize the |
|
206 disk usage of a user\(aqs Maildir. |
|
207 .TP |
|
208 .B \fCpostconf\fP |
|
209 \fIString\fP |
|
210 .sp |
|
211 The absolute path to Postfix\(aq \fBpostconf\fP(1). This binary is required |
|
212 when \fBvmm\fP(1) has to check for some Postfix settings, e.g. |
|
213 \fIvirtual_alias_expansion_limit\fP. |
|
214 .UNINDENT |
|
215 .sp |
|
216 Example: |
|
217 .sp |
|
218 .nf |
|
219 .ft C |
|
220 [bin] |
|
221 dovecotpw = /usr/sbin/dovecotpw |
|
222 du = /usr/bin/du |
|
223 postconf = /usr/sbin/postconf |
|
224 .ft P |
|
225 .fi |
|
226 .SS CONFIG |
|
227 .sp |
|
228 The \fBconfig\fP section is an internal used control section. |
|
229 .INDENT 0.0 |
|
230 .TP |
|
231 .B \fCdone\fP |
|
232 \fIBoolean\fP |
|
233 .sp |
|
234 This option is set to \fIfalse\fP when \fBvmm\fP(1) is installed for the first |
|
235 time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is |
|
236 also set to \fItrue\fP when you configure \fBvmm\fP(1) with the command \fBvmm |
|
237 configure\fP. |
|
238 .sp |
|
239 If this option is set to \fIfalse\fP, \fBvmm\fP(1) will start in the |
|
240 interactive configurations mode. |
|
241 .UNINDENT |
|
242 .sp |
|
243 Example: |
|
244 .sp |
|
245 .nf |
|
246 .ft C |
|
247 [config] |
|
248 done = true |
|
249 .ft P |
|
250 .fi |
|
251 .SS DATABASE |
|
252 .sp |
|
253 The \fBdatabase\fP section is used to specify some options required to |
|
254 connect to the database. |
|
255 .INDENT 0.0 |
|
256 .TP |
|
257 .B \fChost\fP |
|
258 \fIString\fP |
|
259 .sp |
|
260 Hostname or IP address of the database server. |
|
261 .TP |
|
262 .B \fCname\fP |
|
263 \fIString\fP |
|
264 .sp |
|
265 Name of the database. |
|
266 .TP |
|
267 .B \fCpass\fP |
|
268 \fIString\fP |
|
269 .sp |
|
270 Database password. |
|
271 .TP |
|
272 .B \fCuser\fP |
|
273 \fIString\fP |
|
274 .sp |
|
275 Name of the database user. |
|
276 .UNINDENT |
|
277 .sp |
|
278 Example: |
|
279 .sp |
|
280 .nf |
|
281 .ft C |
|
282 [database] |
|
283 host = localhost |
|
284 user = vmm |
|
285 pass = PY_SRJ}L/0p\-oOk |
|
286 name = mailsys |
|
287 .ft P |
|
288 .fi |
|
289 .SS DOMAIN |
|
290 .sp |
|
291 The \fBdomain\fP section specifies some domain related settings. |
|
292 .INDENT 0.0 |
|
293 .TP |
|
294 .B \fCauto_postmaster\fP |
|
295 \fIBoolean\fP |
|
296 .sp |
|
297 Determines if \fBvmm\fP(1) should create also a postmaster account when a |
|
298 new domain is created. |
|
299 .TP |
|
300 .B \fCdelete_directory\fP |
|
301 \fIBoolean\fP |
|
302 .sp |
|
303 Specifies whether the domain directory and all user directories inside |
|
304 should be deleted when a domain is deleted. |
|
305 .TP |
|
306 .B \fCdirectory_mode\fP |
|
307 \fIInt\fP |
|
308 .sp |
|
309 Access mode for the domain directory in decimal (base 10) notation. |
|
310 .nf |
|
311 For example: \(aqdrwxrwx\-\-\-\(aq \-> octal 0770 \-> decimal 504 |
|
312 .fi |
|
313 .sp |
|
314 .TP |
|
315 .B \fCforce_deletion\fP |
|
316 \fIBoolean\fP |
|
317 .sp |
|
318 Force deletion of accounts and aliases when a domain is deleted. |
|
319 .UNINDENT |
|
320 .sp |
|
321 Example: |
|
322 .sp |
|
323 .nf |
|
324 .ft C |
|
325 [domain] |
|
326 auto_postmaster = true |
|
327 delete_directory = false |
|
328 directory_mode = 504 |
|
329 force_deletion = false |
|
330 .ft P |
|
331 .fi |
|
332 .SS MAILDIR |
|
333 .sp |
|
334 The \fBmaildir\fP section is used to specify some default options for new |
|
335 created Maildirs and folders inside. |
|
336 .INDENT 0.0 |
|
337 .TP |
|
338 .B \fCfolders\fP |
|
339 \fIString\fP |
|
340 .sp |
|
341 A colon separated list of folder names, that should be created. If no |
|
342 folders should be created inside the Maildir, set the value of this |
|
343 option to a single colon (\(aq\fB:\fP\(aq). |
|
344 .sp |
|
345 If you want to create folders containing one or more subfolders, separate |
|
346 them with a single dot (\(aq\fB.\fP\(aq). |
|
347 .TP |
|
348 .B \fCname\fP |
|
349 \fIString\fP |
|
350 .sp |
|
351 Default name of the Maildir folder in users home directories. |
|
352 .UNINDENT |
|
353 .sp |
|
354 Example: |
|
355 .sp |
|
356 .nf |
|
357 .ft C |
|
358 [maildir] |
|
359 folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix |
|
360 name = Maildir |
|
361 .ft P |
|
362 .fi |
|
363 .SS MISC |
|
364 .sp |
|
365 The \fBmisc\fP section is used to define miscellaneous settings. |
|
366 .INDENT 0.0 |
|
367 .TP |
|
368 .B \fCbase_directory\fP |
|
369 \fIString\fP |
|
370 .sp |
|
371 All domain directories will be created inside this directory. |
|
372 .TP |
|
373 .B \fCpassword_scheme\fP |
|
374 \fIString\fP |
|
375 .sp |
|
376 Password scheme to use (see also: \fBdovecotpw \-l\fP). |
|
377 .TP |
|
378 .B \fCgid_mail\fP |
|
379 \fIInt\fP |
|
380 .sp |
|
381 Numeric group ID of group mail (\fImail_privileged_group\fP from |
|
382 \fIdovecot.conf\fP) |
|
383 .TP |
|
384 .B \fCtransport\fP |
|
385 \fIString\fP |
|
386 .sp |
|
387 Default transport for domains and accounts. For details see |
|
388 \fBtransport\fP(5). |
|
389 .TP |
|
390 .B \fCdovecot_version\fP |
|
391 \fIInt\fP |
|
392 .sp |
|
393 The concatenated major and minor version number of the currently used |
|
394 Dovecot version. (see: \fBdovecot \-\-version\fP). |
|
395 .sp |
|
396 When, for example, the command \fBdovecot \-\-version\fP prints \fI1.1.18\fP, set |
|
397 the value of this option to \fB11\fP. |
|
398 .UNINDENT |
|
399 .sp |
|
400 Example: |
|
401 .sp |
|
402 .nf |
|
403 .ft C |
|
404 [misc] |
|
405 base_directory = /srv/mail |
|
406 password_scheme = CRAM\-MD5 |
|
407 gid_mail = 8 |
|
408 transport = dovecot: |
|
409 dovecot_version = 11 |
|
410 .ft P |
|
411 .fi |
|
412 .SH FILES |
|
413 .INDENT 0.0 |
|
414 .TP |
|
415 .B \fI/root/vmm.cfg\fP |
|
416 .nf |
|
417 will be used when found. |
|
418 .fi |
|
419 .sp |
|
420 .TP |
|
421 .B \fI/usr/local/etc/vmm.cfg\fP |
|
422 .nf |
|
423 will be used when the above file doesn\(aqt exist. |
|
424 .fi |
|
425 .sp |
|
426 .TP |
|
427 .B \fI/etc/vmm.cfg\fP |
|
428 .nf |
|
429 will be used when none of the both above mentioned files exists. |
|
430 .fi |
|
431 .sp |
|
432 .UNINDENT |
|
433 .SH SEE ALSO |
549 .SH SEE ALSO |
434 .sp |
550 .BR doveadm\-pw (1), |
435 vmm(1), command line tool to manage email domains/accounts/aliases |
551 .BR dovecotpw (1), |
|
552 .BR postconf (1), |
|
553 .BR vmm (1), |
|
554 .BR transport (5) |
|
555 .\" ----------------------------------------------------------------------- |
|
556 .SH INTERNET RESOURCES |
|
557 .TP |
|
558 Wiki |
|
559 http://vmm.localdomain.org/ |
|
560 .TP |
|
561 Project site |
|
562 http://sf.net/projects/vmm/ |
|
563 .TP |
|
564 Bug tracker |
|
565 http://sf.net/tracker/?group_id=213727&atid=1026862 |
|
566 .\" ----------------------------------------------------------------------- |
436 .SH COPYING |
567 .SH COPYING |
437 .sp |
568 .B vmm |
438 vmm and its manual pages were written by Pascal Volk and are licensed under |
569 and its man pages were written by Pascal Volk |
439 the terms of the BSD License. |
570 .RI < neverseen@users.sourceforge.net > |
440 .SH AUTHOR |
571 and are licensed under the terms of the BSD License. |
441 Pascal Volk <neverseen@users.sourceforge.net> |
|
442 .\" Generated by docutils manpage writer. |
|
443 .\" |
|
444 . |
|