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