pmg.conf.5-opts.adoc

   1 .Section 'admin'
   2
   3 `advfilter`: `<boolean>` ('default =' `0`)::
   4
   5 Enable advanced filters for statistic.
   6 +
   7 If this is enabled, the receiver statistic are limited to active ones
   8 (receivers which also sent out mail in the 90 days before), and the contact
   9 statistic will not contain these active receivers.
  10
  11 `avast`: `<boolean>` ('default =' `0`)::
  12
  13 Use Avast Virus Scanner (/usr/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.
  14
  15 `clamav`: `<boolean>` ('default =' `1`)::
  16
  17 Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.
  18
  19 `custom_check`: `<boolean>` ('default =' `0`)::
  20
  21 Use Custom Check Script. The script has to take the defined arguments and can return Virus findings or a Spamscore.
  22
  23 `custom_check_path`: `^/([^/\0]+\/)+[^/\0]+$` ('default =' `/usr/local/bin/pmg-custom-check`)::
  24
  25 Absolute Path to the Custom Check Script
  26
  27 `dailyreport`: `<boolean>` ('default =' `1`)::
  28
  29 Send daily reports.
  30
  31 `demo`: `<boolean>` ('default =' `0`)::
  32
  33 Demo mode - do not start SMTP filter.
  34
  35 `dkim_selector`: `<string>` ::
  36
  37 Default DKIM selector
  38
  39 `dkim_sign`: `<boolean>` ('default =' `0`)::
  40
  41 DKIM sign outbound mails with the configured Selector.
  42
  43 `dkim_sign_all_mail`: `<boolean>` ('default =' `0`)::
  44
  45 DKIM sign all outgoing mails irrespective of the Envelope From domain.
  46
  47 `email`: `<string>` ('default =' `admin@domain.tld`)::
  48
  49 Administrator E-Mail address.
  50
  51 `http_proxy`: `http://.*` ::
  52
  53 Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
  54
  55 `statlifetime`: `<integer> (1 - N)` ('default =' `7`)::
  56
  57 User Statistics Lifetime (days)
  58
  59 .Section 'clamav'
  60
  61 `archiveblockencrypted`: `<boolean>` ('default =' `0`)::
  62
  63 Whether to mark encrypted archives and documents as heuristic virus match. A match does not necessarily result in an immediate block, it just raises the Spam Score by 'clamav_heuristic_score'.
  64
  65 `archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::
  66
  67 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.
  68
  69 `archivemaxrec`: `<integer> (1 - N)` ('default =' `5`)::
  70
  71 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.
  72
  73 `archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::
  74
  75 Files larger than this limit (in bytes) won't be scanned.
  76
  77 `dbmirror`: `<string>` ('default =' `database.clamav.net`)::
  78
  79 ClamAV database mirror server.
  80
  81 `maxcccount`: `<integer> (0 - N)` ('default =' `0`)::
  82
  83 This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.
  84
  85 `maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::
  86
  87 Sets the maximum amount of data (in bytes) to be scanned for each input file.
  88
  89 `safebrowsing`: `<boolean>` ('default =' `0`)::
  90
  91 Enables support for Google Safe Browsing. (deprecated option, will be ignored)
  92
  93 `scriptedupdates`: `<boolean>` ('default =' `1`)::
  94
  95 Enables ScriptedUpdates (incremental download of signatures)
  96
  97 .Section 'mail'
  98
  99 `banner`: `<string>` ('default =' `ESMTP Proxmox`)::
 100
 101 ESMTP banner.
 102
 103 `before_queue_filtering`: `<boolean>` ('default =' `0`)::
 104
 105 Enable before queue filtering by pmg-smtp-filter
 106
 107 `conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::
 108
 109 How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.
 110
 111 `conn_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
 112
 113 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.
 114
 115 `dnsbl_sites`: `<string>` ::
 116
 117 Optional list of DNS white/blacklist domains (postfix option `postscreen_dnsbl_sites`).
 118
 119 `dnsbl_threshold`: `<integer> (0 - N)` ('default =' `1`)::
 120
 121 The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (postfix option `postscreen_dnsbl_threshold`).
 122
 123 `dwarning`: `<integer> (0 - N)` ('default =' `4`)::
 124
 125 SMTP delay warning time (in hours). (postfix option `delay_warning_time`)
 126
 127 `ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
 128
 129 SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
 130
 131 `filter-timeout`: `<integer> (2 - 86400)` ('default =' `600`)::
 132
 133 Timeout for the processing of one mail (in seconds)  (postfix option `smtpd_proxy_timeout` and `lmtp_data_done_timeout`)
 134
 135 `greylist`: `<boolean>` ('default =' `1`)::
 136
 137 Use Greylisting for IPv4.
 138
 139 `greylist6`: `<boolean>` ('default =' `0`)::
 140
 141 Use Greylisting for IPv6.
 142
 143 `greylistmask4`: `<integer> (0 - 32)` ('default =' `24`)::
 144
 145 Netmask to apply for greylisting IPv4 hosts
 146
 147 `greylistmask6`: `<integer> (0 - 128)` ('default =' `64`)::
 148
 149 Netmask to apply for greylisting IPv6 hosts
 150
 151 `helotests`: `<boolean>` ('default =' `0`)::
 152
 153 Use SMTP HELO tests. (postfix option `smtpd_helo_restrictions`)
 154
 155 `hide_received`: `<boolean>` ('default =' `0`)::
 156
 157 Hide received header in outgoing mails.
 158
 159 `int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
 160
 161 SMTP port number for outgoing mail (trusted).
 162
 163 `max_filters`: `<integer> (3 - 40)` ('default =' `25`)::
 164
 165 Maximum number of pmg-smtp-filter processes.
 166
 167 `max_policy`: `<integer> (2 - 10)` ('default =' `5`)::
 168
 169 Maximum number of pmgpolicy processes.
 170
 171 `max_smtpd_in`: `<integer> (3 - 100)` ('default =' `100`)::
 172
 173 Maximum number of SMTP daemon processes (in).
 174
 175 `max_smtpd_out`: `<integer> (3 - 100)` ('default =' `100`)::
 176
 177 Maximum number of SMTP daemon processes (out).
 178
 179 `maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
 180
 181 Maximum email size. Larger mails are rejected. (postfix option `message_size_limit`)
 182
 183 `message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
 184
 185 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.
 186
 187 `ndr_on_block`: `<boolean>` ('default =' `0`)::
 188
 189 Send out NDR when mail gets blocked
 190
 191 `rejectunknown`: `<boolean>` ('default =' `0`)::
 192
 193 Reject unknown clients. (postfix option `reject_unknown_client_hostname`)
 194
 195 `rejectunknownsender`: `<boolean>` ('default =' `0`)::
 196
 197 Reject unknown senders. (postfix option `reject_unknown_sender_domain`)
 198
 199 `relay`: `<string>` ::
 200
 201 The default mail delivery transport (incoming mails).
 202
 203 `relaynomx`: `<boolean>` ('default =' `0`)::
 204
 205 Disable MX lookups for default relay (SMTP only, ignored for LMTP).
 206
 207 `relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
 208
 209 SMTP/LMTP port number for relay host.
 210
 211 `relayprotocol`: `<lmtp | smtp>` ('default =' `smtp`)::
 212
 213 Transport protocol for relay host.
 214
 215 `smarthost`: `<string>` ::
 216
 217 When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`)
 218
 219 `smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
 220
 221 SMTP port number for smarthost. (postfix option `default_transport`)
 222
 223 `smtputf8`: `<boolean>` ('default =' `1`)::
 224
 225 Enable SMTPUTF8 support in Postfix and detection for locally generated mail (postfix option `smtputf8_enable`)
 226
 227 `spf`: `<boolean>` ('default =' `1`)::
 228
 229 Use Sender Policy Framework.
 230
 231 `tls`: `<boolean>` ('default =' `0`)::
 232
 233 Enable TLS.
 234
 235 `tlsheader`: `<boolean>` ('default =' `0`)::
 236
 237 Add TLS received header.
 238
 239 `tlslog`: `<boolean>` ('default =' `0`)::
 240
 241 Enable TLS Logging.
 242
 243 `verifyreceivers`: `<450 | 550>` ::
 244
 245 Enable receiver verification. The value specifies the numerical reply code when the Postfix SMTP server rejects a recipient address. (postfix options `reject_unknown_recipient_domain`, `reject_unverified_recipient`, and `unverified_recipient_reject_code`)
 246
 247 .Section 'spam'
 248
 249 `bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::
 250
 251 Additional score for bounce mails.
 252
 253 `clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
 254
 255 Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...).
 256
 257 `extract_text`: `<boolean>` ('default =' `0`)::
 258
 259 Extract text from attachments (doc, pdf, rtf, images) and scan for spam.
 260
 261 `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
 262
 263 This option is used to specify which languages are considered OK for incoming mail.
 264
 265 `maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::
 266
 267 Maximum size of spam messages in bytes.
 268
 269 `rbl_checks`: `<boolean>` ('default =' `1`)::
 270
 271 Enable real time blacklists (RBL) checks.
 272
 273 `use_awl`: `<boolean>` ('default =' `0`)::
 274
 275 Use the Auto-Whitelist plugin.
 276
 277 `use_bayes`: `<boolean>` ('default =' `0`)::
 278
 279 Whether to use the naive-Bayesian-style classifier.
 280
 281 `use_razor`: `<boolean>` ('default =' `1`)::
 282
 283 Whether to use Razor2, if it is available.
 284
 285 `wl_bounce_relays`: `<string>` ::
 286
 287 Whitelist legitimate bounce relays.
 288
 289 .Section 'spamquar'
 290
 291 `allowhrefs`: `<boolean>` ('default =' `1`)::
 292
 293 Allow to view hyperlinks.
 294
 295 `authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::
 296
 297 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.
 298
 299 `hostname`: `<string>` ::
 300
 301 Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.
 302
 303 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
 304
 305 Quarantine life time (days)
 306
 307 `mailfrom`: `<string>` ::
 308
 309 Text for 'From' header in daily spam report mails.
 310
 311 `port`: `<integer> (1 - 65535)` ('default =' `8006`)::
 312
 313 Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.
 314
 315 `protocol`: `<http | https>` ('default =' `https`)::
 316
 317 Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.
 318
 319 `quarantinelink`: `<boolean>` ('default =' `0`)::
 320
 321 Enables user self-service for Quarantine Links. Caution: this is accessible without authentication
 322
 323 `reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::
 324
 325 Spam report style.
 326
 327 `viewimages`: `<boolean>` ('default =' `1`)::
 328
 329 Allow to view images.
 330
 331 .Section 'virusquar'
 332
 333 `allowhrefs`: `<boolean>` ('default =' `1`)::
 334
 335 Allow to view hyperlinks.
 336
 337 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
 338
 339 Quarantine life time (days)
 340
 341 `viewimages`: `<boolean>` ('default =' `1`)::
 342
 343 Allow to view images.
 344