From 8e5833f91bd0c74feafb113b8b7bf5f2e625676e Mon Sep 17 00:00:00 2001 From: Milkey Mouse Date: Sat, 10 Mar 2018 17:19:46 -0800 Subject: [PATCH] Add quickstart introduction to repositories & archives (fixes #3620) (cherry picked from commit 09beb64f344c4b21f8a212f49ab6998ff4fbdc22) --- docs/quickstart.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index cddf89971..956b16d4e 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -13,6 +13,19 @@ A step by step example .. 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 -------------------------------