sdn: unify installing sdn and ifupdown2 in one command

[pve-docs.git] / pve-storage-pbs.adoc

diff --git a/pve-storage-pbs.adoc b/pve-storage-pbs.adoc
index 5cbd56cbf9c7a208c2f79386d8f6fba2a86ce0c1..c22f5b320cf6e59f78b97701a8340599302f23ae 100644 (file)
--- a/pve-storage-pbs.adoc
+++ b/pve-storage-pbs.adoc
@@ -34,8 +34,8 @@ TIP: Do not forget to add the realm to the username. For example, `root@pam` or
 password::
 
 The user password. The value will be saved in a file under
-`/etc/pve/priv/<STORAGE-ID>.pw` with access restricted to the root user.
-Required.
+`/etc/pve/priv/storage/<STORAGE-ID>.pw` with access restricted to the root
+user. Required.
 
 datastore::
 
@@ -52,9 +52,10 @@ encryption-key::
 
 A key to encrypt the backup data from the client side. Currently only
 non-password protected (no key derive function (kdf)) are supported. Will be
-saved in a file under `/etc/pve/priv/<STORAGE-ID>.enc` with access restricted
-to the root user.  Use the magic value `autogen` to automatically generate a
-new one using `proxmox-backup-client key create --kdf none <path>`. Optional.
+saved in a file under `/etc/pve/priv/storage/<STORAGE-ID>.enc` with access
+restricted to the root user.  Use the magic value `autogen` to automatically
+generate a new one using `proxmox-backup-client key create --kdf none <path>`.
+Optional.
 
 .Configuration Example (`/etc/pve/storage.cfg`)
 ----
@@ -81,8 +82,52 @@ container.
 |backup        |n/a           |yes    |n/a       |n/a
 |===============================================================
 
-Examples
-~~~~~~~~
+[[storage_pbs_encryption]]
+Encryption
+~~~~~~~~~~
+
+[thumbnail="screenshot/storage-pbs-encryption-with-key.png"]
+
+Optionally, you can configure client-side encryption with AES-256 in GCM mode.
+Encryption can be configured either via the web interface, or on the CLI with
+the `encryption-key` option (see above). The key will be saved in the file
+`/etc/pve/priv/storage/<STORAGE-ID>.enc`, which is only accessible by the root
+user.
+
+WARNING: Without their key, backups will be inaccessible. Thus, you should
+keep keys ordered and in a place that is separate from the contents being
+backed up. It can happen, for example, that you back up an entire system, using
+a key on that system. If the system then becomes inaccessible for any reason
+and needs to be restored, this will not be possible as the encryption key will be
+lost along with the broken system.
+
+It is recommended that you keep your key safe, but easily accessible, in
+order for quick disaster recovery. For this reason, the best place to store it
+is in your password manager, where it is immediately recoverable. As a backup to
+this, you should also save the key to a USB drive and store that in a secure
+place. This way, it is detached from any system, but is still easy to recover
+from, in case of emergency. Finally, in preparation for the worst case scenario,
+you should also consider keeping a paper copy of your key locked away in a safe
+place. The `paperkey` subcommand can be used to create a QR encoded version of
+your key. The following command sends the output of the `paperkey` command to
+a text file, for easy printing.
+
+----
+# proxmox-backup-client key paperkey /etc/pve/priv/storage/<STORAGE-ID>.enc --output-format text > qrkey.txt
+----
+
+Because the encryption is managed on the client side, you can use the same
+datastore on the server for unencrypted backups and encrypted backups, even
+if they are encrypted with different keys. However, deduplication between
+backups with different keys is not possible, so it is often better to create
+separate datastores.
+
+NOTE: Do not use encryption if there is no benefit from it, for example, when
+you are running the server locally in a trusted network. It is always easier to
+recover from unencrypted backups.
+
+Example: Add Storage over CLI
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 // TODO: FIXME: add once available
 //You can get a list of exported CIFS shares with: