]> git.proxmox.com Git - pmg-docs.git/blob - pmg.conf.5-opts.adoc
add pmgreport, update generated docs
[pmg-docs.git] / pmg.conf.5-opts.adoc
1 .Section 'admin'
2
3 `dailyreport`: `<boolean>` ('default =' `1`)::
4
5 Send daily reports.
6
7 `delete`: `<string>` ::
8
9 A list of settings you want to delete.
10
11 `demo`: `<boolean>` ('default =' `0`)::
12
13 Demo mode - do not start SMTP filter.
14
15 `digest`: `<string>` ::
16
17 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
18
19 `email`: `<string>` ('default =' `admin@domain.tld`)::
20
21 Administrator E-Mail address.
22
23 `proxypassword`: `<string>` ::
24
25 HTTP proxy password.
26
27 `proxyport`: `<integer> (1 - N)` ('default =' `8080`)::
28
29 HTTP proxy port.
30
31 `proxyserver`: `<string>` ::
32
33 HTTP proxy server address.
34
35 `proxyuser`: `<string>` ::
36
37 HTTP proxy user name.
38
39 `statlifetime`: `<integer> (1 - N)` ('default =' `7`)::
40
41 User Statistics Lifetime (days)
42
43 .Section 'clamav'
44
45 `archiveblockencrypted`: `<boolean>` ('default =' `0`)::
46
47 Wether to block encrypted archives. Mark encrypted archives as viruses.
48
49 `archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::
50
51 Number of files to be scanned within an archive, a document, or any other kind of container. Warning: disabling this limit or setting it too high may result in severe damage to the system.
52
53 `archivemaxrec`: `<integer> (1 - N)` ('default =' `5`)::
54
55 Nested archives are scanned recursively, e.g. if a ZIP archive contains a TAR file, all files within it will also be scanned. This options specifies how deeply the process should be continued. Warning: setting this limit too high may result in severe damage to the system.
56
57 `archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::
58
59 Files larger than this limit won't be scanned.
60
61 `dbmirror`: `<string>` ('default =' `database.clamav.net`)::
62
63 ClamAV database mirror server.
64
65 `delete`: `<string>` ::
66
67 A list of settings you want to delete.
68
69 `digest`: `<string>` ::
70
71 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
72
73 `maxcccount`: `<integer> (0 - N)` ('default =' `0`)::
74
75 This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.
76
77 `maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::
78
79 Sets the maximum amount of data to be scanned for each input file.
80
81 `safebrowsing`: `<boolean>` ('default =' `1`)::
82
83 Enables support for Google Safe Browsing.
84
85 .Section 'mail'
86
87 `banner`: `<string>` ('default =' `ESMTP Proxmox`)::
88
89 ESMTP banner.
90
91 `conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::
92
93 How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.
94
95 `conn_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
96
97 The maximal number of connection attempts any client is allowed to make to this service per minute. To disable this feature, specify a limit of 0.
98
99 `delete`: `<string>` ::
100
101 A list of settings you want to delete.
102
103 `digest`: `<string>` ::
104
105 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
106
107 `dnsbl_sites`: `<string>` ::
108
109 Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
110
111 `dwarning`: `<integer> (0 - N)` ('default =' `4`)::
112
113 SMTP delay warning time (in hours).
114
115 `ext_port`: `<integer> (1 - 65535)` ('default =' `26`)::
116
117 SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
118
119 `greylist`: `<boolean>` ('default =' `1`)::
120
121 Use Greylisting.
122
123 `helotests`: `<boolean>` ('default =' `0`)::
124
125 Use SMTP HELO tests.
126
127 `hide_received`: `<boolean>` ('default =' `0`)::
128
129 Hide received header in outgoing mails.
130
131 `int_port`: `<integer> (1 - 65535)` ('default =' `25`)::
132
133 SMTP port number for outgoing mail (trusted).
134
135 `max_filters`: `<integer> (3 - 40)` ('default =' `15`)::
136
137 Maximum number of pmg-smtp-filter processes.
138
139 `max_policy`: `<integer> (2 - 10)` ('default =' `5`)::
140
141 Maximum number of pmgpolicy processes.
142
143 `max_smtpd_in`: `<integer> (3 - 100)` ('default =' `99`)::
144
145 Maximum number of SMTP daemon processes (in).
146
147 `max_smtpd_out`: `<integer> (3 - 100)` ('default =' `99`)::
148
149 Maximum number of SMTP daemon processes (out).
150
151 `maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
152
153 Maximum email size. Larger mails are rejected.
154
155 `message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
156
157 The maximal number of message delivery requests that any client is allowed to make to this service per minute.To disable this feature, specify a limit of 0.
158
159 `rejectunknown`: `<boolean>` ('default =' `0`)::
160
161 Reject unknown clients.
162
163 `rejectunknownsender`: `<boolean>` ('default =' `0`)::
164
165 Reject unknown senders.
166
167 `relay`: `<string>` ::
168
169 The default mail delivery transport (incoming mails).
170
171 `relaynomx`: `<boolean>` ('default =' `0`)::
172
173 Disable MX lookups for default relay.
174
175 `relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
176
177 SMTP port number for relay host.
178
179 `smarthost`: `<string>` ::
180
181 When set, all outgoing mails are deliverd to the specified smarthost.
182
183 `spf`: `<boolean>` ('default =' `1`)::
184
185 Use Sender Policy Framework.
186
187 `tls`: `<boolean>` ('default =' `0`)::
188
189 Enable TLS.
190
191 `tlsheader`: `<boolean>` ('default =' `0`)::
192
193 Add TLS received header.
194
195 `tlslog`: `<boolean>` ('default =' `0`)::
196
197 Enable TLS Logging.
198
199 `use_rbl`: `<boolean>` ('default =' `1`)::
200
201 Use Realtime Blacklists.
202
203 `verifyreceivers`: `<450 | 550>` ::
204
205 Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
206
207 .Section 'spam'
208
209 `bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::
210
211 Additional score for bounce mails.
212
213 `delete`: `<string>` ::
214
215 A list of settings you want to delete.
216
217 `digest`: `<string>` ::
218
219 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
220
221 `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
222
223 This option is used to specify which languages are considered OK for incoming mail.
224
225 `maxspamsize`: `<integer> (64 - N)` ('default =' `204800`)::
226
227 Maximum size of spam messages in bytes.
228
229 `rbl_checks`: `<boolean>` ('default =' `1`)::
230
231 Enable real time blacklists (RBL) checks.
232
233 `use_awl`: `<boolean>` ('default =' `1`)::
234
235 Use the Auto-Whitelist plugin.
236
237 `use_bayes`: `<boolean>` ('default =' `1`)::
238
239 Whether to use the naive-Bayesian-style classifier.
240
241 `use_razor`: `<boolean>` ('default =' `1`)::
242
243 Whether to use Razor2, if it is available.
244
245 `wl_bounce_relays`: `<string>` ::
246
247 Whitelist legitimate bounce relays.
248
249 .Section 'spamquar'
250
251 `allowhrefs`: `<boolean>` ('default =' `1`)::
252
253 Allow to view hyperlinks.
254
255 `authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::
256
257 Authentication mode to access the quarantine interface. Mode 'ticket' allows login using tickets sent with the daily spam report. Mode 'ldap' requires to login using an LDAP account. Finally, mode 'ldapticket' allows both ways.
258
259 `delete`: `<string>` ::
260
261 A list of settings you want to delete.
262
263 `digest`: `<string>` ::
264
265 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
266
267 `hostname`: `<string>` ::
268
269 Quarantine Host. Usefule if you run a Cluster and want users to connect to a specific host.
270
271 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
272
273 Quarantine life time (days)
274
275 `mailfrom`: `<string>` ::
276
277 Text for 'From' header in daily spam report mails.
278
279 `reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::
280
281 Spam report style.
282
283 `viewimages`: `<boolean>` ('default =' `1`)::
284
285 Allow to view images.
286
287 .Section 'virusquar'
288
289 `allowhrefs`: `<boolean>` ('default =' `1`)::
290
291 Allow to view hyperlinks.
292
293 `delete`: `<string>` ::
294
295 A list of settings you want to delete.
296
297 `digest`: `<string>` ::
298
299 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
300
301 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
302
303 Quarantine life time (days)
304
305 `viewimages`: `<boolean>` ('default =' `1`)::
306
307 Allow to view images.
308