pmgconfig.adoc: document mail-tls

[pmg-docs.git] / pmgconfig.adoc

diff --git a/pmgconfig.adoc b/pmgconfig.adoc
index 59403d0ff6f79c3046b5b5aac5d62a9b1909b7c1..b98cfeab37ba57df425f26b1769508447823422e 100644 (file)
--- a/pmgconfig.adoc
+++ b/pmgconfig.adoc
@@ -49,6 +49,18 @@ changes to `/etc/network/interfaces.new`. When you reboot, we rename
 the file to `/etc/network/interfaces`, so any changes gets activated
 on the next reboot.
 
+`/etc/resolv.conf`::
+
+DNS search domain and nameserver setup.
+
+`/etc/hostname`::
+
+The system's host name.
+
+`/etc/hosts`::
+
+Static table lookup for hostnames.
+
 `/etc/pmg/pmg.conf`::
 
 Stores common administration options, i.e. the spam and mail proxy setup.
@@ -85,6 +97,10 @@ Message delivery transport setup.
 
 GUI user configuration.
 
+`/etc/mail/spamassassin/custom.cf`::
+
+Custom {spamassassin} setup.
+
 
 Keys and Certificates
 ---------------------
@@ -113,7 +129,46 @@ Key and certificate (combined) to encrypt mail traffic (TLS).
 Service Configuration Templates
 -------------------------------
 
-{pmg}
+{pmg} uses various services to implement mail filtering, for example
+the {postfix} Mail Transport Agent (MTA), the {clamav} antivirus
+engine and the Apache {spamassassin} project. Those services use
+separate configuration files, so we need to rewrite those files when
+configuration is changed.
+
+We use a template based approach to generate those files. The {tts} is
+a well known, fast and flexible template processing system. You can
+find the default templates in `/var/lib/pmg/templates/`. Please do not
+modify them directly, because your modification would get lost on the
+next update. Instead, copy them to `/etc/pmg/templates/`, then apply
+your changes there.
+
+Templates can access any configuration setting, and you can use the
+`pmgconfig dump` command to get a list of all variable names:
+
+----
+# pmgconfig dump
+...
+dns.domain = yourdomain.tld
+dns.hostname = pmg
+ipconfig.int_ip = 192.168.2.127
+pmg.admin.advfilter = 1
+...
+----
+
+The same tool is used to force regeneration of all template based
+configuration files. You need to run that after modifying a template,
+or when you directly edit configuration files
+
+----
+# pmgconfig sync --restart 1
+----
+
+Above commands also restarts services if underlying configuration
+files are changed. Please note that this is automatically done when
+you change the configuration using the GUI or API.
+
+NOTE: Modified templates from `/etc/pmg/templates/` are automatically
+synced from the master node to all cluster members.
 
 
 System Configuration
@@ -166,19 +221,125 @@ 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-backup.png[]
+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[]
 
 TODO
 
 
+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[]
+
+TODO
+
+
+Networks
+~~~~~~~~
+
+ifndef::manvolnum[]
+image::images/screenshot/pmg-gui-mailproxy-networks.png[]
+endif::manvolnum[]
+
+TODO
+
+
+TLS
+~~~
+
+ifndef::manvolnum[]
+image::images/screenshot/pmg-gui-mailproxy-tls.png[]
+endif::manvolnum[]
+
+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[]
+
+TODO
+
+
+Spam Detector Configuration
+---------------------------
+
+TODO
+
+
+Virus Detector Configuration
+----------------------------
+
+TODO
+
+
+User Management
+---------------
+
+TODO
+
 
 ifdef::manvolnum[]
 include::pmg-copyright.adoc[]