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.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

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)

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

mention DKIM Signing in the introduction

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

add 'pmg-scores.cf' to config file section

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

add dkim files to config file and cert section

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bump version to 6.0-5

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

followup adaptions for SA custom rules

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

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.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

add before_queue params to gen-pmg.conf.5.-opts.pl

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

add info about attachment quarantine

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

pmgcm.adoc: improve wording and grammar

Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>

bump version to 6.0-4

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

fix path to dkim selecthor key

Add DKIM documentation

Add a short section explaining DKIM and the specifics of Signing in PMG.

Additionally gen-pmg.conf.5-opts.pl was extended to create
'pmg.admin-dkim-conf-opts.adoc' for inclusion below the documentation.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

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].

[0]: https://lists.debian.org/debian-devel-announce/2019/07/msg00004.html

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

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.

[0] https://www.proxmox.com/en/proxmox-mail-gateway/features
[1] https://pmg.proxmox.com/pmg-docs/pmg-admin-guide.html#_features

Reported-by: Daniela Häsler <daniela@proxmox.com>
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

add the supported browsers to the system requirements

copied from pve

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

bump version to 6.0-3

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

add mailgateway FAQ similar to the PVE one

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

run make update for new schema and synopsis definition

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

change api-viewer title to PMG

noted while testing the use of our extjs-package instead of cloudflare cdn
(ddc224d888f366f37b60df51d43a7832afab08ef).

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

fix lintian warning in pmg-docs-apache

the apache/conf-available snippet for pmg-docs-apache should be named like the
package according to lintian (non-standard-apache2-configuration-name).

move the configfile via dpkg-maintscript-helper(1) (see the manpage for
the explaination of the prior version of 6.0-3~) and dh_installdeb(1).

Tested by upgrading pmg-docs-apache to a version with this commit, while having
modifications in '/etc/apache2/conf-available/pmg-docs.conf'

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

pmg-docs-apache: remove default redirect

pmg.proxmox.com does not host only the documentation the default redirect
to '/pmg-docs' should be removed

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bump version to 6.0-2

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

api-viewer: properly HTML encode properties

and fix missing closing </pre> tag

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

api-viewer: use our extjs package instead of the cloudflare cdn

The loading of an external hosted ExtJS is from a time where we did
not have a extra ExtJS package as it still was in the pve-manager
one, which was not desired to be installed on a non-pmg machine.
Add a dependency on libjs-extjs and a link from api-viewer/extjs to
the installation directory of the ExtJS package, this allows to reuse
ExtJS on PMG node hosted docs and on the hosted docs from proxmox.com
at the same time.

Adapted from the Proxmox VE version[0] of this change.

[0]: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff;h=e56030c4d7c3bd0de1ebc109d528fb6b7bef05a3

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

run 'make update'

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

add anchors needed for the upgrade documentation

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

change repository urls to buster

and adapt the location of the signing key and its hashsums.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bump version to 6.0-1

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

make changelog single source of version

Adapted from pve-docs respective commit [0]

[0]: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff;h=76909adf48fc211e7799795fcb96eed5447e2b9a

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 5.2-3

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

docs-apache: fix lintian error and warning

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

really integrate the package in build toolchain...

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

add new pmg-docs-apache package

containing a short apache-config snippet for delivering the pmg-docs via apache.

Mostly added for consistency between pve-docs (containing pve-docs-mediawiki)
and pmg-docs (containing pmg-docs-apache, because it does not have a wiki)

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

Revert " set email to office@proxmox.com"

This reverts commit 99cdf3a878cd53bf1e3942c63ba6e0f040b470f5.
Reqeuested, again, by Martin as it's out there for such purposes for
>15 years, so we just keep it.

bump version to 5.2-2

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

d/copyright: update years

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

 set email to office@proxmox.com

Requested by Martin as the support@ address is now quite wired to the
enterprise support ticket system, and office is for more general
requests.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

installation: break long line

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

installation: improve LXC appliance section

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

followup: reword and promote PVE backed appliance first

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

installation: add proxmox-mailgateway-container

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

d/control: build-depend on source-highlight

This ensures that code blocks with [source,<lang>] blocks get
rendered correctly in HTML output.

While we only have one such block, and we could remove the
source highlighting tag completely here we use this in pve-docs and
also have the dependency there correctly, so it makes sense to make
share this here, else a copied text from pve-docs may be incompatible
here

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 5.2-1

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

planning deployment: fixup explicit line break

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 5.1-7

Add initial documentation for custom checks

