Commit Graph

15 Commits

Author SHA1 Message Date
Daniel Kral
528fe5d7f3 storage: add remaining pvesm scan command examples
Add an example for the `pvesm scan` command to storage plugins, i.e.
GlusterFS and PBS, where it exists in the CLI but is not mentioned yet
in the documentation.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250304100915.55114-3-d.kral@proxmox.com
2025-04-07 15:20:37 +02:00
Daniel Kral
500faf0743 storage: make description of storage CLI examples more consistent
Make the text for `pvesm scan` and `pvesm add` command examples more
consistent by introducing `pvesm scan` with "You can get ... with", as
it is already done for other storage plugins, and changing from past
tense to present tense in existing descriptions for the `pvesm add` as
recommended in the Technical Writing Style Guide for instructions [0].

While at it, replace the term "share" with the more appropriate
"datastore" for the example in the PBS section.

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

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250304100915.55114-1-d.kral@proxmox.com
2025-04-07 15:20:37 +02:00
Fabian Grünbichler
2eb64ba31c fix #5525: storage: pbs: improve master-pubkey docs
add the information that the parameter is special like other secret ones, and
add the resulting config to the example to make it even more obvious.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
[FE: remove equals sign from config example]
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-07-24 15:21:02 +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
Noel Ullreich
451839ed51 Consistency of USB flash drive spelling
To be consistent, replaced all synonyms of USB flash drive (e.g. thumb
drive, drive, stick)

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
Matthias Heiserer
135789c093 consistently use 'web interface' (two words)
Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-11-09 15:39:53 +01:00
Matthias Heiserer
73d19b4255 pbs storage: fix typo
Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
2022-05-02 15:45:47 +02:00
Fabian Ebner
5c85b0a168 storage: switch to prune-backups in examples
because maxfiles is deprecated.

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2022-04-06 12:44:47 +02:00
Fabian Grünbichler
8200df48fb pbs: add information about master key support
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2021-06-23 09:27:31 +02:00
Fabian Ebner
f1edca2e21 pbs storage: consistently talk about the storage key
instead of master key.

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-26 10:41:16 +01:00
Thomas Lamprecht
55ebc079f7 add PBS storage edit encryption screenshot
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-25 16:08:32 +01:00
Thomas Lamprecht
2309c05057 pbs: adapt examples heading
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-25 16:00:51 +01: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
Thomas Lamprecht
921926036a pbs: fix password and encryption key file location
we namespaced them after initial addition.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-23 11:07:37 +01:00
Thomas Lamprecht
93e1d33ef7 add initial PBS docs
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-13 11:54:36 +02:00