Commit Graph

505 Commits

Author SHA1 Message Date
Stoiko Ivanov
dab5ae0798 pmg-mail-filter: add short docs for top-part-only and only-content
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2025-02-22 18:16:09 +01:00
Friedrich Weber
dacc38fe64 pmg-mail-filter: clarify matching of Who objects
In particular, explain that Who objects match against Envelope From
and Envelope To, not the From: and To: mail headers. This is
occasionally a source of confusion in enterprise support.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
2025-02-21 17:57:24 +01:00
Christoph Heiss
516fc90b7a fix #5771: faq: add 7 to 8 upgrade link
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2025-01-30 13:58:30 +01:00
Christoph Heiss
e7a67cf3d1 faq: split up upgrade section into major and point release upgrades
Makes the difference stand out better, much like we do it in the PVE
docs too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2025-01-30 13:58:30 +01:00
Aaron Lauterer
727296f369 installation: add section about unattended/automatic installation
Mention and briefly explain it. The main part of the documentation will
live in the Wiki for now as it applies to not just Proxmox Mail Gateway.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
[SI: adapt to pve-docs, replace 'on bare-metal' to 'with the ISO' ]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2025-01-30 13:56:52 +01:00
Maximiliano Sandoval
a646466b9d fix some typos
Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2025-01-30 13:35:53 +01:00
Thomas Lamprecht
ffb2571a22 bump version to 8.1.2
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-12-14 14:54:10 +01:00
Christoph Heiss
fcc8171c86 pmgconfig: document support for html and plain-text email templates
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
[S.I. adapt to changed semantics]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
Reviewed-by: Christoph Heiss <c.heiss@proxmox.com>
Tested-by:  Christoph Heiss <c.heiss@proxmox.com>
2024-12-10 20:14:41 +01:00
Stoiko Ivanov
238f9f39e1 partially fix #3979: config: custom.cf: document service restart
creating custom spamassassin configuration might be an advanced topic,
but documenting the needed steps in PMG should let users focus more on
the rules than finding out what else needs to be done.

only partially fixes the request, I still don't think that adding
an edit window for custom.cf to the GUI makes sense, and adding
custom.cf as template (to automatically pick up changes faster/on
pmgconfig sync), seems not really fitting.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-12-10 20:10:00 +01:00
Christoph Heiss
59fbee4e6e installation: zfs: add advanced zfs configuration section
Copied from pve-docs, applies the same for the PMG installer.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-12-10 20:08:55 +01:00
Christoph Heiss
c5bdf53917 installation: debian: improve & align wording with pve-docs
Most of the changes are taken from pve-docs to align the exact wording
in general, as well as changing a few subtle things to improve the
overall reading flow.

The equivalent changes will be done for pve-docs too to ensure they are
really the same in the end.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-12-10 20:08:55 +01:00
Christoph Heiss
cca0a76ae3 installation: lvm-options: improve & align wording with pve-docs
Most of the changes are taken from pve-docs to align the exact wording
in general, as well as changing a few subtle things to improve the
overall reading flow.

The equivalent changes will be done for pve-docs too to ensure they are
really the same in the end.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-12-10 20:08:55 +01:00
Christoph Heiss
2a4f8914f5 installation: iso: improve & align wording with pve-docs
Most of the changes are taken from pve-docs to align the exact wording
in general, as well as changing a few subtle things to improve the
overall reading flow.

The equivalent changes will be done for pve-docs too to ensure they are
really the same in the end.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-12-10 20:08:55 +01:00
Christoph Heiss
72b70a0038 installation: repos: improve & align wording with pve-docs
Most of the changes are taken from pve-docs to align the exact wording
in general, as well as changing a few subtle things to improve the
overall reading flow.

