]> git.proxmox.com Git - pmg-docs.git/blobdiff - pmgconfig.adoc
pmgconfig.adoc: add spam detector docs
[pmg-docs.git] / pmgconfig.adoc
index 67afc37b9b31690cd4f6d77a478357887179956a..e2f99639b3d33c9402db50b493bf067843130e2d 100644 (file)
@@ -97,6 +97,10 @@ Message delivery transport setup.
 
 GUI user configuration.
 
+`/etc/mail/spamassassin/custom.cf`::
+
+Custom {spamassassin} setup.
+
 
 Keys and Certificates
 ---------------------
@@ -217,19 +221,185 @@ ifndef::manvolnum[]
 image::images/screenshot/pmg-gui-system-options.png[]
 endif::manvolnum[]
 
+
+Those settings are saved to subsection 'admin' in `/etc/pmg/pmg.conf`,
+using the following configuration keys:
+
 include::pmg.admin-conf-opts.adoc[]
 
 
-Backup and Restore
-~~~~~~~~~~~~~~~~~~
+Mail Proxy Configuration
+------------------------
+
+Relaying
+~~~~~~~~
+
+ifndef::manvolnum[]
+image::images/screenshot/pmg-gui-mailproxy-relaying.png[]
+endif::manvolnum[]
+
+Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`,
+using the following configuration keys:
+
+include::pmg.mail-relaying-conf-opts.adoc[]
+
+Relay Domains
+~~~~~~~~~~~~~
+
+ifndef::manvolnum[]
+image::images/screenshot/pmg-gui-mailproxy-relaydomains.png[]
+endif::manvolnum[]
+
+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[]
+
+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[]
+
+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
+~~~~~~~~~~
+
+ifndef::manvolnum[]
+image::images/screenshot/pmg-gui-mailproxy-transports.png[]
+endif::manvolnum[]
+
+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
+~~~~~~~~
+
+ifndef::manvolnum[]
+image::images/screenshot/pmg-gui-mailproxy-networks.png[]
+endif::manvolnum[]
+
+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
+~~~
 
 ifndef::manvolnum[]
-image::images/screenshot/pmg-gui-backup.png[]
+image::images/screenshot/pmg-gui-mailproxy-tls.png[]
 endif::manvolnum[]
 
+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
+~~~~~~~~~
+
+ifndef::manvolnum[]
+image::images/screenshot/pmg-gui-mailproxy-whitelist.png[]
+endif::manvolnum[]
+
+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
+---------------------------
+
+{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
+----------------------------
+
 TODO
 
 
+User Management
+---------------
+
+TODO
+
 
 ifdef::manvolnum[]
 include::pmg-copyright.adoc[]