pmgconfig.adoc: add spam detector docs

[pmg-docs.git] / pmgconfig.adoc

diff --git a/pmgconfig.adoc b/pmgconfig.adoc
index 238dfabd3c3d7c86eaebf29026a6cf7dc429bacb..e2f99639b3d33c9402db50b493bf067843130e2d 100644 (file)
--- a/pmgconfig.adoc
+++ b/pmgconfig.adoc
@@ -246,32 +246,39 @@ include::pmg.mail-relaying-conf-opts.adoc[]
 Relay Domains
 ~~~~~~~~~~~~~
 
-
 ifndef::manvolnum[]
 image::images/screenshot/pmg-gui-mailproxy-relaydomains.png[]
 endif::manvolnum[]
 
-TODO
+List of relayed mail domains, i.e. what destination domains this
+system will relay mail to. The system will reject incoming mails to
+other domains.
+
 
 Ports
 ~~~~~
 
-
 ifndef::manvolnum[]
 image::images/screenshot/pmg-gui-mailproxy-ports.png[]
 endif::manvolnum[]
 
-TODO
+Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`,
+using the following configuration keys:
+
+include::pmg.mail-ports-conf-opts.adoc[]
+
 
 Options
 ~~~~~~~
 
-
 ifndef::manvolnum[]
 image::images/screenshot/pmg-gui-mailproxy-options.png[]
 endif::manvolnum[]
 
-TODO
+Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`,
+using the following configuration keys:
+
+include::pmg.mail-options-conf-opts.adoc[]
 
 
 Transports
@@ -281,7 +288,13 @@ ifndef::manvolnum[]
 image::images/screenshot/pmg-gui-mailproxy-transports.png[]
 endif::manvolnum[]
 
-TODO
+You can use {pmg} to send e-mails to different internal
+e-mail servers. For example you can send e-mails addressed to
+domain.com to your first e-mail server, and e-mails addressed to
+subdomain.domain.com to a second one.
+
+You can add the IP addresses, hostname and SMTP ports and mail domains (or
+just single email addresses) of your additional e-mail servers.
 
 
 Networks
@@ -291,7 +304,11 @@ ifndef::manvolnum[]
 image::images/screenshot/pmg-gui-mailproxy-networks.png[]
 endif::manvolnum[]
 
-TODO
+You can add additional internal (trusted) IP networks or hosts.
+All hosts in this list are allowed to relay.
+
+NOTE: Hosts in the same subnet with Proxmox can relay by default and
+it’s not needed to add them in this list.
 
 
 TLS
@@ -301,7 +318,33 @@ ifndef::manvolnum[]
 image::images/screenshot/pmg-gui-mailproxy-tls.png[]
 endif::manvolnum[]
 
-TODO
+Transport Layer Security (TLS) provides certificate-based
+authentication and encrypted sessions. An encrypted session protects
+the information that is transmitted with SMTP mail. When you activate
+TLS, {pmg} automatically generates a new self signed
+certificate for you (`/etc/pmg/pmg-tls.pem`).
+
+{pmg} uses opportunistic TLS encryption. The SMTP transaction is
+encrypted if the 'STARTTLS' ESMTP feature is supported by the remote
+server. Otherwise, messages are sent in the clear.
+
+Enable TLS logging::
+
+To get additional information about SMTP TLS activity you can enable
+TLS logging. That way information about TLS sessions and used
+certificate’s is logged via syslog.
+
+Add TLS received header::
+
+Set this option to include information about the protocol and cipher
+used as well as the client and issuer CommonName into the "Received:"
+message header.
+
+Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`,
+using the following configuration keys:
+
+include::pmg.mail-tls-conf-opts.adoc[]
+
 
 Whitelist
 ~~~~~~~~~
@@ -310,13 +353,40 @@ ifndef::manvolnum[]
 image::images/screenshot/pmg-gui-mailproxy-whitelist.png[]
 endif::manvolnum[]
 
-TODO
+All SMTP checks are disabled for those entries (e. g. Greylisting,
+SPF, RBL, ...)
+
+NOTE: If you use a backup MX server (e.g. your ISP offers this service
+for you) you should always add those servers here.
 
 
 Spam Detector Configuration
 ---------------------------
 
-TODO
+{pmg} uses a wide variety of local and network tests to identify spam
+signatures. This makes it harder for spammers to identify one aspect
+which they can craft their messages to work around the spam filter.
+
+Every single e-mail will be analyzed and gets a spam score
+assigned. The system attempts to optimize the efficiency of the rules
+that are run in terms of minimizing the number of false positives and
+false negatives.
+
+include::pmg.spam-conf-opts.adoc[]
+
+
+Spam Quarantine Configuration
+-----------------------------
+
+Proxmox analyses all incoming e-mail messages and decides for each
+e-mail if its ham or spam (or virus). Good e-mails are delivered to
+the inbox and spam messages can be moved into the spam quarantine.
+
+The system can be configured to send daily reports to inform users
+about the personal spam messages received the last day. That report is
+only sent if there are new messages in the quarantine.
+
+include::pmg.spamquar-conf-opts.adoc[]
 
 
 Virus Detector Configuration