equal
deleted
inserted
replaced
1 .\" $Id$ |
1 .\" $Id$ |
2 .TH vmm.cfg 5 "28. April 2008" "Pascal Volk" |
2 .TH vmm.cfg 5 "30. April 2008" "Pascal Volk" |
3 .SH NAME |
3 .SH NAME |
4 vmm.cfg \- configuration file for vmm |
4 vmm.cfg \- configuration file for vmm |
5 .SH SYNOPSIS |
5 .SH SYNOPSIS |
6 /usr/local/etc/vmm.cfg |
6 /usr/local/etc/vmm.cfg |
7 .SH DESCRIPTION |
7 .SH DESCRIPTION |
8 \fBvmm\fR(1) reads configuration data form \fI/usr/local/etc/vmm.cfg\fP. |
8 \fBvmm\fR(1) reads configuration data from \fI/usr/local/etc/vmm.cfg\fP. |
9 .br |
9 .br |
10 The configuration file is split in multiple sections. Sections begins with the |
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), |
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). |
12 followed by \'option=value' pairs (e.g. \fBhost = 127.0.0.1\fP). |
13 .br |
13 .br |
14 Whitespace around the '=' and at the end of a value is ignored. |
14 Whitespace around the '=' and at the end of a value is ignored. |
15 .PP |
15 .PP |
17 .PP |
17 .PP |
18 Each value uses one of the following data types: |
18 Each value uses one of the following data types: |
19 .IP \(bu |
19 .IP \(bu |
20 .I Boolean |
20 .I Boolean |
21 to indicate if something is enabled/activated (true) or disabled/deactivated |
21 to indicate if something is enabled/activated (true) or disabled/deactivated |
22 (false). Accepted values for \fBtrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and |
22 (false). |
|
23 .br |
|
24 Accepted values for \fBtrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and |
23 \fBon\fP. |
25 \fBon\fP. |
24 .br |
26 .br |
25 Accepted values for \fBfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and |
27 Accepted values for \fBfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and |
26 \fBoff\fP. |
28 \fBoff\fP. |
27 .IP \(bu |
29 .IP \(bu |
32 .I String |
34 .I String |
33 a sequence of characters and numbers. For example '\fBword\fP', '\fBhello |
35 a sequence of characters and numbers. For example '\fBword\fP', '\fBhello |
34 world\fP', or '\fB/usr/bin/strings\fP' |
36 world\fP', or '\fB/usr/bin/strings\fP' |
35 .\" ----- |
37 .\" ----- |
36 .SH DATABASE SECTION |
38 .SH DATABASE SECTION |
37 This section contains options required for the database connection. |
39 The \fBdatabase\fP section is used to specify some options required to |
|
40 connect to the database. |
38 .TP |
41 .TP |
39 \fBhost\fP (\fIString\fP) |
42 \fBhost\fP (\fIString\fP) |
40 Hostname or IP address of the database server. |
43 Hostname or IP address of the database server. |
41 .TP |
44 .TP |
42 \fBuser\fP (\fIString\fP) |
45 \fBuser\fP (\fIString\fP) |
58 pass = T~_:L4OYyl]TU?) |
61 pass = T~_:L4OYyl]TU?) |
59 .br |
62 .br |
60 name = mailsys |
63 name = mailsys |
61 .\" ----- |
64 .\" ----- |
62 .SH MAILDIR SECTION |
65 .SH MAILDIR SECTION |
63 This section defines some options for the Maildirs. |
66 The \fBmaildir\fP section is used to specify some options for the Maildirs. |
64 .TP |
67 .TP |
65 \fBfolder\fP (\fIString\fP) |
68 \fBfolder\fP (\fIString\fP) |
66 Default name of the maildir folder in users home directory. |
69 Default name of the maildir folder in users home directory. |
67 .TP |
70 .TP |
68 \fBmode\fP (\fIInt\fP) |
71 \fBmode\fP (\fIInt\fP) |
86 diskusage = false |
89 diskusage = false |
87 .br |
90 .br |
88 delete = false |
91 delete = false |
89 .\" ----- |
92 .\" ----- |
90 .SH SERVICES SECTION |
93 .SH SERVICES SECTION |
91 This section specifies the default restrictions for each account. |
94 The \fBservices\fP section is used to specify the default restrictions for |
|
95 all accounts. |
92 .TP |
96 .TP |
93 \fBsmtp\fP (\fIBoolean\fP) |
97 \fBsmtp\fP (\fIBoolean\fP) |
94 Decides if users can login via smtp by default. |
98 Decides if users can login via smtp by default. |
95 .TP |
99 .TP |
96 \fBpop3\fP (\fIBoolean\fP) |
100 \fBpop3\fP (\fIBoolean\fP) |
112 imap = false |
116 imap = false |
113 .br |
117 .br |
114 managesieve = false |
118 managesieve = false |
115 .\" ----- |
119 .\" ----- |
116 .SH DOMDIR SECTION |
120 .SH DOMDIR SECTION |
117 This section defines some options for the directories of the domains. |
121 The \fBdomdir\fP section is used to specify options for the directories of the |
|
122 domains. |
118 .TP |
123 .TP |
119 \fBbase\fP (\fIString\fP) |
124 \fBbase\fP (\fIString\fP) |
120 All domain directories will be created inside this directory. |
125 All domain directories will be created inside this directory. |
121 .TP |
126 .TP |
122 \fBmode\fP (\fIInt\fP) |
127 \fBmode\fP (\fIInt\fP) |
135 mode = 504 |
140 mode = 504 |
136 .br |
141 .br |
137 delete = false |
142 delete = false |
138 .\" ----- |
143 .\" ----- |
139 .SH BIN SECTION |
144 .SH BIN SECTION |
140 This section contains some paths to some binaries. |
145 The \fBbin\fP section is used to specify some paths to some binaries required |
|
146 by \fBvmm\fP. |
141 .TP |
147 .TP |
142 \fBdovecotpw\fP (\fIString\fP) |
148 \fBdovecotpw\fP (\fIString\fP) |
143 The absolute path to the dovecotpw binary. This binary is used to generate a |
149 The absolute path to the dovecotpw binary. This binary is used to generate a |
144 password hash, if the \fIpasswdscheme\fP is one of 'SMD5', 'SSHA', 'CRAM-MD5', |
150 password hash, if the \fIpasswdscheme\fP is one of 'SMD5', 'SSHA', 'CRAM-MD5', |
145 \'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. |
151 \'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. |
154 dovecotpw = /usr/sbin/dovecotpw |
160 dovecotpw = /usr/sbin/dovecotpw |
155 .br |
161 .br |
156 du = /usr/bin/du |
162 du = /usr/bin/du |
157 .\" ----- |
163 .\" ----- |
158 .SH MISC SECTION |
164 .SH MISC SECTION |
159 This sections defines miscellaneous settings. |
165 The \fBmisc\fP section is used to define miscellaneous settings. |
160 .TP |
166 .TP |
161 \fBpasswdscheme\fP (\fIString\fP) |
167 \fBpasswdscheme\fP (\fIString\fP) |
162 Password scheme to use (see also: dovecotpw -l) |
168 Password scheme to use (see also: dovecotpw -l) |
163 .TP |
169 .TP |
164 \fBgid_mail\fP (\fIInt\fP) |
170 \fBgid_mail\fP (\fIInt\fP) |
180 forcedel = false |
186 forcedel = false |
181 .br |
187 .br |
182 transport = dovecot: |
188 transport = dovecot: |
183 .\" ----- |
189 .\" ----- |
184 .SH CONFIG SECTION |
190 .SH CONFIG SECTION |
185 This section is a internal control section. |
191 The \fBconfig\fP section is a internal used control section. |
186 .TP |
192 .TP |
187 \fBdone\fP (\fIBoolean\fP) |
193 \fBdone\fP (\fIBoolean\fP) |
188 This option is set to \fIfalse\fP when \fBvmm\fP is installed for the first |
194 This option is set to \fIfalse\fP when \fBvmm\fP is installed for the first |
189 time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is |
195 time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is |
190 also set to \fItrue\fP when you configure vmm with the command \fBvmm |
196 also set to \fItrue\fP when you configure vmm with the command \fBvmm |
199 done = true |
205 done = true |
200 .\" ----- |
206 .\" ----- |
201 .SH FILES |
207 .SH FILES |
202 /usr/local/etc/vmm.cfg |
208 /usr/local/etc/vmm.cfg |
203 .SH SEE ALSO |
209 .SH SEE ALSO |
204 vmm(1), commandline tool to manage email domains/accounts/aliases |
210 vmm(1), command line tool to manage email domains/accounts/aliases |
205 .SH AUTHOR |
211 .SH AUTHOR |
206 \fBvmm\fP and its man pages were written by Pascal Volk |
212 \fBvmm\fP and its man pages were written by Pascal Volk |
207 <\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. |
213 <\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. |