bump version to 8.2.1

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

backup: move screenshots for retention and note-templates to their section

As the job one is quite a bit crowded as is and there are some
screenshots that fit really well with some specific sections like
retention or the backup note templates.

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

update static/schema information

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

vzdump: add backup job screenshots

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

firewall: add documentation for proxmox-firewall

Add a section that explains how to use the new nftables-based
proxmox-firewall.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>

bump version to 8.2.0

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

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

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
 [ TL: adapt to changes made in the wiki article ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

update static/schema information

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

firmware-updates: fix typo

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

network: update specification for bridge names

Reviewed-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>

firmware updates: split overly long sentence into three separate one

Surely  still not perfect but even me, a comma loving creator of
complex sentences, found rather hard to follow, so this had to get
split up.

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

firmware: adapt to proxmox packaged fwupd

We ship our own fwupd package, since it needs to handle the
differently named efi_os_dir (proxmox vs debian).
Due to our experience with `udisks2` causing issues on hypervisors,
our package downgraded the Recommends udisks2, to a Suggests.
The downside is, that users need to explicitly set their ESP
mountpoint in the config file.

Additionally a minor stylistic rephrasing (is an option vs. could be
an option).

Tested this today, while giving our fwupd package a spin.

Suggested-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

vzdump: add section about backup fleecing

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

ssh: document PVE-specific setup

such as adapted configs and managed files.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

ssh: make pitfalls a regular section instead of block

because we'll add another one before it, and formatting is off otherwise.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

qm: add overrule-shutdown to CLI usage examples

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>

system boot: slightly reword some secure-boot paragraphs

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

secure boot: mention proxmox-secure-boot-support metapackage

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

storage: pbs: document port option

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

backup: clarify where repeat-missed option can be found now

It was moved to the advanced tab by pve-manager commit
ui: backup job: move repeat-missed option to advanced tab

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

backup: update information about performance settings

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

add vIOMMU documentation

Signed-off-by: Markus Frank <m.frank@proxmox.com>

zfs: add missing "to"

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

system-requirements: mention that SSDs with PLP should be used

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

pvenode/wake-on-lan: mention defaults

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

pvenode/wake-on-lan: mention optional config options

Show how to configure the optional bind interface and broadcast address
options via `pvenode`.

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

installation: fix volume group name

This slipped through while taking the wording from PMG.

Fixes: 67d2d94 ("installation: lvm-options: improve & align wording with pmg-docs")
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

bump version to 8.1.5

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

installation: add serial console grub entry

This was added with the 8.1 release ISO, so mention it in the
documentation too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: reword `nomodeset` section a bit, add link to it

The `nomodeset` section needs some massaging due to the text flow being
broken a bit. While at it, link to it above at the 'Terminal UI'
bootloader tip such that readers can find it more easily.

Suggested-by: Alexander Zeidler <a.zeidler@proxmox.com>
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: document `ARC max size` option for ZFS-on-root installations

This has been part of the installer since the 8.1 release.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

local-zfs: mention `zfs_arc_max` clamping by the installer

This was forgotten to be updated when it changed it the installer and
now reported in the forum [0] that the docs are a bit outdated in this
regard.

[0] https://forum.proxmox.com/threads/hat-proxmox-8-neue-zfs_arc_max-settings.142754/

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

update static/schema information

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

qm: rework import section, document new wizard

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

installation: update link to installing on top of Debian to bookworm version

Seems this just was forgotten, Buster is quite old at this point.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: iso: reflow location and password dialog screenshots

The same changes were done in commit

   4c35e536b ("installation: reword/expand/reflow and fix login thumbnail")

in pmg-docs to improve the layout as good as possible.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: zfs-options: improve & align wording with pmg-docs

These changes are the result of basically "diffing" both documentations,
choosing the better prased/sounding sections. Some wording were also
slightly changed as necessary to further improve them.

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

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: lvm-options: improve & align wording with pmg-docs

These changes are the result of basically "diffing" both documentations,
choosing the better prased/sounding sections. Some wording were also
slightly changed as necessary to further improve them.

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

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: iso: improve & align wording with pmg-docs

New paragraphs were taken from pmg-docs and adapted. Most changes
here are the result of basically "diffing" both documentations, choosing
the better prased/sounding sections. Some wording were slightly changed
as necessary to further improve them.

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

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

package-repos: improve wording partly based on pmg-docs

Some sentences are phrased better and more expansive in pmg-docs, so
take them from there and adapt them as needed.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

qm: small follow-up linking to our virtio wiki page

instead of the direct link to the latest ISO. As the wiki page contains
a bit more details about the VirtIO drivers and can be changed quickly
if needed.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

qm: add documentation on configuring multiqueue for windows guests

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>

qm: multiqueue specify that it needs to be vCPUs not cores

total number of cores != vCPUs if there is more than one socket
configured. according to the redhat docs it should be vCPUs not cores:

> Multi-queue virtio-net provides the greatest performance benefit when:
> [..]
> - The number of queues is equal to the number of vCPUs.

https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_tuning_and_optimization_guide/sect-virtualization_tuning_optimization_guide-networking-techniques#sect-Virtualization_Tuning_Optimization_Guide-Networking-Multi-queue_virtio-net
Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>

zfs: add a note about dRaid performance

Based on statements from the openZFS documentation where it is described
as providing "the same level of redundancy and performance as raidz" [0].

[0] https://openzfs.github.io/openzfs-docs/Basic%20Concepts/dRAID%20Howto.html

bump version to 8.1.4

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

getting-help: forum: align wording with pmg-docs

This paragraph as phrased in pmg-docs sounds better & reads easier, so
apply it here too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

local-btrfs: unify casing for btrfs

It's mostly spelled BTRFS anyway in our documentation (and also the
official casing AFAICS), so align a few instances where it spelled
lowercase.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

