]> git.proxmox.com Git - pmg-docs.git/blob - pmg.conf.5-opts.adoc
bump version to 5.0-14
[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 `dwarning`: `<integer> (0 - N)` ('default =' `4`)::
88
89 SMTP delay warning time (in hours).
90
91 `ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
92
93 SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
94
95 `greylist`: `<boolean>` ('default =' `1`)::
96
97 Use Greylisting.
98
99 `helotests`: `<boolean>` ('default =' `0`)::
100
101 Use SMTP HELO tests.
102
103 `hide_received`: `<boolean>` ('default =' `0`)::
104
105 Hide received header in outgoing mails.
106
107 `int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
108
109 SMTP port number for outgoing mail (trusted).
110
111 `max_filters`: `<integer> (3 - 40)` ('default =' `15`)::
112
113 Maximum number of pmg-smtp-filter processes.
114
115 `max_policy`: `<integer> (2 - 10)` ('default =' `5`)::
116
117 Maximum number of pmgpolicy processes.
118
119 `max_smtpd_in`: `<integer> (3 - 100)` ('default =' `99`)::
120
121 Maximum number of SMTP daemon processes (in).
122
123 `max_smtpd_out`: `<integer> (3 - 100)` ('default =' `99`)::
124
125 Maximum number of SMTP daemon processes (out).
126
127 `maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
128
129 Maximum email size. Larger mails are rejected.
130
131 `message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
132
133 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.
134
135 `rejectunknown`: `<boolean>` ('default =' `0`)::
136
137 Reject unknown clients.
138
139 `rejectunknownsender`: `<boolean>` ('default =' `0`)::
140
141 Reject unknown senders.
142
143 `relay`: `<string>` ::
144
145 The default mail delivery transport (incoming mails).
146
147 `relaynomx`: `<boolean>` ('default =' `0`)::
148
149 Disable MX lookups for default relay.
150
151 `relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
152
153 SMTP port number for relay host.
154
155 `smarthost`: `<string>` ::
156
157 When set, all outgoing mails are deliverd to the specified smarthost.
158
159 `spf`: `<boolean>` ('default =' `1`)::
160
161 Use Sender Policy Framework.
162
163 `tls`: `<boolean>` ('default =' `0`)::
164
165 Enable TLS.
166
167 `tlsheader`: `<boolean>` ('default =' `0`)::
168
169 Add TLS received header.
170
171 `tlslog`: `<boolean>` ('default =' `0`)::
172
173 Enable TLS Logging.
174
175 `verifyreceivers`: `<450 | 550>` ::
176
177 Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
178
179 .Section 'spam'
180
181 `bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::
182
183 Additional score for bounce mails.
184
185 `clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
186
187 Score for ClamaAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).
188
189 `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
190
191 This option is used to specify which languages are considered OK for incoming mail.
192
193 `maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::
194
195 Maximum size of spam messages in bytes.
196
197 `rbl_checks`: `<boolean>` ('default =' `1`)::
198
199 Enable real time blacklists (RBL) checks.
200
201 `use_awl`: `<boolean>` ('default =' `1`)::
202
203 Use the Auto-Whitelist plugin.
204
205 `use_bayes`: `<boolean>` ('default =' `1`)::
206
207 Whether to use the naive-Bayesian-style classifier.
208
209 `use_razor`: `<boolean>` ('default =' `1`)::
210
211 Whether to use Razor2, if it is available.
212
213 `wl_bounce_relays`: `<string>` ::
214
215 Whitelist legitimate bounce relays.
216
217 .Section 'spamquar'
218
219 `allowhrefs`: `<boolean>` ('default =' `1`)::
220
221 Allow to view hyperlinks.
222
223 `authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::
224
225 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.
226
227 `hostname`: `<string>` ::
228
229 Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.
230
231 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
232
233 Quarantine life time (days)
234
235 `mailfrom`: `<string>` ::
236
237 Text for 'From' header in daily spam report mails.
238
239 `port`: `<integer> (1 - 65535)` ('default =' `8006`)::
240
241 Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.
242
243 `protocol`: `<http | https>` ('default =' `https`)::
244
245 Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.
246
247 `reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::
248
249 Spam report style.
250
251 `viewimages`: `<boolean>` ('default =' `1`)::
252
253 Allow to view images.
254
255 .Section 'virusquar'
256
257 `allowhrefs`: `<boolean>` ('default =' `1`)::
258
259 Allow to view hyperlinks.
260
261 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
262
263 Quarantine life time (days)
264
265 `viewimages`: `<boolean>` ('default =' `1`)::
266
267 Allow to view images.
268