The equivalent changes will be done for pve-docs too to ensure they are
really the same in the end.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-12-10 20:08:55 +01:00
Christoph Heiss
fd2a8f4ae6 getting-help: add mailing lists link
We have the same section already in pve-docs, it's a nice addition for
pmg-docs too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-12-10 20:08:55 +01:00
Christoph Heiss
d45c1d3956 getting-help: align wording with respective pve-docs page
Makes it much more consistent and a bit easier to integrate future
changes to both pages as needed.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-12-10 20:08:55 +01:00
Christoph Heiss
55cbeb7b0e gitignore: add package build outputs
.. much like it many other repos.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
[S.I] add pmg-docs_[0-9]* to catch source-packages
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-10-03 16:15:53 +02:00
Thomas Lamprecht
276c2ef635 system requirements: use correct and modern acronym for Intel 64-bit
Intel EMT64 is not a thing, the correct variant would be Extended
Memory 64 Technology, which is shortened to EM64T [0].

But the `Intel EM64T` term was replace a long time ago by `Intel 64`
[1], so just go with that.

[0]: https://www.intel.com/content/www/us/en/support/articles/000005898/processors.html
[1]: "[...] in March 2004 unveiled the "official" name EM64T (Extended
      Memory 64 Technology). In late 2006 Intel began instead using
      the name Intel 64 for its implementation [...]"
     -- https://en.wikipedia.org/wiki/X86-64#Intel_64

Reported-by: Alexander P. Inzinger-Zrock
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-09-30 11:37:54 +02:00
Maximiliano Sandoval
8237b42885 latex: fix typo in comment
Found with typos-cli (`cargo install typos-cli`):

```
typos --exclude .git --exclude tests --exclude images \
 --exclude changelog
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
[S.I.: add typos-cli reference]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-08-08 14:00:06 +02:00
Maximiliano Sandoval
bc08755447 fix typos in documentation
Found with typos-cli (`cargo install typos-cli`):

```
typos --exclude .git --exclude tests --exclude images \
 --exclude changelog
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
[S.I.: add typos-cli reference]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-08-08 13:59:12 +02:00
Maximiliano Sandoval
10a1a7b6b6 fix typos in perl and css files
Found with typos-cli (`cargo install typos-cli`):

