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