Browse Source

docs: update borg init examples

Thomas Waldmann 3 years ago
parent
commit
ce247526c2
1 changed files with 8 additions and 5 deletions
  1. 8 5
      docs/usage/init.rst

+ 8 - 5
docs/usage/init.rst

@@ -4,16 +4,19 @@ Examples
 ~~~~~~~~
 ::
 
-    # Local repository, repokey encryption, BLAKE2b (often faster, since Borg 1.1)
-    $ borg init --encryption=repokey-blake2 /path/to/repo
+    # Local repository, recommended repokey AEAD crypto modes
+    $ borg init --encryption=repokey-aes-ocb /path/to/repo
+    $ borg init --encryption=repokey-chacha20-poly1305 /path/to/repo
+    $ borg init --encryption=repokey-blake2-aes-ocb /path/to/repo
+    $ borg init --encryption=repokey-blake2-chacha20-poly1305 /path/to/repo
 
-    # Local repository (no encryption)
+    # Local repository (no encryption), not recommended
     $ borg init --encryption=none /path/to/repo
 
     # Remote repository (accesses a remote borg via ssh)
     # repokey: stores the (encrypted) key into <REPO_DIR>/config
-    $ borg init --encryption=repokey-blake2 user@hostname:backup
+    $ borg init --encryption=repokey-aes-ocb user@hostname:backup
 
     # Remote repository (accesses a remote borg via ssh)
     # keyfile: stores the (encrypted) key into ~/.config/borg/keys/
-    $ borg init --encryption=keyfile user@hostname:backup
+    $ borg init --encryption=keyfile-aes-ocb user@hostname:backup