|
1 ========= |
|
2 vmm.cfg |
|
3 ========= |
|
4 |
|
5 -------------------------- |
|
6 configuration file for vmm |
|
7 -------------------------- |
|
8 |
|
9 :Author: Pascal Volk <neverseen@users.sourceforge.net> |
|
10 :Date: 2010-01-18 |
|
11 :Version: vmm-0.6.0 |
|
12 :Manual group: vmm Manual |
|
13 :Manual section: 5 |
|
14 |
|
15 .. contents:: |
|
16 :backlinks: top |
|
17 :class: htmlout |
|
18 |
|
19 SYNOPSIS |
|
20 ======== |
|
21 vmm.cfg |
|
22 |
|
23 DESCRIPTION |
|
24 =========== |
|
25 **vmm**\(1) reads its configuration data from *vmm.cfg*. |
|
26 |
|
27 The configuration file is split into multiple sections. A section starts with |
|
28 the section name, enclosed in square brackets '**[**' and '**]**', followed |
|
29 by '*option* = *value*' pairs:: |
|
30 |
|
31 [database] |
|
32 host = 127.0.0.1 |
|
33 |
|
34 Whitespace around the '=' and at the end of a value is ignored. |
|
35 |
|
36 Empty lines and lines starting with '#' or ';' will be ignored. |
|
37 |
|
38 Each value uses one of the following data types: |
|
39 |
|
40 * *Boolean* to indicate if something is enabled/activated (true) or |
|
41 disabled/deactivated (false). |
|
42 |
|
43 | Accepted values for *true* are: **1**, **yes**, **true** and **on**. |
|
44 | Accepted values for *false* are: **0**, **no**, **false** and **off**. |
|
45 |
|
46 * *Int* an integer number, written without a fractional or decimal component. |
|
47 |
|
48 | For example **1**, **50** or **321** are integers. |
|
49 |
|
50 * *String* a sequence of characters and numbers. |
|
51 |
|
52 | For example '**word**', '**hello world**' or '**/usr/bin/strings**' |
|
53 |
|
54 SEARCH ORDER |
|
55 ------------- |
|
56 By default **vmm**\(1) looks for *vmm.cfg* in the following directories in the |
|
57 order listed: |
|
58 |
|
59 | */root* |
|
60 | */usr/local/etc* |
|
61 | */etc* |
|
62 |
|
63 The first configuration file found will be used. |
|
64 |
|
65 SECTIONS |
|
66 ======== |
|
67 This section describes all sections and their options of the *vmm.cfg*. |
|
68 |
|
69 ACCOUNT |
|
70 ------- |
|
71 The options in the section **account** are used to specify user account |
|
72 related settings. |
|
73 |
|
74 ``delete_directory`` : *Boolean* |
|
75 Determines the behavior of **vmm**\(1) when an account is deleted. If |
|
76 this option is set to *true* the user's home directory will be deleted |
|
77 recursively. |
|
78 |
|
79 ``directory_mode`` : *Int* |
|
80 Access mode for a user's home directory and all directories inside. |
|
81 The value has to be specified in decimal (base 10) notation. |
|
82 |
|
83 | For example: 'drwx------' -> octal 0700 -> decimal 448 |
|
84 |
|
85 ``disk_usage`` : *Boolean* |
|
86 Determines whether the disk usage of a user's Maildir always should be |
|
87 summarized, using **du**\(1), and displayed with account information. |
|
88 |
|
89 This could be slow on large Maildirs. When you have enabled quotas, |
|
90 **vmm**'s **userinfo** subcomammand will also display the current quota |
|
91 usage of the account. You may also use **userinfo**'s optional argument |
|
92 **du** or **full**, in order to display the current disk usage of an |
|
93 account. |
|
94 |
|
95 ``imap`` : *Boolean* |
|
96 Determines whether a newly created user can log in via IMAP. |
|
97 |
|
98 ``password_length`` : *Int* |
|
99 Determines how many characters and/or numbers should be used for random |
|
100 generated passwords. Any value less than 8 will be increased to 8. |
|
101 |
|
102 ``pop3`` : *Boolean* |
|
103 Determines whether a newly created user can log in via POP3. |
|
104 |
|
105 ``random_password`` : *Boolean* |
|
106 Determines whether **vmm** should generate a random password when no |
|
107 password was given for the **useradd** subcommand. If this option is |
|
108 set to *false* **vmm** will prompt you to enter a password for the new |
|
109 account. |
|
110 |
|
111 You can specify the password length of generated passwords with the |
|
112 **password_length** option. |
|
113 |
|
114 ``sieve`` : *Boolean* |
|
115 Determines whether a newly created user can log in via ManageSieve. |
|
116 |
|
117 ``smtp`` : *Boolean* |
|
118 Determines whether a newly created user can log in via SMTP (SMTP AUTH). |
|
119 |
|
120 Example:: |
|
121 |
|
122 [account] |
|
123 delete_directory = false |
|
124 directory_mode = 448 |
|
125 disk_usage = false |
|
126 random_password = true |
|
127 password_length = 10 |
|
128 smtp = true |
|
129 pop3 = true |
|
130 imap = true |
|
131 sieve = true |
|
132 |
|
133 BIN |
|
134 --- |
|
135 The **bin** section is used to specify some paths to some binaries required |
|
136 by **vmm**\(1). |
|
137 |
|
138 ``dovecotpw`` : *String* |
|
139 The absolute path to the dovecotpw binary. This binary is used to |
|
140 generate a password hash, if **misc.password_scheme** is set to one of |
|
141 'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. |
|
142 |
|
143 ``du`` : *String* |
|
144 The absolute path to **du**\(1). This binary is used to summarize the |
|
145 disk usage of a user's Maildir. |
|
146 |
|
147 ``postconf`` : *String* |
|
148 The absolute path to Postfix' **postconf**\(1). This binary is required |
|
149 when **vmm**\(1) has to check for some Postfix settings, e.g. |
|
150 `virtual_alias_expansion_limit`. |
|
151 |
|
152 Example:: |
|
153 |
|
154 [bin] |
|
155 dovecotpw = /usr/sbin/dovecotpw |
|
156 du = /usr/bin/du |
|
157 postconf = /usr/sbin/postconf |
|
158 |
|
159 CONFIG |
|
160 ------ |
|
161 The **config** section is an internal used control section. |
|
162 |
|
163 ``done`` : *Boolean* |
|
164 This option is set to *false* when **vmm**\(1) is installed for the first |
|
165 time. When you edit *vmm.cfg*, set this option to *true*. This option is |
|
166 also set to *true* when you configure **vmm**\(1) with the command **vmm |
|
167 configure**. |
|
168 |
|
169 If this option is set to *false*, **vmm**\(1) will start in the |
|
170 interactive configurations mode. |
|
171 |
|
172 Example:: |
|
173 |
|
174 [config] |
|
175 done = true |
|
176 |
|
177 DATABASE |
|
178 -------- |
|
179 The **database** section is used to specify some options required to |
|
180 connect to the database. |
|
181 |
|
182 ``host`` : *String* |
|
183 Hostname or IP address of the database server. |
|
184 |
|
185 ``name`` : *String* |
|
186 Name of the database. |
|
187 |
|
188 ``pass`` : *String* |
|
189 Database password. |
|
190 |
|
191 ``user`` : *String* |
|
192 Name of the database user. |
|
193 |
|
194 Example:: |
|
195 |
|
196 [database] |
|
197 host = localhost |
|
198 user = vmm |
|
199 pass = PY_SRJ}L/0p-oOk |
|
200 name = mailsys |
|
201 |
|
202 DOMAIN |
|
203 ------ |
|
204 The **domain** section specifies some domain related settings. |
|
205 |
|
206 ``auto_postmaster`` : *Boolean* |
|
207 Determines if **vmm**\(1) should create also a postmaster account when a |
|
208 new domain is created. |
|
209 |
|
210 ``delete_directory`` : *Boolean* |
|
211 Specifies whether the domain directory and all user directories inside |
|
212 should be deleted when a domain is deleted. |
|
213 |
|
214 ``directory_mode`` : *Int* |
|
215 Access mode for the domain directory in decimal (base 10) notation. |
|
216 |
|
217 | For example: 'drwxrwx---' -> octal 0770 -> decimal 504 |
|
218 |
|
219 ``force_deletion`` : *Boolean* |
|
220 Force deletion of accounts and aliases when a domain is deleted. |
|
221 |
|
222 Example:: |
|
223 |
|
224 [domain] |
|
225 auto_postmaster = true |
|
226 delete_directory = false |
|
227 directory_mode = 504 |
|
228 force_deletion = false |
|
229 |
|
230 MAILDIR |
|
231 ------- |
|
232 The **maildir** section is used to specify some default options for new |
|
233 created Maildirs and folders inside. |
|
234 |
|
235 ``folders`` : *String* |
|
236 A colon separated list of folder names, that should be created. If no |
|
237 folders should be created inside the Maildir, set the value of this |
|
238 option to a single colon ('**:**'). |
|
239 |
|
240 If you want to create folders containing one or more subfolders, separate |
|
241 them with a single dot ('**.**'). |
|
242 |
|
243 ``name`` : *String* |
|
244 Default name of the Maildir folder in users home directories. |
|
245 |
|
246 Example:: |
|
247 |
|
248 [maildir] |
|
249 folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix |
|
250 name = Maildir |
|
251 |
|
252 MISC |
|
253 ---- |
|
254 The **misc** section is used to define miscellaneous settings. |
|
255 |
|
256 ``base_directory`` : *String* |
|
257 All domain directories will be created inside this directory. |
|
258 |
|
259 ``password_scheme`` : *String* |
|
260 Password scheme to use (see also: **dovecotpw -l**). |
|
261 |
|
262 ``gid_mail`` : *Int* |
|
263 Numeric group ID of group mail (`mail_privileged_group` from |
|
264 *dovecot.conf*) |
|
265 |
|
266 ``transport`` : *String* |
|
267 Default transport for domains and accounts. For details see |
|
268 **transport**\(5). |
|
269 |
|
270 ``dovecot_version`` : *Int* |
|
271 The concatenated major and minor version number of the currently used |
|
272 Dovecot version. (see: **dovecot --version**). |
|
273 |
|
274 This option affects various database operations. There are some |
|
275 differences between Dovecot v1.1.x and v1.2.x. For example, when the |
|
276 command **dovecot --version** shows 1.1.18, set the value of this option |
|
277 to **11**. |
|
278 |
|
279 Example:: |
|
280 |
|
281 [misc] |
|
282 base_directory = /srv/mail |
|
283 password_scheme = CRAM-MD5 |
|
284 gid_mail = 8 |
|
285 transport = dovecot: |
|
286 dovecot_version = 11 |
|
287 |
|
288 FILES |
|
289 ===== |
|
290 */root/vmm.cfg* |
|
291 | will be used when found. |
|
292 */usr/local/etc/vmm.cfg* |
|
293 | will be used when the above file doesn't exist. |
|
294 */etc/vmm.cfg* |
|
295 | will be used when none of the both above mentioned files exists. |
|
296 |
|
297 SEE ALSO |
|
298 ======== |
|
299 vmm(1), command line tool to manage email domains/accounts/aliases |
|
300 |
|
301 COPYING |
|
302 ======= |
|
303 vmm and its manual pages were written by Pascal Volk and are licensed under |
|
304 the terms of the BSD License. |
|
305 |