asciidoc: introduce `pricing-url` variable, much like pmg-docs

Seems like a pretty sensible thing to do here too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

gitignore: add package build outputs

.. much like it many other repos.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

storage: fix zfs over iscsi links

The `_ZFS_over_iSCSI` wiki page is redirected to the legacy page
(for historical reasons), but we want to link to the reference docs
instead.

for the wiki add the legacy link in a `see also` section, so users can
still reach that page easily should they need to

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

docbook: render 4th section level for manpages

In the manpage output the sections get rendered as refsections, but
those only go up to level 3:

> In DocBook, RefSect3 is the lowest-level section allowed in a
> RefEntry. There is no element analogous to a Sect4.
-- https://tdg.docbook.org/tdg/4.5/refsect3

While nesting refsect3 would work output wise, the DTD schema does not
allows this, and disabling schema validation can lead to graver
issues, so rather avoid that and use a formalpara [0], a paragraph
with a title, instead, but only for the title, as the inner content
will be a simpara (simple paragraph) that cannot be nested inside a
formalpara, but the resulting rendering works out well enough.

[0]: https://tdg.docbook.org/tdg/4.5/formalpara

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

doc-generator: ship our pve-docbook config and use it for manpages

so that it can also be used when generating per-package docs like
manpages.

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

css: fine-tune h4, h5, h6 headings font-sizes

Else h6 was quite a bit tinier than the actual paragraph text, and it
doesn't hurts that h4 stands a bit out more.

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

correctly render level 5 headings

E.g., render them as h6 for the HTML output.

Level 5 headings are the +++++ ones in the full page output, in the
per-chapter outputs they are level 4 and worked fine already.

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

dblatex: update custom style with upstream changes

checked with:
diff -up /etc/asciidoc/dblatex/asciidoc-dblatex.sty asciidoc/dblatex-custom.sty

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

vzdump: remove usage examples involving 'notification-{target, policy}'

Also clarify in one example that using `--mailto` will bypass the
notification system (at least from the user's perspective).

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

partially fix #5139: document qnetd port requirement

we could also add a check somewhere in pve-cluster for this.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 [ TL: squash in changes Fiona proposed for the port syntax/wording ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

fix #5140: qdevice SSH access documentation

rephrase in order to not make it seem like password-based access is required.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

tree-wide: unify spelling of GRUB and systemd-boot

Especially for GRUB there were a myriad of different casing variants
(e.g. grub, Grub, GRUB), so unify them, with GRUB being the official
casing.

For systemd-boot, fix an instance where it was not typeset as
monospace, like everywhere else.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: add section about booting with `nomodeset`

As the grub entry specific to this was removed with the 8.1 release, add
a separate section for this to link users too.

Unfortunaly it is relatively often needed, due to very old or very new
hardware, or when Nvidia cards are installed.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

installation: add note about memtest86+ incompatibility with secureboot

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

screenshots: update grub menu screenshot

The 8.1 release changed some things, so update the screenshot to keep in
sync with the latest ISO.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

qm: resource limits: reword affinity section

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

qm: resource limits: reword cpulimit section

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

qm: resource limits: revise section affinity

* mention side effects
* increase compactness w/o complexity
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

qm: resource limits: revise section cpuunits

* restructure sentences minimally
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

qm: resource limits: revise section cpulimit

* precise statements
* increase compactness w/o complexity
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

pvecm: correct network address

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

ballooning: precise example

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

firewall: fix link to suricata page

Signed-off-by: Hannes Duerr <h.duerr@proxmox.com>

installation: update installer option wording & description

Some things changed with the 8.1 release, so update all the relevant
things here too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

storage: lvm: mention how saferemove setting is called in the UI

to avoid confusion.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

storage: improve description of 'shared' property

Following pve-storage commit 4abb327 ("plugin schema: improve
description of 'shared' property"), adapting the description also
here in the documentation.

It's not clear to users what this property does otherwise.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

pvecm: remove node: explain how to deal with the node's pmxcfs directory

Reported in the community forum:
https://forum.proxmox.com/threads/139006/post-621739

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

notifications: fix typos and improve reading flow

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

storage: lvm: expand on description of saferemove option

mentioning why zeroing-out might be necessary.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

local-zfs: use correct man page for vdev infos

ZFS did split up their man pages a while ago

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

qm-cloud-init: make install inside VM more obvious

by making that part bold. While there is already a big note where
cloudinit needs to be installed, it is after the actual command.

Making it more obvious right before the command will hopefully reduce
confusion for more users.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>

fix 'vpus' typo

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

fix #5089: pvesdn: replace quest(s) -> guest(s)

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

fix #5087: qm: formatting of start/shutdown order list

drop the stray '*' and reflow.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

installation: be more specific about current secure boot state

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

secure boot: fix typos, add inline code formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>

bump version to 8.1.3

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

system booting: fixup title-case

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

secure boot: add subsection for DKMS/MOK

similar, but a bit more beginner friendly compared to the wiki article.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

system-booting: fix typo

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

system-booting: add note about weird uefi behaviour

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

bump version to 8.1.2

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

system booting: use title-case for secboot-switch section

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

system-booting: add instructions to switch install to secure boot

As this procedure could *potentially* lead to data loss (however
unlikely if followed correctly), put a big warning on top, for safety.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>

pvesdn: Fix heading for NetBox IPAM plugin section

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

bump version to 8.1.1

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

update static/schema information

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

pvesdn: remove double occurrence of 'external'

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

boot: add Secure Boot information

and refer to the (updated) wiki article for more in-depth explanations.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

notifications: add screenshots for the new notification UI

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

sdn: fix trailing double-quote character

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

consistently use web UI and web interface wording

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

pveum: update generated synopsys

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