Commit Graph

23 Commits

Author SHA1 Message Date
Stoiko Ivanov
69c1be1243 asciidoc config: work around missing icon bug
This follows commit
ba6ea595629b20adbfc8241b9a2d20aa14c338f3
from pve-docs.
and addresses [0].

[0]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1036030#10

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-06-26 13:37:01 +02:00
Stefan Sterz
5feac0e677 conf: add support for a dark mode in the documentation
this commit adds support for a dark theme that behaves similarly to
that one used by the api viewer.

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
2023-03-21 12:49:54 +01:00
Lukas Wagner
4659120990 fix capitalization of GmbH
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2022-11-10 13:12:10 +01:00
Dylan Whyte
e1f6d6d01c pmgconfig: Link to SA rule writing documentation
Adds a link to SpamAssassin's rule syntax documentation to the section
"Custom SpamAssassin Configuration".

Also clarifies that the name of a custom spam score should be the name
of the corresponding SpamAssassin rule.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2022-01-11 18:43:37 +01:00
Stoiko Ivanov
e97e08c31b asciidoc: minimally update derived docbook conf templates to work with python333
(ported from cf7a2acc3069a7b4974ff41411ee232afb29a9a1 in pve-docs)

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2021-06-01 13:37:15 +00:00
Dylan Whyte
171566d6cb Change 'Gmbh' to 'GmbH'
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-03-17 11:34:33 +01:00
Stoiko Ivanov
9680676689 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

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2020-06-17 09:42:34 +02:00
Thomas Lamprecht
ce41b84c31 html TOC: add "back to index" link
use a unicode symbol for the back arrow, should nowadays be widely
available

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-04-23 19:44:41 +02:00
Thomas Lamprecht
509eaa9290 adapt toc2 and more responsive style changes from PVE
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-02-13 16:42:03 +01:00
Thomas Lamprecht
d108f53720 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.

[0]: https://www.methods.co.nz/asciidoc/chunked/ch30.html

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-11-20 09:17:26 +01:00
Stoiko Ivanov
89028579c2 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>
2019-11-19 11:30:47 +01:00
Stoiko Ivanov
833e1edcb1 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>
2019-11-15 12:47:51 +01:00
Stoiko Ivanov
20522d9644 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>
2019-10-23 11:52:41 +02:00
Thomas Lamprecht
0822b4d83a Revert " set email to office@proxmox.com"
This reverts commit 99cdf3a878.
Reqeuested, again, by Martin as it's out there for such purposes for
>15 years, so we just keep it.
2019-05-31 13:15:33 +02:00
Thomas Lamprecht
99cdf3a878 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>
2019-05-28 15:53:31 +02:00
Stoiko Ivanov
20925f821b 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>
2018-09-27 07:24:52 +02:00
Stoiko Ivanov
37b2b051e2 add short documentation for /etc/pmg/tls_policy
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2018-09-27 07:24:26 +02:00
Rhonda D'Vine
d4fe77a5b8 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>
2018-09-19 08:12:23 +02:00
Dietmar Maurer
d2ae160b22 pmgsubscription.adoc: improve subscription docs 2018-01-15 13:00:33 +01:00
Dietmar Maurer
e3eaa56aa1 pmg-administration.adoc: add administration section 2018-01-15 09:52:33 +01:00
Dietmar Maurer
9c85cc808b add Service Configuration Templates section 2018-01-03 13:54:57 +01:00
Dietmar Maurer
5fb138688b asciidoc-pmg.conf - fix forum name 2017-12-22 09:59:38 +01:00
Dietmar Maurer
410dc2c9c4 Initial commit 2017-02-22 07:15:00 +01:00