From 09beb64f344c4b21f8a212f49ab6998ff4fbdc22 Mon Sep 17 00:00:00 2001 From: Milkey Mouse Date: Sat, 10 Mar 2018 17:19:46 -0800 Subject: [PATCH 1/2] Add quickstart introduction to repositories & archives (fixes #3620) --- docs/quickstart.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 0fbf36955..10598ec7a 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -13,6 +13,17 @@ A step by step example .. include:: quickstart_example.rst.inc +Archives and repositories +------------------------- + +A Borg archive is used similarly to a tarball in a simpler backup system. When ``borg create`` +is run on a path, the current state of the files therein is stored in an archive. One can later +extract or mount an archive to restore from a backup. + +Repositories are self-contained stores of archives that can be stored locally or remotely. +Archives stored inside a repository are deduplicated with one another, which is why Borg +shines for incremental backups. + Important note about free space ------------------------------- From d41c9296c0f32412273b3e5c55210de764c1a254 Mon Sep 17 00:00:00 2001 From: Milkey Mouse Date: Sat, 24 Mar 2018 12:05:47 -0700 Subject: [PATCH 2/2] fixup! Add quickstart introduction to repositories & archives (fixes #3620) --- docs/quickstart.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 10598ec7a..dbd7a64dc 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -16,13 +16,15 @@ A step by step example Archives and repositories ------------------------- -A Borg archive is used similarly to a tarball in a simpler backup system. When ``borg create`` -is run on a path, the current state of the files therein is stored in an archive. One can later -extract or mount an archive to restore from a backup. +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 self-contained stores of archives that can be stored locally or remotely. -Archives stored inside a repository are deduplicated with one another, which is why Borg -shines for incremental backups. +*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 -------------------------------