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>
This commit is contained in:
Fabian Grünbichler 2024-06-11 14:17:37 +02:00 committed by Fiona Ebner
parent a0d52904cd
commit 2eb64ba31c

View File

@ -64,8 +64,11 @@ Optional.
master-pubkey:: master-pubkey::
A public RSA key used to encrypt the backup encryption key as part of the A public RSA key used to encrypt the backup encryption key as part of the
backup task. The encrypted copy will be appended to the backup and stored on backup task. Will be saved in a file under
the Proxmox Backup Server instance for recovery purposes. `/etc/pve/priv/storage/<STORAGE-ID>.master.pem` with access restricted to the
root user.
The encrypted copy of the backup encryption key will be appended to each backup
and stored on the Proxmox Backup Server instance for recovery purposes.
Optional, requires `encryption-key`. Optional, requires `encryption-key`.
.Configuration Example (`/etc/pve/storage.cfg`) .Configuration Example (`/etc/pve/storage.cfg`)
@ -77,6 +80,8 @@ pbs: backup
fingerprint 09:54:ef:..snip..:88:af:47:fe:4c:3b:cf:8b:26:88:0b:4e:3c:b2 fingerprint 09:54:ef:..snip..:88:af:47:fe:4c:3b:cf:8b:26:88:0b:4e:3c:b2
prune-backups keep-all=1 prune-backups keep-all=1
username archiver@pbs username archiver@pbs
encryption-key a9:ee:c8:02:13:..snip..:2d:53:2c:98
master-pubkey 1
---- ----
Storage Features Storage Features