Commit Graph

86 Commits

Author SHA1 Message Date
Aaron Lauterer
2c12c2b1d5 qm, vzdump: add notes regarding backups of windows and VSS
VSS in windows guests with additional backup software in the guest can
cause problems. By now the guest agent does support to use a different
VSS option. This way, one can switch to one that does not interfere with
other backup solutions.

Mention it in the docs and link to the wiki article that explains it.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Reviewed-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-28 11:30:24 +01:00
Christian Ebner
b38ef259d1 docs: drop experimental warning for change detection modes
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2024-11-17 18:36:04 +01:00
Maximiliano Sandoval
456b17fa59 docs: fix typos
Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2024-09-06 20:26:17 +02:00
Aaron Lauterer
ccf5335881 vzdump: change mode detection: move example cmd to block
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-07-11 13:37:10 +02:00
Aaron Lauterer
703300b980 vzdump: fleecing: rephrase manual vzdump example
and move the example command from inline to a block

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-07-11 13:35:57 +02:00
Aaron Lauterer
c67a94fcda vzdump: trailing whitespace cleanup
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-07-11 13:00:58 +02:00
Aaron Lauterer
6afac16cb7 vzdump: replace e.g. with for example
to be more aligned with our technical writing style guide.

[0] https://pve.proxmox.com/wiki/Technical_Writing_Style_Guide#Abbreviations

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-07-11 12:59:17 +02:00
Aaron Lauterer
107b5974ea vzdump: change detection mode: rephrase to avoid e.g.
We try to avoid "e.g.". Restructuring the sentence helps us to avoid it
alltogether.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-07-11 12:58:05 +02:00
Christian Ebner
2ce60240a4 vzdump: add section describing PBS change detection mode
Add a concise section about what PBS change detection mode is, where
to configure the option and what it affects, including a table with a
description of the modes.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2024-07-11 12:49:31 +02:00
Fiona Ebner
75659740b2 backup: mention where fleecing can be configured
Reported in the community forum:
https://forum.proxmox.com/threads/145955/post-658380

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-07-03 14:50:58 +02:00
Thomas Lamprecht
788fffd01c vzdump: drop overly scary & outdated warning about fleecing
This is pretty stable, albeit naturally an advanced and new technique.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-04-25 09:21:48 +02:00
Thomas Lamprecht
f85620dfc9 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>
2024-04-23 22:07:29 +02:00
Dominik Csapak
354b96de8c vzdump: add backup job screenshots
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2024-04-23 11:26:09 +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
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
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
Noel Ullreich
ff4ae05288 Fix spelling of command line/command-line
Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
Alexander Zeidler
501744f77d vzdump: mention new parameter 'pbs-entries-max'
configuring pbs-entries-max can avoid failing backups due to a high
amount of files in folders where a folder exclusion is not possible

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2023-09-18 16:53:52 +02:00
Fabian Grünbichler
613b6effc0 vzdump: mention file-restore log file
it was only documented in the proxmox-backup source code so far.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-09-08 10:39:52 +02:00
Lukas Wagner
1ba1e95244 add documentation for the new notification system
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-08-16 12:01:17 +02:00
Stefan Hanreich
e8889c3fb4 backup: Fix wrong unit for bandwidth limit
The correct unit for the bwlimit is actually Kibibyte per second
rather than Kibibit per second.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
2023-06-06 17:55:19 +02:00
Fiona Ebner
c730e973b7 tree-wide: switch to offical spelling of QEMU
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2022-12-20 09:35:58 +01:00
Fiona Ebner
9a0a393981 backup: mention max-workers performance setting
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2022-10-10 13:08:49 +02:00
Fiona Ebner
7f938fdb2b backup: merge sections describing jobs
keeping a short intro referring to the full section at the beginning.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2022-10-10 13:08:47 +02:00
Fiona Ebner
17125f65de backup: expand section for jobs
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2022-10-10 13:08:45 +02:00
Fiona Ebner
c8e632b6c9 backup: rework storage section, mentioning and recommending PBS
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2022-10-10 13:08:42 +02:00
Thomas Lamprecht
764a32850b backup: fix title case and add skelleton for new jobs section
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-30 11:28:05 +02:00
Dominik Csapak
b0bd901108 vzdump: add section about 'repeat-missed'
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Reviewed-by: Fabian Ebner <f.ebner@proxmox.com>
2022-06-17 17:30:20 +02:00
Thomas Lamprecht
3b5307ff0a vzdump: minimally rework backup notes, mostly formatting
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-04-28 15:17:23 +02:00
Fabian Ebner
3cb107b7fa vzdump: add section for notes and notes-template
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2022-04-28 15:07:35 +02:00
Fabian Ebner
2db55d5d11 vzdump/storage: mention protected backups limit and give an example
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2022-04-06 12:44:47 +02:00
Thomas Lamprecht
6bc5d54db7 backup: clarify that CLI means FS-level and highlight retention-note
plus some other related, small additions/changes

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-11-17 17:30:45 +01:00
Fabian Ebner
65c2112316 backup: add section for protection
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2021-11-17 15:33:02 +01:00
Dominik Csapak
de842c85d4 vzdump: change vzdump.cron to pvescheduler
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-11-11 16:21:40 +01:00
Thomas Lamprecht
c7941ea5a0 fix some typo/casing
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-04-30 09:44:13 +02:00
Oguz Bektas
3a433e9bb0 SPAM: [PATCH v2 docs] fix typos in various adoc files
checked for common misspellings. some of the changes (like favourite vs.
favorite or virtualization vs. virtualisation) are because of US vs. UK english

