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 `email`: `<string>` ('default =' `admin@domain.tld`)::
  32
  33 Administrator E-Mail address.
  34
  35 `http_proxy`: `http://.*` ::
  36
  37 Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
  38
  39 `statlifetime`: `<integer> (1 - N)` ('default =' `7`)::
  40
  41 User Statistics Lifetime (days)
  42
  43 .Section 'clamav'
  44
  45 `archiveblockencrypted`: `<boolean>` ('default =' `0`)::
  46
  47 Whether to block encrypted archives and documents. Mark encrypted archives and documents as viruses.
  48
  49 `archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::
  50
  51 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.
  52
  53 `archivemaxrec`: `<integer> (1 - N)` ('default =' `5`)::
  54
  55 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.
  56
  57 `archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::
  58
  59 Files larger than this limit won't be scanned.
  60
  61 `dbmirror`: `<string>` ('default =' `database.clamav.net`)::
  62
  63 ClamAV database mirror server.
  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 `dnsbl_sites`: `<string>` ::
  92
  93 Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
  94
  95 `dnsbl_threshold`: `<integer> (0 - N)` ('default =' `1`)::
  96
  97 The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (see postscreen_dnsbl_threshold parameter).
  98
  99 `dwarning`: `<integer> (0 - N)` ('default =' `4`)::
 100
 101 SMTP delay warning time (in hours).
 102
 103 `ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
 104
 105 SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
 106
 107 `greylist`: `<boolean>` ('default =' `1`)::
 108
 109 Use Greylisting.
 110
 111 `helotests`: `<boolean>` ('default =' `0`)::
 112
 113 Use SMTP HELO tests.
 114
 115 `hide_received`: `<boolean>` ('default =' `0`)::
 116
 117 Hide received header in outgoing mails.
 118
 119 `int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
 120
 121 SMTP port number for outgoing mail (trusted).
 122
 123 `max_filters`: `<integer> (3 - 40)` ('default =' `35`)::
 124
 125 Maximum number of pmg-smtp-filter processes.
 126
 127 `max_policy`: `<integer> (2 - 10)` ('default =' `5`)::
 128
 129 Maximum number of pmgpolicy processes.
 130
 131 `max_smtpd_in`: `<integer> (3 - 100)` ('default =' `100`)::
 132
 133 Maximum number of SMTP daemon processes (in).
 134
 135 `max_smtpd_out`: `<integer> (3 - 100)` ('default =' `100`)::
 136
 137 Maximum number of SMTP daemon processes (out).
 138
 139 `maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
 140
 141 Maximum email size. Larger mails are rejected.
 142
 143 `message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
 144
 145 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.
 146
 147 `rejectunknown`: `<boolean>` ('default =' `0`)::
 148
 149 Reject unknown clients.
 150
 151 `rejectunknownsender`: `<boolean>` ('default =' `0`)::
 152
 153 Reject unknown senders.
 154
 155 `relay`: `<string>` ::
 156
 157 The default mail delivery transport (incoming mails).
 158
 159 `relaynomx`: `<boolean>` ('default =' `0`)::
 160
 161 Disable MX lookups for default relay.
 162
 163 `relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
 164
 165 SMTP port number for relay host.
 166
 167 `smarthost`: `<string>` ::
 168
 169 When set, all outgoing mails are deliverd to the specified smarthost.
 170
 171 `smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
 172
 173 SMTP port number for 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 `verifyreceivers`: `<450 | 550>` ::
 192
 193 Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
 194
 195 .Section 'spam'
 196
 197 `bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::
 198
 199 Additional score for bounce mails.
 200
 201 `clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
 202
 203 Score for ClamAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).
 204
 205 `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
 206
 207 This option is used to specify which languages are considered OK for incoming mail.
 208
 209 `maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::
 210
 211 Maximum size of spam messages in bytes.
 212
 213 `rbl_checks`: `<boolean>` ('default =' `1`)::
 214
 215 Enable real time blacklists (RBL) checks.
 216
 217 `use_awl`: `<boolean>` ('default =' `1`)::
 218
 219 Use the Auto-Whitelist plugin.
 220
 221 `use_bayes`: `<boolean>` ('default =' `1`)::
 222
 223 Whether to use the naive-Bayesian-style classifier.
 224
 225 `use_razor`: `<boolean>` ('default =' `1`)::
 226
 227 Whether to use Razor2, if it is available.
 228
 229 `wl_bounce_relays`: `<string>` ::
 230
 231 Whitelist legitimate bounce relays.
 232
 233 .Section 'spamquar'
 234
 235 `allowhrefs`: `<boolean>` ('default =' `1`)::
 236
 237 Allow to view hyperlinks.
 238
 239 `authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::
 240
 241 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.
 242
 243 `hostname`: `<string>` ::
 244
 245 Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.
 246
 247 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
 248
 249 Quarantine life time (days)
 250
 251 `mailfrom`: `<string>` ::
 252
 253 Text for 'From' header in daily spam report mails.
 254
 255 `port`: `<integer> (1 - 65535)` ('default =' `8006`)::
 256
 257 Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.
 258
 259 `protocol`: `<http | https>` ('default =' `https`)::
 260
 261 Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.
 262
 263 `reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::
 264
 265 Spam report style.
 266
 267 `viewimages`: `<boolean>` ('default =' `1`)::
 268
 269 Allow to view images.
 270
 271 .Section 'virusquar'
 272
 273 `allowhrefs`: `<boolean>` ('default =' `1`)::
 274
 275 Allow to view hyperlinks.
 276
 277 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
 278
 279 Quarantine life time (days)
 280
 281 `viewimages`: `<boolean>` ('default =' `1`)::
 282
 283 Allow to view images.
 284