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