Commit Graph

2070 Commits

Author SHA1 Message Date
Stoiko Ivanov
905fff4902 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>
2024-04-21 11:00:08 +02:00
Fiona Ebner
1ca0f96a86 vzdump: add section about backup fleecing
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-19 16:00:27 +02:00
Fabian Grünbichler
c58d2f179c ssh: document PVE-specific setup
such as adapted configs and managed files.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-04-19 09:10:33 +02:00
Fabian Grünbichler
95d15550a0 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>
2024-04-19 09:10:33 +02:00
Friedrich Weber
5a33939735 qm: add overrule-shutdown to CLI usage examples
Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
2024-04-18 23:09:32 +02:00
Thomas Lamprecht
5e6024eaf0 system boot: slightly reword some secure-boot paragraphs
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-18 22:12:18 +02:00
Stoiko Ivanov
6eb73a3ff8 secure boot: mention proxmox-secure-boot-support metapackage
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-04-18 22:06:15 +02:00
Fiona Ebner
f8564fdd51 storage: pbs: document port option
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-17 16:52:25 +02:00
Fiona Ebner
cb3fe20115 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>
2024-04-17 16:06:19 +02:00
Fiona Ebner
848c7b1be5 backup: update information about performance settings
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-17 16:06:19 +02:00
Markus Frank
d5b75187db add vIOMMU documentation
Signed-off-by: Markus Frank <m.frank@proxmox.com>
2024-04-11 16:47:21 +02:00
Fabian Grünbichler
611d594874 zfs: add missing "to"
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-04-08 10:22:20 +02:00
Aaron Lauterer
e309f17326 system-requirements: mention that SSDs with PLP should be used
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-03-29 13:49:09 +01:00
Thomas Lamprecht
a366aa5937 pvenode/wake-on-lan: mention defaults
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-28 17:50:26 +01:00
Christian Ebner
b6938de84a 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>
2024-03-28 17:38:36 +01:00
Christoph Heiss
93f1aa5d53 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>
2024-03-28 11:59:48 +01:00
Thomas Lamprecht
093bd98ffc bump version to 8.1.5
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-27 14:46:53 +01:00
Christoph Heiss
2a2e180c50 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>
2024-03-27 14:44:04 +01:00
Christoph Heiss
eb638de418 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>
2024-03-27 14:43:19 +01:00
Christoph Heiss
64b28d743f 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>
2024-03-27 14:42:09 +01:00
Christoph Heiss
2172bbb2be 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>
2024-03-27 14:42:04 +01:00
Thomas Lamprecht
c6d5bae84a update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-27 14:27:58 +01:00
Thomas Lamprecht
ff30375727 qm: rework import section, document new wizard
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-27 14:27:24 +01:00
Christoph Heiss
f3765da7a2 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>
2024-03-25 16:37:09 +01:00
Christoph Heiss
d7c14bfdd9 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>
2024-03-22 11:35:04 +01:00
Christoph Heiss
8cfa5e4c65 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>
2024-03-22 11:35:04 +01:00
Christoph Heiss
67d2d94e7c 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>
2024-03-22 11:35:04 +01:00
Christoph Heiss
520e361603 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>
2024-03-22 11:35:04 +01:00
Christoph Heiss
0d425d9d91 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>
2024-03-22 11:35:04 +01:00
Aaron Lauterer
93a7dcca0d 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>
2024-03-21 17:45:48 +01:00
Stefan Sterz
b1b6d1bc83 qm: add documentation on configuring multiqueue for windows guests
Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
2024-03-21 17:22:08 +01:00
Stefan Sterz
3d56535921 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>
2024-03-21 17:22:08 +01:00
Folke Gleumes
aefdf31cbc 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
2024-03-20 17:07:15 +01:00
Thomas Lamprecht
1ee5499467 bump version to 8.1.4
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 18:21:42 +01:00
Christoph Heiss
fcbe9ac485 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>
2024-03-06 18:15:55 +01:00
Christoph Heiss
08556a1d91 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>
2024-03-06 18:15:35 +01:00
Christoph Heiss
ef466ec91a 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>
2024-03-06 18:15:30 +01:00
Christoph Heiss
f9a0c435e2 gitignore: add package build outputs
.. much like it many other repos.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-06 18:15:19 +01:00
Dominik Csapak
2c462964df 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>
2024-03-06 18:14:23 +01:00
Thomas Lamprecht
c2eab5cc87 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>
2024-03-06 18:09:56 +01:00
Thomas Lamprecht
4a06054e39 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>
2024-03-06 17:59:56 +01:00
Thomas Lamprecht
a0fdba3295 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>
2024-03-06 17:59:31 +01:00
Thomas Lamprecht
450dc469d9 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>
2024-03-06 17:59:31 +01:00
Thomas Lamprecht
7409fad4db 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>
2024-03-06 17:59:31 +01:00
Lukas Wagner
dd5a4927e7 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>
2024-02-20 16:15:02 +01:00
Fabian Grünbichler
508a36f599 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>
2024-02-20 16:00:25 +01:00
Fabian Grünbichler
f358b68663 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>
2024-02-20 15:55:05 +01:00
Christoph Heiss
7c73a2099c 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>
2024-02-20 15:45:16 +01:00
Christoph Heiss
83a43f6ee8 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>
2024-02-20 15:45:16 +01:00
Christoph Heiss
b0e1acde66 installation: add note about memtest86+ incompatibility with secureboot
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-20 15:45:16 +01:00