The recently added custom check API (see #1988) needs a short documentation,
explaining the correct workings of a custom check executable.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bump version to 5.1-6

Update minimal and recommended system requirements

 - reword text for physical and VM usage and requirements
 - correct network speed unit
 - extend and reword storage recommendation

Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>

Fix typo in pmgconfig chapter

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

fix #2121: add stretch-updates to sources.list

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bump version to 5.1-5

bsys: automatically update YEAR info

in pmg-copyright.adoc and pmg-admin-guide-docinfo.xml

ported from pve-docs:742e92ef45cb1a8b6b98946959f6d36abc5ac9e9

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

export and respect SOURCE_DATE_EPOCH

to improve reproducibility of pve-docs, pve-doc-generator and
pve-doc-mediawiki builds, as well as man pages generated by
pve-doc-generator when called via dpkg-buildpackage.

timestamps embedded in the documentation now always reflect the last changelog
entry of the package to which the documentation belongs (pve-docs for html,
epub and pdf, individual packages for man pages).

ported from pve-docs:b965ad63ad80b5967f5bc1f0327eb548b6049045

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

d/compat: bump to 10

(enables parallel builds by default)

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bsys: fix broken parallel builds

a2x only supports destination folders for HTML based variants, but fortunately
that is enough in our case without needing extra workarounds.

ported from pve-docs:959bc81c13cd84c3227a466afc981af37092f70e

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

d/control: add/remove build-dependencies

gathered by building in a minimal Debian Stretch chroot with just the
listed build-dependencies installed.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

d/control: bump debhelper build-dependency

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bsys: wrap-and-sort debian/

for consistency and easier diffing

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bsys: refactor build process

build packages in one go by moving individual .deb targets into install
targets called by dpkg-buildpackage.

ported from pve-docs:fa764571f6a0c5bfc62ee1cda6bffcfae40e9ec9
and pve-docs:60955877b11cde0865a258ece040bd124fb07bdc

Additionally I added the fixups from Thomas in
pve-docs:2d11c86883c4b1150afcc97eedfbf1b2a07de105
pve-docs:fd880d44c7d3876add7acd659641668bfa09c71b

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

fix #2098 and a typo

The phrasing regarding copying the templates from '/var/lib/pmg/templates'
to '/etc/pmg/templates' caused some confusion [0] and some users thought they
need to copy all templates to '/etc/pmg/templates', even if they only modified
one template. Rephrasing the sentence to speak of a singular template, should
explain the workings better.

Additionally a singular/plural typo was fixed

[0] https://bugzilla.proxmox.com/show_bug.cgi?id=2098 and a few forum-threads

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

pmgproxy.adoc: add docs for config-parameters

taken from the documentation for pveproxy

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

pmgproxy.adoc: fix 2 typos and minor rephrasing

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

Fixed typo setting -> settings

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

Correction of meaning for liability of sending viruses

In the docu it stated that you can be liable for not sending viruses,
this was changed to you being liable for sending viruses.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

Some language improvements for the deployment chapter

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

Removed double occurence of 'a public'

This removes the double occurrence of 'a public' from the Bug Tracker section
in the PMG documentation.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

bump version to 5.1-4

update TLS config screenshot

bump version to 5.1-3

add anchors for onlineHelp

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bump version to 5.1-2

fix copyright date

bump version to 5.1.1

asciidoc/asciidoc-pmg.conf: update links to https

Change the links to directly point to the https version of a site where
possible.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

add short documentation for /etc/pmg/tls_policy

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

use rsvg-convert instead of inkscape

This is an analogous change to what was done in pve-docs last year.

The Build-Depends has been adjusted to list all required ones, there
were some missing.  Also, the compat level is set to 9 so bump
debhelper Build-Depends to >= 9~.

Signed-off-by: Rhonda D'Vine <rhonda@proxmox.com>

bump version to 5.0-16

update apidata.js

add new option smarthostport

bump version to 5.0-15

gen-pmg.conf.5-opts.pl: add dnsbl_threshold to known parameters

api-viewer: show full return info if available

if we have extended information available about what a API call
returns the show it.

Just stringify the items and/or properties object and put it in <pre>
tags.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 5.0-14

update generated docs

bump version to 5.0-13

update generated docs

make it clear that not all options are available in the webinterface.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

bump version to 5.0-12

add node how to update ssl cert on cluster

bump version  to 5.0-11

pmg-setup-network.png: regenerate from .ppm

update deployment graphics

bump version to 5.0-10

asciidoc-pmg.in: fix product name

pmg-setup-network.ppm: update, remove pve product name ate network setup page

pmg-administration.adoc: add short quarantine docs

pmg-administration.adoc: descrive delivery status

pmg-administration.adoc: add note about search speed