]> git.proxmox.com Git - pmg-docs.git/blobdiff - pmg.conf.5-opts.adoc
pmgqm: add example for systemd.timer edit
[pmg-docs.git] / pmg.conf.5-opts.adoc
index 0e2ea3a60b60b949d15fdc3bcacbb3f8791024cd..e55a8b37523072d3016b257a8a2410b08cd739eb 100644 (file)
@@ -4,6 +4,22 @@
 
 Use advanced filters for statistic.
 
+`avast`: `<boolean>` ('default =' `0`)::
+
+Use Avast Virus Scanner (/usr/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.
+
+`clamav`: `<boolean>` ('default =' `1`)::
+
+Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.
+
+`custom_check`: `<boolean>` ('default =' `0`)::
+
+Use Custom Check Script. The script has to take the defined arguments and can return Virus findings or a Spamscore.
+
+`custom_check_path`: `^/([^/\0]+\/)+[^/\0]+$` ('default =' `/usr/local/bin/pmg-custom-check`)::
+
+Absolute Path to the Custom Check Script
+
 `dailyreport`: `<boolean>` ('default =' `1`)::
 
 Send daily reports.
@@ -12,6 +28,18 @@ Send daily reports.
 
 Demo mode - do not start SMTP filter.
 
+`dkim_selector`: `<string>` ::
+
+Default DKIM selector
+
+`dkim_sign`: `<boolean>` ('default =' `0`)::
+
+DKIM sign outbound mails with the configured Selector.
+
+`dkim_sign_all_mail`: `<boolean>` ('default =' `0`)::
+
+DKIM sign all outgoing mails irrespective of the Envelope From domain.
+
 `email`: `<string>` ('default =' `admin@domain.tld`)::
 
 Administrator E-Mail address.
@@ -28,7 +56,7 @@ User Statistics Lifetime (days)
 
 `archiveblockencrypted`: `<boolean>` ('default =' `0`)::
 
-Wether to block encrypted archives. Mark encrypted archives as viruses.
+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'.
 
 `archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::
 
@@ -40,7 +68,7 @@ Nested archives are scanned recursively, e.g. if a ZIP archive contains a TAR  f
 
 `archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::
 
-Files larger than this limit won't be scanned.
+Files larger than this limit (in bytes) won't be scanned.
 
 `dbmirror`: `<string>` ('default =' `database.clamav.net`)::
 
@@ -52,11 +80,15 @@ This option sets the lowest number of Credit Card or Social Security numbers fou
 
 `maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::
 
-Sets the maximum amount of data to be scanned for each input file.
+Sets the maximum amount of data (in bytes) to be scanned for each input file.
+
+`safebrowsing`: `<boolean>` ('default =' `0`)::
 
-`safebrowsing`: `<boolean>` ('default =' `1`)::
+Enables support for Google Safe Browsing. (deprecated option, will be ignored)
 
-Enables support for Google Safe Browsing.
+`scriptedupdates`: `<boolean>` ('default =' `1`)::
+
+Enables ScriptedUpdates (incremental download of signatures)
 
 .Section 'mail'
 
@@ -64,6 +96,10 @@ Enables support for Google Safe Browsing.
 
 ESMTP banner.
 
+`before_queue_filtering`: `<boolean>` ('default =' `0`)::
+
+Enable before queue filtering by pmg-smtp-filter
+
 `conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::
 
 How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.
@@ -76,6 +112,10 @@ The maximal number of connection attempts any client is allowed to make to this
 
 Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
 
+`dnsbl_threshold`: `<integer> (0 - N)` ('default =' `1`)::
+
+The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (see postscreen_dnsbl_threshold parameter).
+
 `dwarning`: `<integer> (0 - N)` ('default =' `4`)::
 
 SMTP delay warning time (in hours).
@@ -86,7 +126,19 @@ SMTP port number for incoming mail (untrusted). This must be a different number
 
 `greylist`: `<boolean>` ('default =' `1`)::
 
-Use Greylisting.
+Use Greylisting for IPv4.
+
+`greylist6`: `<boolean>` ('default =' `0`)::
+
+Use Greylisting for IPv6.
+
+`greylistmask4`: `<integer> (0 - 32)` ('default =' `24`)::
+
+Netmask to apply for greylisting IPv4 hosts
+
+`greylistmask6`: `<integer> (0 - 128)` ('default =' `64`)::
+
+Netmask to apply for greylisting IPv6 hosts
 
 `helotests`: `<boolean>` ('default =' `0`)::
 
@@ -100,7 +152,7 @@ Hide received header in outgoing mails.
 
 SMTP port number for outgoing mail (trusted).
 
-`max_filters`: `<integer> (3 - 40)` ('default =' `15`)::
+`max_filters`: `<integer> (3 - 40)` ('default =' `38`)::
 
 Maximum number of pmg-smtp-filter processes.
 
@@ -108,11 +160,11 @@ Maximum number of pmg-smtp-filter processes.
 
 Maximum number of pmgpolicy processes.
 
-`max_smtpd_in`: `<integer> (3 - 100)` ('default =' `99`)::
+`max_smtpd_in`: `<integer> (3 - 100)` ('default =' `100`)::
 
 Maximum number of SMTP daemon processes (in).
 
-`max_smtpd_out`: `<integer> (3 - 100)` ('default =' `99`)::
+`max_smtpd_out`: `<integer> (3 - 100)` ('default =' `100`)::
 
 Maximum number of SMTP daemon processes (out).
 
@@ -124,6 +176,10 @@ Maximum email size. Larger mails are rejected.
 
 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.
 
+`ndr_on_block`: `<boolean>` ('default =' `0`)::
+
+Send out NDR when mail gets blocked
+
 `rejectunknown`: `<boolean>` ('default =' `0`)::
 
 Reject unknown clients.
@@ -138,16 +194,24 @@ The default mail delivery transport (incoming mails).
 
 `relaynomx`: `<boolean>` ('default =' `0`)::
 
-Disable MX lookups for default relay.
+Disable MX lookups for default relay (SMTP only, ignored for LMTP).
 
 `relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
 
-SMTP port number for relay host.
+SMTP/LMTP port number for relay host.
+
+`relayprotocol`: `<lmtp | smtp>` ('default =' `smtp`)::
+
+Transport protocol for relay host.
 
 `smarthost`: `<string>` ::
 
 When set, all outgoing mails are deliverd to the specified smarthost.
 
+`smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
+
+SMTP port number for smarthost.
+
 `spf`: `<boolean>` ('default =' `1`)::
 
 Use Sender Policy Framework.
@@ -176,7 +240,7 @@ Additional score for bounce mails.
 
 `clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
 
-Score for ClamaAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).
+Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...).
 
 `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
 
@@ -236,6 +300,10 @@ Quarantine Port. Useful if you have a reverse proxy or port forwarding for the w
 
 Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.
 
+`quarantinelink`: `<boolean>` ('default =' `0`)::
+
+Enables user self-service for Quarantine Links. Caution: this is accessible without authentication
+
 `reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::
 
 Spam report style.