]> git.proxmox.com Git - pmg-docs.git/blob - pmg.conf.5-opts.adoc
bump version to 5.1-2
[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 `avast`: `<boolean>` ('default =' `0`)::
8
9 Use Avast Virus Scanner (/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.
10
11 `clamav`: `<boolean>` ('default =' `1`)::
12
13 Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.
14
15 `dailyreport`: `<boolean>` ('default =' `1`)::
16
17 Send daily reports.
18
19 `demo`: `<boolean>` ('default =' `0`)::
20
21 Demo mode - do not start SMTP filter.
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 `maxcccount`: `<integer> (0 - N)` ('default =' `0`)::
58
59 This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.
60
61 `maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::
62
63 Sets the maximum amount of data to be scanned for each input file.
64
65 `safebrowsing`: `<boolean>` ('default =' `1`)::
66
67 Enables support for Google Safe Browsing.
68
69 .Section 'mail'
70
71 `banner`: `<string>` ('default =' `ESMTP Proxmox`)::
72
73 ESMTP banner.
74
75 `conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::
76
77 How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.
78
79 `conn_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
80
81 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.
82
83 `dnsbl_sites`: `<string>` ::
84
85 Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
86
87 `dnsbl_threshold`: `<integer> (0 - N)` ('default =' `1`)::
88
89 The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (see postscreen_dnsbl_threshold parameter).
90
91 `dwarning`: `<integer> (0 - N)` ('default =' `4`)::
92
93 SMTP delay warning time (in hours).
94
95 `ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
96
97 SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
98
99 `greylist`: `<boolean>` ('default =' `1`)::
100
101 Use Greylisting.
102
103 `helotests`: `<boolean>` ('default =' `0`)::
104
105 Use SMTP HELO tests.
106
107 `hide_received`: `<boolean>` ('default =' `0`)::
108
109 Hide received header in outgoing mails.
110
111 `int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
112
113 SMTP port number for outgoing mail (trusted).
114
115 `max_filters`: `<integer> (3 - 40)` ('default =' `15`)::
116
117 Maximum number of pmg-smtp-filter processes.
118
119 `max_policy`: `<integer> (2 - 10)` ('default =' `5`)::
120
121 Maximum number of pmgpolicy processes.
122
123 `max_smtpd_in`: `<integer> (3 - 100)` ('default =' `99`)::
124
125 Maximum number of SMTP daemon processes (in).
126
127 `max_smtpd_out`: `<integer> (3 - 100)` ('default =' `99`)::
128
129 Maximum number of SMTP daemon processes (out).
130
131 `maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
132
133 Maximum email size. Larger mails are rejected.
134
135 `message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
136
137 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.
138
139 `rejectunknown`: `<boolean>` ('default =' `0`)::
140
141 Reject unknown clients.
142
143 `rejectunknownsender`: `<boolean>` ('default =' `0`)::
144
145 Reject unknown senders.
146
147 `relay`: `<string>` ::
148
149 The default mail delivery transport (incoming mails).
150
151 `relaynomx`: `<boolean>` ('default =' `0`)::
152
153 Disable MX lookups for default relay.
154
155 `relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
156
157 SMTP port number for relay host.
158
159 `smarthost`: `<string>` ::
160
161 When set, all outgoing mails are deliverd to the specified smarthost.
162
163 `smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
164
165 SMTP port number for smarthost.
166
167 `spf`: `<boolean>` ('default =' `1`)::
168
169 Use Sender Policy Framework.
170
171 `tls`: `<boolean>` ('default =' `0`)::
172
173 Enable TLS.
174
175 `tlsheader`: `<boolean>` ('default =' `0`)::
176
177 Add TLS received header.
178
179 `tlslog`: `<boolean>` ('default =' `0`)::
180
181 Enable TLS Logging.
182
183 `verifyreceivers`: `<450 | 550>` ::
184
185 Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
186
187 .Section 'spam'
188
189 `bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::
190
191 Additional score for bounce mails.
192
193 `clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
194
195 Score for ClamaAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).
196
197 `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
198
199 This option is used to specify which languages are considered OK for incoming mail.
200
201 `maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::
202
203 Maximum size of spam messages in bytes.
204
205 `rbl_checks`: `<boolean>` ('default =' `1`)::
206
207 Enable real time blacklists (RBL) checks.
208
209 `use_awl`: `<boolean>` ('default =' `1`)::
210
211 Use the Auto-Whitelist plugin.
212
213 `use_bayes`: `<boolean>` ('default =' `1`)::
214
215 Whether to use the naive-Bayesian-style classifier.
216
217 `use_razor`: `<boolean>` ('default =' `1`)::
218
219 Whether to use Razor2, if it is available.
220
221 `wl_bounce_relays`: `<string>` ::
222
223 Whitelist legitimate bounce relays.
224
225 .Section 'spamquar'
226
227 `allowhrefs`: `<boolean>` ('default =' `1`)::
228
229 Allow to view hyperlinks.
230
231 `authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::
232
233 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.
234
235 `hostname`: `<string>` ::
236
237 Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.
238
239 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
240
241 Quarantine life time (days)
242
243 `mailfrom`: `<string>` ::
244
245 Text for 'From' header in daily spam report mails.
246
247 `port`: `<integer> (1 - 65535)` ('default =' `8006`)::
248
249 Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.
250
251 `protocol`: `<http | https>` ('default =' `https`)::
252
253 Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.
254
255 `reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::
256
257 Spam report style.
258
259 `viewimages`: `<boolean>` ('default =' `1`)::
260
261 Allow to view images.
262
263 .Section 'virusquar'
264
265 `allowhrefs`: `<boolean>` ('default =' `1`)::
266
267 Allow to view hyperlinks.
268
269 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
270
271 Quarantine life time (days)
272
273 `viewimages`: `<boolean>` ('default =' `1`)::
274
275 Allow to view images.
276