|
1 .\" $Id$ |
|
2 .TH vmm.cfg 5 "11. Jun 2008" "Pascal Volk" |
|
3 .SH NAME |
|
4 vmm.cfg \- configuration file for vmm |
|
5 .SH SYNOPSIS |
|
6 /usr/local/etc/vmm.cfg |
|
7 .SH DESCRIPTION |
|
8 \fBvmm\fR(1) reads configuration data from \fI/usr/local/etc/vmm.cfg\fP. |
|
9 .br |
|
10 The configuration file is split in multiple sections. A section starts with the |
|
11 section name, enclosed in square brackets '[' and ']' (e.g. \fB[database]\fP), |
|
12 followed by \'option=value' pairs (e.g. \fBhost = 127.0.0.1\fP). |
|
13 .br |
|
14 Whitespace around the '=' and at the end of a value is ignored. |
|
15 .PP |
|
16 Empty lines and lines starting with '#' or ';' will be ignored. |
|
17 .PP |
|
18 Each value uses one of the following data types: |
|
19 .IP \(bu |
|
20 .I Boolean |
|
21 to indicate if something is enabled/activated (true) or disabled/deactivated |
|
22 (false). |
|
23 .br |
|
24 Accepted values for \fBtrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and \fBon\fP. |
|
25 .br |
|
26 Accepted values for \fBfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and |
|
27 \fBoff\fP. |
|
28 .IP \(bu |
|
29 .I Int |
|
30 an integer number, written without a fractional or decimal component. For |
|
31 example \fB1\fP, \fB50\fP or \fB321\fP are integers. |
|
32 .IP \(bu |
|
33 .I String |
|
34 a sequence of characters and numbers. For example '\fBword\fP', '\fBhello |
|
35 world\fP', or '\fB/usr/bin/strings\fP' |
|
36 .\" ----- |
|
37 .SH DATABASE SECTION |
|
38 The \fBdatabase\fP section is used to specify some options required to |
|
39 connect to the database. |
|
40 .TP |
|
41 \fBhost\fP (\fIString\fP) |
|
42 Hostname or IP address of the database server. |
|
43 .TP |
|
44 \fBuser\fP (\fIString\fP) |
|
45 Name of the database user. |
|
46 .TP |
|
47 \fBpass\fP (\fIString\fP) |
|
48 Database password |
|
49 .TP |
|
50 \fBname\fP (\fIString\fP) |
|
51 Name of the database. |
|
52 .TP |
|
53 \fBExample\fP: |
|
54 [database] |
|
55 .br |
|
56 host = localhost |
|
57 .br |
|
58 user = vmm |
|
59 .br |
|
60 pass = T~_:L4OYyl]TU?) |
|
61 .br |
|
62 name = mailsys |
|
63 .\" ----- |
|
64 .SH MAILDIR SECTION |
|
65 The \fBmaildir\fP section is used to specify some options for the Maildirs. |
|
66 .TP |
|
67 \fBfolder\fP (\fIString\fP) |
|
68 Default name of the maildir folder in users home directory. |
|
69 .TP |
|
70 \fBmode\fP (\fIInt\fP) |
|
71 Access mode for the maildir in decimal (base 10) notation. For example: |
|
72 \'drwx------' -> octal 0700 -> decimal 448 |
|
73 .TP |
|
74 \fBdiskusage\fP (\fIBoolean\fP) |
|
75 Decides if the disk usage of users maildir always should be summarized and |
|
76 displayed with account information. |
|
77 .TP |
|
78 \fBdelete\fP (\fIBoolean\fP) |
|
79 Decides if the maildir should be deleted recursive when the account is deleted. |
|
80 .TP |
|
81 \fBExample\fP: |
|
82 [maildir] |
|
83 .br |
|
84 folder = Maildir |
|
85 .br |
|
86 mode = 448 |
|
87 .br |
|
88 diskusage = false |
|
89 .br |
|
90 delete = false |
|
91 .\" ----- |
|
92 .SH SERVICES SECTION |
|
93 The \fBservices\fP section is used to specify the default restrictions for |
|
94 all accounts. |
|
95 .TP |
|
96 \fBsmtp\fP (\fIBoolean\fP) |
|
97 Decides if users can login via smtp by default. |
|
98 .TP |
|
99 \fBpop3\fP (\fIBoolean\fP) |
|
100 Decides if users can login via pop3 by default. |
|
101 .TP |
|
102 \fBimap\fP (\fIBoolean\fP) |
|
103 Decides if users can login via imap by default. |
|
104 .TP |
|
105 \fBmanagesieve\fP (\fIBoolean\fP) |
|
106 Decides if users can login via managesieve by default. |
|
107 .TP |
|
108 \fBExample\fP: |
|
109 [services] |
|
110 .br |
|
111 smtp = true |
|
112 .br |
|
113 pop3 = true |
|
114 .br |
|
115 imap = false |
|
116 .br |
|
117 managesieve = false |
|
118 .\" ----- |
|
119 .SH DOMDIR SECTION |
|
120 The \fBdomdir\fP section is used to specify options for the directories of the |
|
121 domains. |
|
122 .TP |
|
123 \fBbase\fP (\fIString\fP) |
|
124 All domain directories will be created inside this directory. |
|
125 .TP |
|
126 \fBmode\fP (\fIInt\fP) |
|
127 Access mode for the domain directory in decimal (base 10) notation. For |
|
128 example: 'drwxrwx---' -> octal 0770 -> decimal 504 |
|
129 .TP |
|
130 \fBdelete\fP (\fIBoolean\fP) |
|
131 Decides if the domain directory and all user directories inside should be |
|
132 deleted when a domain is deleted. |
|
133 .TP |
|
134 \fBExample\fP: |
|
135 [domdir] |
|
136 .br |
|
137 base = /srv/mail |
|
138 .br |
|
139 mode = 504 |
|
140 .br |
|
141 delete = false |
|
142 .\" ----- |
|
143 .SH BIN SECTION |
|
144 The \fBbin\fP section is used to specify some paths to some binaries required |
|
145 by \fBvmm\fP. |
|
146 .TP |
|
147 \fBdovecotpw\fP (\fIString\fP) |
|
148 The absolute path to the dovecotpw binary. This binary is used to generate a |
|
149 password hash, if the \fIpasswdscheme\fP is one of 'SMD5', 'SSHA', 'CRAM-MD5', |
|
150 \'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. |
|
151 .TP |
|
152 \fBdu\fP (\fIString\fP) |
|
153 The absolute path to \fBdu\fR(1). This binary is used to summarize the disk |
|
154 usage of a maildir. |
|
155 .TP |
|
156 \fBExample\fP: |
|
157 [bin] |
|
158 .br |
|
159 dovecotpw = /usr/sbin/dovecotpw |
|
160 .br |
|
161 du = /usr/bin/du |
|
162 .\" ----- |
|
163 .SH MISC SECTION |
|
164 The \fBmisc\fP section is used to define miscellaneous settings. |
|
165 .TP |
|
166 \fBpasswdscheme\fP (\fIString\fP) |
|
167 Password scheme to use (see also: dovecotpw -l) |
|
168 .TP |
|
169 \fBgid_mail\fP (\fIInt\fP) |
|
170 Numeric group ID of group mail (mail_privileged_group from dovecot.conf) |
|
171 .TP |
|
172 \fBforcedel\fP (\fIBoolean\fP) |
|
173 Force deletion of accounts and aliases when a domain is deleted. |
|
174 .TP |
|
175 \fBtransport\fP (\fIString\fP) |
|
176 Default transport for domains and accounts. |
|
177 .TP |
|
178 \fBExample\fP: |
|
179 [misc] |
|
180 .br |
|
181 passwdscheme = CRAM-MD5 |
|
182 .br |
|
183 gid_mail = 8 |
|
184 .br |
|
185 forcedel = false |
|
186 .br |
|
187 transport = dovecot: |
|
188 .\" ----- |
|
189 .SH CONFIG SECTION |
|
190 The \fBconfig\fP section is a internal used control section. |
|
191 .TP |
|
192 \fBdone\fP (\fIBoolean\fP) |
|
193 This option is set to \fIfalse\fP when \fBvmm\fP is installed for the first |
|
194 time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is |
|
195 also set to \fItrue\fP when you configure vmm with the command \fBvmm |
|
196 configure\fP. |
|
197 .br |
|
198 If this option is set to \fIfalse\fP, \fBvmm\fP will start in the interactive |
|
199 configurations mode. |
|
200 .TP |
|
201 \fBExample\fP: |
|
202 [config] |
|
203 .br |
|
204 done = true |
|
205 .\" ----- |
|
206 .SH FILES |
|
207 /usr/local/etc/vmm.cfg |
|
208 .SH SEE ALSO |
|
209 vmm(1), command line tool to manage email domains/accounts/aliases |
|
210 .SH AUTHOR |
|
211 \fBvmm\fP and its man pages were written by Pascal Volk |
|
212 <\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. |