Browse Source

Add quickstart introduction to repositories & archives (fixes #3620)

(cherry picked from commit 09beb64f344c4b21f8a212f49ab6998ff4fbdc22)
Milkey Mouse 7 years ago
parent
commit
8e5833f91b
1 changed files with 13 additions and 0 deletions
  1. 13 0
      docs/quickstart.rst

+ 13 - 0
docs/quickstart.rst

@@ -13,6 +13,19 @@ A step by step example
 
 
 .. include:: quickstart_example.rst.inc
 .. include:: quickstart_example.rst.inc
 
 
+Archives and repositories
+-------------------------
+
+A *Borg archive* is the result of a single backup (``borg create``). An archive
+stores a snapshot of the data of the files "inside" it. One can later extract or
+mount an archive to restore from a backup.
+
+*Repositories* are filesystem directories acting as self-contained stores of archives.
+Repositories can be accessed locally via path or remotely via ssh. Under the hood,
+repositories contain data blocks and a manifest tracking which blocks are in each
+archive. If some data hasn't changed from one backup to another, Borg can simply
+reference an already uploaded data chunk (deduplication).
+
 Important note about free space
 Important note about free space
 -------------------------------
 -------------------------------