From 09beb64f344c4b21f8a212f49ab6998ff4fbdc22 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) --- 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 -------------------------------