]> git.proxmox.com Git - pmg-docs.git/blobdiff - pmg.conf.5-opts.adoc
rephrase greylisting section in pmg-intro
[pmg-docs.git] / pmg.conf.5-opts.adoc
index baa18f0c689b8ab10ceef10da1e9a7dc79c01968..3cee85578ac4fd1a3980d132b68c0c6b6c28ef71 100644 (file)
@@ -1,40 +1,52 @@
 .Section 'admin'
 
-`dailyreport`: `<boolean>` ('default =' `1`)::
+`advfilter`: `<boolean>` ('default =' `1`)::
 
-Send daily reports.
+Use advanced filters for statistic.
 
-`delete`: `<string>` ::
+`avast`: `<boolean>` ('default =' `0`)::
 
-A list of settings you want to delete.
+Use Avast Virus Scanner (/usr/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.
 
-`demo`: `<boolean>` ('default =' `0`)::
+`clamav`: `<boolean>` ('default =' `1`)::
 
-Demo mode - do not start SMTP filter.
+Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.
 
-`digest`: `<string>` ::
+`custom_check`: `<boolean>` ('default =' `0`)::
 
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+Use Custom Check Script. The script has to take the defined arguments and can return Virus findings or a Spamscore.
 
-`email`: `<string>` ('default =' `admin@domain.tld`)::
+`custom_check_path`: `^/([^/\0]+\/)+[^/\0]+$` ('default =' `/usr/local/bin/pmg-custom-check`)::
 
-Administrator E-Mail address.
+Absolute Path to the Custom Check Script
+
+`dailyreport`: `<boolean>` ('default =' `1`)::
+
+Send daily reports.
+
+`demo`: `<boolean>` ('default =' `0`)::
+
+Demo mode - do not start SMTP filter.
+
+`dkim_selector`: `<string>` ::
 
-`proxypassword`: `<string>` ::
+Default DKIM selector
 
-HTTP proxy password.
+`dkim_sign`: `<boolean>` ('default =' `0`)::
 
-`proxyport`: `<integer> (1 - N)` ('default =' `8080`)::
+DKIM sign outbound mails with the configured Selector.
 
-HTTP proxy port.
+`dkim_sign_all_mail`: `<boolean>` ('default =' `0`)::
 
-`proxyserver`: `<string>` ::
+DKIM sign all outgoing mails irrespective of the Envelope From domain.
 
-HTTP proxy server address.
+`email`: `<string>` ('default =' `admin@domain.tld`)::
 
-`proxyuser`: `<string>` ::
+Administrator E-Mail address.
 
-HTTP proxy user name.
+`http_proxy`: `http://.*` ::
+
+Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
 
 `statlifetime`: `<integer> (1 - N)` ('default =' `7`)::
 
@@ -44,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`)::
 
@@ -56,27 +68,19 @@ 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`)::
 
 ClamAV database mirror server.
 
-`delete`: `<string>` ::
-
-A list of settings you want to delete.
-
-`digest`: `<string>` ::
-
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
-
 `maxcccount`: `<integer> (0 - N)` ('default =' `0`)::
 
 This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.
 
 `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 =' `1`)::
 
@@ -88,6 +92,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.
@@ -96,23 +104,19 @@ How many simultaneous connections any client is allowed to make to this service.
 
 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.
 
-`delete`: `<string>` ::
-
-A list of settings you want to delete.
-
-`digest`: `<string>` ::
-
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
-
 `dnsbl_sites`: `<string>` ::
 
 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).
 
-`ext_port`: `<integer> (1 - 65535)` ('default =' `26`)::
+`ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
 
 SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
 
@@ -128,11 +132,11 @@ Use SMTP HELO tests.
 
 Hide received header in outgoing mails.
 
-`int_port`: `<integer> (1 - 65535)` ('default =' `25`)::
+`int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
 
 SMTP port number for outgoing mail (trusted).
 
-`max_filters`: `<integer> (3 - 40)` ('default =' `15`)::
+`max_filters`: `<integer> (3 - 40)` ('default =' `35`)::
 
 Maximum number of pmg-smtp-filter processes.
 
@@ -140,11 +144,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).
 
@@ -156,6 +160,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.
@@ -170,16 +178,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.
@@ -196,10 +212,6 @@ Add TLS received header.
 
 Enable TLS Logging.
 
-`use_rbl`: `<boolean>` ('default =' `1`)::
-
-Use Realtime Blacklists.
-
 `verifyreceivers`: `<450 | 550>` ::
 
 Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
@@ -210,19 +222,15 @@ Enable receiver verification. The value spefifies the numerical reply code when
 
 Additional score for bounce mails.
 
-`delete`: `<string>` ::
-
-A list of settings you want to delete.
+`clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
 
-`digest`: `<string>` ::
-
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+Score for ClamAV heuristics (Encrypted Archives/Documents, Google Safe Browsing database, PhishingScanURLs, ...).
 
 `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
 
 This option is used to specify which languages are considered OK for incoming mail.
 
-`maxspamsize`: `<integer> (64 - N)` ('default =' `204800`)::
+`maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::
 
 Maximum size of spam messages in bytes.
 
@@ -256,17 +264,9 @@ Allow to view hyperlinks.
 
 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.
 
-`delete`: `<string>` ::
-
-A list of settings you want to delete.
-
-`digest`: `<string>` ::
-
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
-
 `hostname`: `<string>` ::
 
-Quarantine Host. Usefule if you run a Cluster and want users to connect to a specific host.
+Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.
 
 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
 
@@ -276,6 +276,14 @@ Quarantine life time (days)
 
 Text for 'From' header in daily spam report mails.
 
+`port`: `<integer> (1 - 65535)` ('default =' `8006`)::
+
+Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.
+
+`protocol`: `<http | https>` ('default =' `https`)::
+
+Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.
+
 `reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::
 
 Spam report style.
@@ -290,14 +298,6 @@ Allow to view images.
 
 Allow to view hyperlinks.
 
-`delete`: `<string>` ::
-
-A list of settings you want to delete.
-
-`digest`: `<string>` ::
-
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
-
 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
 
 Quarantine life time (days)