Stoiko Ivanov [Mon, 15 Jun 2020 10:20:11 +0000 (12:20 +0200)]
add documentation for RAR support
While clamav and our stack do support handling RAR archives, both need
packages from `non-free` installed in order to work.
Adding the 2 packages to the appropriate places would still
require a reference to the sources.list entry of how to get the `non-free`
archive area enabled and that way we can reference one place to answer how
to enable RAR support
Stoiko Ivanov [Tue, 19 May 2020 15:09:17 +0000 (17:09 +0200)]
add pmg specifics to resolv.conf documentation
The documentation of '/etc/resolv.conf' and '/etc/hostname' should mention
the specifics of PMG (their content is used to create variables used in
the postfix configuration
To allow linking from to a chapter/section not included in a manpage
allow the manpage link resolver to just return text in a case the
link target text is in fact no manpage.
If the link is a valid one in general will be checked in a lot of
other places, so here we won't run into a regression where a wrong,
non-existing, link does not get detected by the build system.
Signed-off-by: Mira Limbeck <m.limbeck@proxmox.com> Originally-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Mira Limbeck [Thu, 4 Jun 2020 09:28:26 +0000 (11:28 +0200)]
add white- and blacklist clarification
The difference between the 3 whitelists and 2 blacklists is not
explained anywhere in the docs and leads to confusion all the time.
To improve this situation add an overview over the different white- and
blacklists explaining at which level and how they work.
Signed-off-by: Mira Limbeck <m.limbeck@proxmox.com> Reviewed-By: Stoiko Ivanov <s.ivanov@proxmox.com>
Stoiko Ivanov [Mon, 25 May 2020 17:04:09 +0000 (19:04 +0200)]
MailTracker - remove special case for before-queue
Since we've recently added dedicated before-queue status to pmg-log-tracker
the MailTracker should treat before and after queue filtered mail equally.
This patch drops the note stating otherwise.
Additionally the line with 'queued/delivered' was left in place, since the
status does exist (as with the other 'queued' status mails it happens for
internally generated mails).
Aaron Lauterer [Fri, 15 May 2020 12:44:10 +0000 (14:44 +0200)]
install: move media preparation before wizard
As in the PVE docs, move the boot media preparation chapter in front of
the installation wizard one. Changes to the text were taken from the PVE
docs and adapted.
Aaron Lauterer [Fri, 15 May 2020 12:44:09 +0000 (14:44 +0200)]
install: usb: use updated instructions from PVE
The instructions for a bootable USB flash drive in the PVE docs have
been worked on to improve the phrasing and cover current tools for
Windows which we also want in the PMG docs.
Thomas Lamprecht [Thu, 23 Apr 2020 17:42:38 +0000 (19:42 +0200)]
update screenshots
represents mainly new user logout/language button on the top right.
screenshot selenium scripts got improved to have more forms filled
out and allow doing them more automated but also allowing to mirror a
more realistic setup.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
While we mention greylisting as available feature in pmgintro.adoc, we
should also document a few more technical details of its workings
in PMG (e.g. how long a seen triple is kept before expiring).
starting the listing with before/after queue filtering makes it easier to
scan through the document, especially if we refer to it with the same words
below.
Mira Limbeck [Thu, 16 Apr 2020 15:40:07 +0000 (17:40 +0200)]
clarify tracking center docs for before-queue
In the after-queue case we get 2 QEntrys from the pmg-log-tracker when
the mail is accepted. One serves as a relay and provides the delivery
status. In the before-queue case we only have 1 QEntry and no extra delivery
status. This results in before-queue accepted mails being shown as
'queued/accepted' instead of 'accepted/<status>'.
As the tracking center shows 'queued/accepted', mention this combination
in the docs and clarify that it only happens in the before-queue
filtering case.
Signed-off-by: Mira Limbeck <m.limbeck@proxmox.com>
Stoiko Ivanov [Fri, 27 Mar 2020 10:13:08 +0000 (11:13 +0100)]
add support for next-hop TLS destination
Adapt the documentation for TLS Destination policies to mention next-hop
destinations defined in the transport table. Support for this was introduced
with the fix for #1948.
Julian Zehnter [Sun, 5 Jan 2020 14:53:08 +0000 (15:53 +0100)]
Feature #2438 add support for lmtp delivery to downstream servers
new feature lmtp support for simplifying setups with lmtp capable
downstream servers (e.g. dovecot) Postfix support lmtp out of the box
and can now deliver mails directly to internal mailbox servers
without one more smtp connection
extending the documentation for new lmtp option in
MailProxyConfiguration and MailProxyConfiguration:Transport
Thomas Lamprecht [Wed, 20 Nov 2019 07:58:30 +0000 (08:58 +0100)]
add big attribute to thumbnails
allows one to easily define bigger thumbnails, i.e., those where we
have to big images to show the full on a page, but still want to give
the user a good sized preview.
As PDF renders this already pretty nice by default we only have to
adapt the html asciidoc config. We do that by using asciidocs
"Conditional Attribute References"[0] and add a "big" attribute.
It can be used as:
> [thumbnail="pmg-gui-network-config.png", big=1]
NOTE: the value of big is ignored, it just matters if it's defined.
While it could be possible to add logic to handle big=0, it it's just
extra work without real use, just omit it if not wanted.
Stoiko Ivanov [Mon, 18 Nov 2019 21:16:49 +0000 (22:16 +0100)]
explain handling of sa configuration
The configuration files of spamassassin (/etc/mail/spamassassin) are provided
and changed by 2 things:
* some files are rendered through the templating engine
* the rest is shipped with proxmox-spamassassin on package upgrades
This patch explicitly lists the first category of files, clarifying the
situation for our users.
Stoiko Ivanov [Mon, 18 Nov 2019 21:16:48 +0000 (22:16 +0100)]
Add documentation for before queue filtering
This patch adds the configuration options for before/after queue filtering
and generation of NDRs to the feature list and explains the concepts in
'pmgconfig.adoc' below the 'Options' panel of the MailProxy configuration
(where the features can be enabled in the GUI)
Stoiko Ivanov [Wed, 6 Nov 2019 11:18:37 +0000 (12:18 +0100)]
Expand the docs for custom SA configuration
Users regularly ask how to classify mails containing some keywords as spam.
Given that this usually indicates a misconfiguration in their DNS-Setup, and
the changes lead to more false positives than actually catching more spam
we should address this more explictly in the documentation.
repos: change security repo link for future proofing and add note for bullseye
Actual this is a no-change change, as they URLs both resolve to the
exact same folders (are symlinked), i.e., see:
http://security-cdn.debian.org/dists/
vs.
http://security-cdn.debian.org/debian-security/dists/
but just change it nonetheless to match Debian's recommendation.
Also, add a FIXME not for the future 7.0 as there we need to change
the security suite name too[0].
Stoiko Ivanov [Thu, 29 Aug 2019 17:21:56 +0000 (19:21 +0200)]
mail-filter: include 'Rule-Based' in heading
One of the core features of PMG is the rule-system, which is documented in
'pmg-mail-filter.adoc' under the (correct) heading of 'Mail Filter'
In quite a few other places [0,1] where the features of PMG are highlighted we
refer to the (Object Oriented) Rule System.
When skimming through the documentation and quickly glancing at links the
connection 'Rule System' <-> 'Mail Filter' is not directly apparent and could
cause confusion.
This is addressed by adding 'Rule-Based' as prefix to the chapter title.
projects / pmg-docs.git / log