dedup

commit 08da54bc98110a6bb2757e8aee340ad3e0704d91
parent f81b3debf25007a65bed7285027fe09a81dd5517
Author: sin <sin@2f30.org>
Date:   Thu,  2 May 2019 15:59:45 +0100

Explain how to use encrypted repos in README

Diffstat:
M
README
 | 
24
++++++++++++++++++++++++

1 file changed, 24 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -25,6 +25,30 @@ To extract a snapshot:
 
     dup-unpack -r repo foo > dir.tar
 
+Encrypting a dedup repository
+=============================
+
+First a secret key has to be generated using dup-keygen(1).  This is a
+256-bit symmetric key.
+
+    dup-keygen keyfile
+
+Initialize the repo and select XChaCha20-Poly1305 as the encryption
+algorithm:
+
+    dup-init -E XChaCha20-Poly1305 repo
+
+To create a snapshot:
+
+    tar -c ~/dir | dup-pack -k keyfile -r repo foo
+
+To extract a snapshot:
+
+    dup-unpack -k keyfile -r repo foo > dir.tar
+
+All tools understand the -k option when operating on an encrypted
+dedup repository.
+
 Portability
 ===========