mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
borg/docs/internals.rst

35 lines
1.2 KiB
ReStructuredText
Raw Normal View History

document key files in a new Internals page this is still incomplete as it only describes key files, but doesn't clearly say how chunks are encrypted or decrypted. this address parts of #29 but eventually that document should also cover #27, #28 and maybe #45
2014-12-16 14:10:21 +00:00
.. include:: global.rst.inc
.. _internals:
Internals
=========
document more internals, based on mailing list discussion this should address #27, #28 and #29 at least at a basic level it is mostly based on the mailing list discussion mentionned in #27, with some reformatting and merging of different posts.
2014-12-16 15:04:35 +00:00
This page documents the internal data structures and storage
mechanisms of |project_name|. It is partly based on `mailing list
improve internals docs
2015-06-07 00:15:13 +00:00
discussion about internals`_ and also on static code analysis.
docs: make internals.rst an index page Subsections: - Security - Data structures and file formats
2017-02-17 22:31:47 +00:00
Borg uses a low-level, key-value store, the :ref:`repository`, and
implements a more complex data structure on top of it, which is made
up of the :ref:`manifest <manifest>`, :ref:`archives <archive>`,
:ref:`items <item>` and data :ref:`chunks`.
improve internals docs
2015-06-07 00:15:13 +00:00
docs: make internals.rst an index page Subsections: - Security - Data structures and file formats
2017-02-17 22:31:47 +00:00
Each repository can hold multiple :ref:`archives <archive>`, which
represent individual backups that contain a full archive of the files
specified when the backup was performed.
document more internals, based on mailing list discussion this should address #27, #28 and #29 at least at a basic level it is mostly based on the mailing list discussion mentionned in #27, with some reformatting and merging of different posts.
2014-12-16 15:04:35 +00:00
docs: edited internals section a bit
2017-02-17 18:29:03 +00:00
Deduplication is performed globally across all data in the repository
docs: clarify metadata kind, manifest ops
2017-02-22 14:28:27 +00:00
(multiple backups and even multiple hosts), both on data and file
metadata, using :ref:`chunks` created by the chunker using the
Buzhash_ algorithm.
improve internals docs
2015-06-07 00:15:13 +00:00
docs: make internals.rst an index page Subsections: - Security - Data structures and file formats
2017-02-17 22:31:47 +00:00
To actually perform the repository-wide deduplication, a hash of each
docs: clarify metadata kind, manifest ops
2017-02-22 14:28:27 +00:00
chunk is checked against the :ref:`chunks cache <cache>`, which is a
hash-table of all chunks that already exist.
docs: internals: move toctree to after the introduction text this only changes the location on the page, nothing about how the TOC is arranged.
2017-02-22 14:53:15 +00:00
.. toctree::
:caption: Contents
internals/security
internals/data-structures
document JSON
2017-02-26 00:20:03 +00:00
internals/frontends