Reviewed-by: Dylan Whyte <d.whyte@proxmox.com>
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2021-04-29 13:26:28 +02:00
Stefan Reiter
1e03e70fac vzdump: add section about single file restore
Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
Reviewed-by: Dylan Whyte <d.whyte@proxmox.com>
2021-04-24 19:42:40 +02:00
Stefan Reiter
4b94ddd748 vzdump: add section about live-restore
Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
Reviewed-by: Dylan Whyte <d.whyte@proxmox.com>
2021-04-24 19:42:40 +02:00
Fabian Ebner
1658c67351 add encryption section for PBS
Some parts from the PBS docs where re-used.

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-25 15:55:32 +01:00
Fabian Ebner
98e5a1a4f9 vdzump: extend examples to also cover relative patterns
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-24 16:52:19 +01:00
Thomas Lamprecht
57c4d6b8e7 backup: refer to our hosted prune simulator
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-24 12:02:01 +01:00
Fabian Ebner
3a97636641 add documentation for the prune-backups option
adapted from the PBS docs, and mention that maxfiles is deprecated.

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-24 11:13:35 +01:00
Alwin Antreich
4edb84ec94 add section about backup compression algorithms
as a short description about the different algorithms in use by vzdump.

Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2020-05-07 19:59:50 +02:00
Dominic Jäger
b03b8bb6c3 backup restore: Fix syntax for bwlimit example
Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2019-12-20 10:35:20 +01:00
Thomas Lamprecht
64caa40130 vzdump: use {pve} for Proxmox VE
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-09-02 12:32:01 +02:00
Fabian Ebner
b26b1d126d Fix typos in vzdump.adoc
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2019-09-02 12:30:32 +02:00
David Limbeck
a35aad4add fix typos/wording
Signed-off-by: David Limbeck <d.limbeck@proxmox.com>
2018-08-23 14:32:54 +02:00
Wolfgang Link
de14ebffd2 Add documentation for CIFS Storage Plugin. 2018-04-05 15:08:12 +02:00
Thomas Lamprecht
3802f512b9 vzdump: fix few typos and polish
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2018-03-23 08:08:09 +01:00