]> git.proxmox.com Git - pmg-docs.git/blobdiff - pmg.conf.5-opts.adoc
bump version to 5.1-3
[pmg-docs.git] / pmg.conf.5-opts.adoc
index ee6ecce8e002855fda793628f56505787fd55009..b8862ee99b1c99ed73fa26198d02fc3f98a26884 100644 (file)
@@ -1,36 +1,36 @@
 .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 (/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>` ::
+`dailyreport`: `<boolean>` ('default =' `1`)::
 
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+Send daily reports.
 
-`proxypassword`: `<string>` ::
+`demo`: `<boolean>` ('default =' `0`)::
 
-HTTP proxy password.
+Demo mode - do not start SMTP filter.
 
-`proxyport`: `<integer> (1 - N)` ('default =' `8080`)::
+`email`: `<string>` ('default =' `admin@domain.tld`)::
 
-HTTP proxy port.
+Administrator E-Mail address.
 
-`proxyserver`: `<string>` ::
+`http_proxy`: `http://.*` ::
 
-HTTP proxy server address.
+Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
 
-`proxyuser`: `<string>` ::
+`statlifetime`: `<integer> (1 - N)` ('default =' `7`)::
 
-HTTP proxy user name.
+User Statistics Lifetime (days)
 
 .Section 'clamav'
 
@@ -54,14 +54,6 @@ Files larger than this limit won't be scanned.
 
 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.
@@ -70,6 +62,10 @@ This option sets the lowest number of Credit Card or Social Security numbers fou
 
 Sets the maximum amount of data to be scanned for each input file.
 
+`safebrowsing`: `<boolean>` ('default =' `1`)::
+
+Enables support for Google Safe Browsing.
+
 .Section 'mail'
 
 `banner`: `<string>` ('default =' `ESMTP Proxmox`)::
@@ -84,22 +80,22 @@ 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 =' `25`)::
+
+SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
+
 `greylist`: `<boolean>` ('default =' `1`)::
 
 Use Greylisting.
@@ -112,6 +108,10 @@ Use SMTP HELO tests.
 
 Hide received header in outgoing mails.
 
+`int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
+
+SMTP port number for outgoing mail (trusted).
+
 `max_filters`: `<integer> (3 - 40)` ('default =' `15`)::
 
 Maximum number of pmg-smtp-filter processes.
@@ -156,21 +156,33 @@ Disable MX lookups for default relay.
 
 SMTP port number 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.
 
 `tls`: `<boolean>` ('default =' `0`)::
 
-Use TLS.
+Enable TLS.
+
+`tlsheader`: `<boolean>` ('default =' `0`)::
+
+Add TLS received header.
 
-`use_rbl`: `<boolean>` ('default =' `1`)::
+`tlslog`: `<boolean>` ('default =' `0`)::
 
-Use Realtime Blacklists.
+Enable TLS Logging.
 
-`verifyreceivers`: `<integer> (0 - 599)` ('default =' `0`)::
+`verifyreceivers`: `<450 | 550>` ::
 
-Enable receiver verification. The value (if greater than 0) spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address (450 or 550).
+Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
 
 .Section 'spam'
 
@@ -178,19 +190,15 @@ Enable receiver verification. The value (if greater than 0) spefifies the numeri
 
 Additional score for bounce mails.
 
-`delete`: `<string>` ::
+`clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
 
-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.
+Score for ClamaAV heuristics (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.
 
@@ -206,10 +214,6 @@ Use the Auto-Whitelist plugin.
 
 Whether to use the naive-Bayesian-style classifier.
 
-`use_ocr`: `<boolean>` ('default =' `0`)::
-
-Enable OCR to scan pictures.
-
 `use_razor`: `<boolean>` ('default =' `1`)::
 
 Whether to use Razor2, if it is available.
@@ -218,3 +222,55 @@ Whether to use Razor2, if it is available.
 
 Whitelist legitimate bounce relays.
 
+.Section 'spamquar'
+
+`allowhrefs`: `<boolean>` ('default =' `1`)::
+
+Allow to view hyperlinks.
+
+`authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::
+
+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.
+
+`hostname`: `<string>` ::
+
+Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.
+
+`lifetime`: `<integer> (1 - N)` ('default =' `7`)::
+
+Quarantine life time (days)
+
+`mailfrom`: `<string>` ::
+
+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.
+
+`viewimages`: `<boolean>` ('default =' `1`)::
+
+Allow to view images.
+
+.Section 'virusquar'
+
+`allowhrefs`: `<boolean>` ('default =' `1`)::
+
+Allow to view hyperlinks.
+
+`lifetime`: `<integer> (1 - N)` ('default =' `7`)::
+
+Quarantine life time (days)
+
+`viewimages`: `<boolean>` ('default =' `1`)::
+
+Allow to view images.
+