From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 00028672C0 for ; Mon, 9 Nov 2020 13:40:04 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id E4E10167E6 for ; Mon, 9 Nov 2020 13:40:04 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 7E9AD167DE for ; Mon, 9 Nov 2020 13:40:04 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 4877E401E8 for ; Mon, 9 Nov 2020 13:40:04 +0100 (CET) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Mon, 9 Nov 2020 13:39:58 +0100 Message-Id: <20201109123958.17637-1-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.022 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH docs] backup-client: encryption: discuss paperkey command X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 09 Nov 2020 12:40:05 -0000 adds a paragraph to the encryption section about encoding the master key into a qr code for printing Signed-off-by: Dylan Whyte --- docs/backup-client.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index a23535fa..1ef42898 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -365,9 +365,17 @@ To set up a master key: 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. In preparation for the worst case scenario, - you should consider keeping a paper copy of this key locked away in - a safe place. + lost along with the broken system. + +In preparation for the worst case scenario, you should consider keeping a paper +copy of your master key locked away in a safe place. The ``paperkey`` subcommand +can be used to create a QR encoded version of your master key. The following +command sends the output of the ``paperkey`` command to a text file, for easy +printing. + +.. code-block:: console + + proxmox-backup-client key paperkey --output-format text > qrkey.txt Restoring Data -- 2.20.1