```
typos --exclude .git --exclude tests --exclude images \
 --exclude changelog
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
[S.I.: add typos-cli reference]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-08-08 13:56:52 +02:00
Christoph Heiss
0eadcfcbc2 asciidoc: add clickable anchor link to all headings
Works the same as for our PVE/PBS documentation and is generally common
for documentations.

Very useful for linking specific sections of the documentation in other
places. Previously, this always had to be done by getting the correct
anchor from the HTML directly via e.g. browser devtools.

follows https://git.proxmox.com/?p=pve-docs.git;a=commit;h=ecab5895a4

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
[S.I.: add link to relevant commit in pve-docs]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-08-08 13:56:36 +02:00
Christoph Heiss
ddf3e9f15b installation: fix codeblock rendering in zfs performance tips section
That slipped through, asciidoc uses 4 not 3 dashes for that.

Fixes: c8be3f0 ("installation: align zfs performance tip with PVE documentation")
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-28 19:59:14 +01:00
Thomas Lamprecht
57495cfceb bump version to 8.1.1
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 15:18:15 +01:00
Thomas Lamprecht
8304e86105 update various screenshots
lots of them where made with PMG 6.2, and while we had no huge revamp,
there are quite some small to mid sized changes and improvements all
over the place, so update a few that show such changes and where easy
to regenerate quickly.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 15:18:15 +01:00
Thomas Lamprecht
4c35e536bd installation: reword/expand/reflow and fix login thumbnail
Try to improve the layout, still not really ideal with that many
thumbnails in a single relatively short section but should be a bit
easier to read.

Change the place of the UI login thumbnail as before the numerical
bulletin point list it won't work due to block boundaries and asciidoc

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:52:16 +01:00
Thomas Lamprecht
3cb52bcd8d screenshots: update dashboard and login screenshots
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:16:16 +01:00
Thomas Lamprecht
6f97245064 screenshots: regenerate installer screenshots with smaller border
to avoid ugly blocking looking images that distract from the actual
content.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:15:52 +01:00
Thomas Lamprecht
8bc67ce3c9 verify-images: include the file name that failed verification
so that it might actually be useful..

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:15:04 +01:00
Thomas Lamprecht
c07cdc194c buildsys: make verify-images target informative only
The PDF and the HTML are rendered fine anyway, this is just a PITA

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:14:24 +01:00
Stoiko Ivanov
0091b1c8ae doc-generator: add new option dkim-use-domain
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-28 10:32:38 +01:00
Stoiko Ivanov
b53b522b52 dkim: rephrase signing-domain source docs
mostly to mention the 2 terms RFC5321.MailFrom and RFC5322.From
actually used in the dmarc-rfc for both terms.

additionally rephrase the link phrase from smtp_rfc to rfc_5321 (there
are at least 3 rfcs titled SMTP)

fix 1 small typo.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-28 10:32:38 +01:00
Maximiliano Sandoval
90f38c3de0 dkim: document dkim-use-domain
Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
[S.I.: fix spelling of dkim-use-domain]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-28 10:32:03 +01:00
Thomas Lamprecht
1e9afc1078 bump version to 8.1.0
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-27 17:00:09 +01:00
Thomas Lamprecht
29f6d740c6 update static schema info
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-27 17:00:09 +01:00
Christoph Heiss
38d1451907 asciidoc: make thumbnail path relative to images/
This in turn allows to also use images from other subdirectories, e.g.
`images/installer/`, and not just from `images/screenshot/`.

Replacing all paths was done mechanically using:

  sed -i 's/thumbnail="pmg-gui/thumbnail="screenshot\/pmg-gui/g' *.adoc

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 16:49:18 +01:00
Christoph Heiss
4af6e95585 images: run png-cleanup.pl on all and verify on install
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
9fc9adae61 installation: add a TUI installer screenshot
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
ca47e9efe1 installation: convert installer screenshots to thumbnails
Again, like the PVE documantation. Improves the reading flow quite a bit
too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
84f2aef40a installation: add nomodeset kernel parameter tip for bogus graphics
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
c8be3f0399 installation: align zfs performance tip with PVE documentation
This one is IMO better worded, so just use that.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
aaec2aab8d installation: update chapter based on PVE docs & new GRUB entries
The new release also brings things such a the serial console
installer and a expandend 'Advanced Options' menu.

This mostly aligns it with the respective documentation from PVE,
rewording some things and adding some {NOTE,TIP,WARNING}s from there as
well.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
6e1ed29673 images: update GRUB menu screenshot to latest release
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
522bb4f0ae gitignore: add initial file based on pve-docs
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Aaron Lauterer
f43c69832a docs: pmgconfig: fix path to transport file
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-02-27 12:08:14 +01:00
Stoiko Ivanov
349ff12ada admin: system-booting: add screenshots
additionally adapt the paths for pmg with:
sed -ri 's/screenshot\///g' system-booting.adoc

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-27 11:54:17 +01:00
Stoiko Ivanov
abe750ed54 admin: include system-booting docs
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-27 11:20:16 +01:00
Stoiko Ivanov
8378a1ebaa admin: system-booting: replace pve with pmg automatically
the result looks correct, and using sed might help in case the
pve-docs get updated:

sed -ri 's/([^-])pve([^.])/\1pmg\2/g;
    /^ifdef::wiki\[\]/,/^endif::wiki\[\]/d' system-booting.adoc

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-27 11:20:12 +01:00
Stoiko Ivanov
93f6b84af6 admin: system-booting: copy system-booting.adoc from pve-docs
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-27 10:29:51 +01:00
Thomas Lamprecht
933d580d69 update static schema info
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-23 18:17:29 +01:00