Thomas Waldmann
7f46eb99aa
update docs about fixed chunker and chunker algo spec needed
2019-02-13 06:30:13 +01:00
Marian Beermann
d495b0fe75
docs: move introduction sentence
2017-06-19 10:01:55 +02:00
Marian Beermann
fec0958b7f
docs: internals: columnize rather long ToC
2017-06-05 15:41:42 +02:00
Marian Beermann
e80c0f7c5e
docs: fix way too small figures in pdf
2017-06-05 01:01:27 +02:00
Marian Beermann
f1709df8a9
docs/internals: layers image + description
2017-06-04 22:13:55 +02:00
Marian Beermann
9ed8e4b7a9
document JSON
2017-02-26 17:01:06 +01:00
Marian Beermann
19d50cff76
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 15:56:27 +01:00
Marian Beermann
1652525858
docs: clarify metadata kind, manifest ops
2017-02-22 15:29:33 +01:00
Marian Beermann
e5bbba573a
docs: make internals.rst an index page
...
Subsections:
- Security
- Data structures and file formats
2017-02-22 00:21:14 +01:00
Marian Beermann
63f17087c8
docs: edited internals section a bit
2017-02-22 00:13:46 +01:00
Marian Beermann
8e8d9d3f48
docs: add edited "Cryptography in Borg" and "Remote RPC protocol security" sections
...
The former section is a bit older (Nov 2016) and has been the piece
responsible for finding CVE-2016-10099, since while writing it I
wondered how the manifest was authenticated to actually
*be* the manifest. Well. There it is ;)
It has been edited to final form only recently and should now be ready
for review.
The latter section is new.
2017-02-16 20:27:16 +01:00
Thomas Waldmann
76c5f1a258
add more details about resource usage
2016-11-26 04:34:01 +01:00
Thomas Waldmann
c8b58e0fd8
improve cache / index docs, esp. files cache docs, fixes #1825
2016-11-24 01:53:23 +01:00
Carlo Teubner
1c666222a7
internals.rst: fix typos
2016-08-21 00:15:56 +02:00
Thomas Waldmann
c834b2969c
document archive limitation, #1452
2016-08-12 17:54:15 +02:00
Lee Bousfield
0a4a95eb17
Remove trailing whitespace
2016-07-27 10:05:51 -04:00
Thomas Waldmann
cf4d761042
docs: fix the highlighting
...
default is "python", that's why some help fragments and bash scripts looked strange.
2016-07-11 23:16:53 +02:00
Marian Beermann
7ed425dae0
Repository: cleanup on ENOSPC
2016-07-05 20:33:07 +02:00
Thomas Waldmann
435d30d61b
docs: updates and fixes
2016-02-01 03:22:02 +01:00
Thomas Waldmann
e06b7162c2
update docs / docstring about new key location
2016-01-28 23:15:49 +01:00
Thomas Waldmann
1fc99ec9cd
update docs, remove references to passphrase mode
2016-01-24 16:04:00 +01:00
Thomas Waldmann
169634f2ca
change the builtin default for --chunker-params, create 2MiB chunks, fixes #343
...
one of the biggest issues with borg < 1.0 was that it had a default target chunk
size of 64kiB, thus it created a lot of chunks, a huge chunk management overhead
(high RAM and disk usage).
2016-01-24 15:44:09 +01:00
Robin Schneider
32900c8679
Mi does stand for a IEC binary prefix e.g. 2^20.
2016-01-18 10:38:55 +01:00
Robin Schneider
1f49d16a71
Fixed my changes. Thanks to @ThomasWaldmann for the review!
2016-01-18 09:00:07 +01:00
Robin Schneider
8b9ae0ae92
More – → -- (CLI) fixes. Fixed spelling. AES-256 is used.
...
* According to the comment in `borg/key.py`.
2016-01-17 23:49:54 +01:00
Robin Schneider
19eb8e2d3b
Use `--option` in RST to not render "--" as "–".
2016-01-17 20:12:23 +01:00
Thomas Waldmann
888e078382
use finer chunker granularity for items metadata stream, fixes #547 , fixes #487
...
the items metadata stream is usually not that big (compared to the file content data) -
it is just file and dir names and other metadata.
if we use too rough granularity there (and big minimum chunk size), we usually will get no deduplication.
2016-01-15 20:56:21 +01:00
Thomas Waldmann
393e36b6da
updated internals docs: hash table max. load factor is 0.75 now
2015-12-13 19:58:32 +01:00
Thomas Waldmann
734dae80ef
improve chunker params docs, fixes #362
2015-11-02 19:47:09 +01:00
Thomas Waldmann
1a949eab3e
docs: internals: improve structure and formatting
2015-08-29 04:23:57 +02:00
Thomas Waldmann
1e11e24fc4
document locking system
2015-08-20 22:37:38 +02:00
Thomas Waldmann
1d16e7a37c
compression: update / refine docs
2015-08-15 15:45:15 +02:00
Thomas Waldmann
8b1d46caa4
docs: more about compression
2015-08-10 20:36:21 +02:00
Thomas Waldmann
b5bdb52b6a
update internals doc about chunker params, memory usage and compression
2015-07-14 00:43:35 +02:00
Thomas Waldmann
b2f460d591
fix filenames used for locking, update docs about locking
2015-07-13 23:20:46 +02:00
Jan Bader
8de8073345
Improve wording
2015-07-02 23:23:45 +02:00
Jan Bader
028e12473d
Update internals to reflect new --compression argument
2015-07-02 23:21:28 +02:00
Thomas Waldmann
83f520cfbe
improve internals docs
2015-06-07 02:15:13 +02:00
Thomas Waldmann
cb5c9b63b3
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS
...
use borg instead attic except at the places where it was used:
- as toplevel package name, directory name, file name
- to refer to original attic
remove sphinx upload make command, will be replaced by github.io site later
remove references to binary downloads and linux packages for now
remove some software name references, fix grammar
use borgbackup rather than borg-backup (or borg) in URLs,
less name collision issues, better search results, no validity issues with "-"
2015-05-13 15:02:33 +02:00
anarcat
ecee5a0b51
PDKF is a key derivation function
...
do not use the word "encryption", as it is actually closer to "hashing" anyways.
2015-03-05 09:00:06 -05:00
anarcat
5f882e976d
clarify the index memory usage analysis
...
it seems I extracted that data from [this mailing list post][] which
in turn takes it from [this github comment][].
[this mailing list post]: http://librelist.com/browser/attic/2014/5/6/questions-and-suggestions-about-inner-working-of-attic/
[this github comment]: https://github.com/jborg/attic/issues/26#issuecomment-35439254
2015-03-05 08:57:52 -05:00
anarcat
0ba86357d7
clarify that 4095 bytes is not a typo
...
i am actually assuming this right now, i haven't double-checked
2015-03-05 08:51:26 -05:00
anarcat
87cb4a4813
expand on the chunk id hash mechanism
...
according to @ThomasWaldmann, the algorithm varies according to whether encryption is enabled.
2015-03-05 08:48:23 -05:00
anarcat
8f8a035e93
fix a bunch of typos
...
this should fix the comments identified as `typo` and other small quirks found by @ThomasWaldmann.
2015-03-05 08:41:48 -05:00
anarcat
b7718f044d
Update internals.rst
2014-12-17 10:11:02 -05:00
Antoine Beaupré
e80e6c4dbb
better titles
2014-12-16 10:59:12 -05:00
Antoine Beaupré
b7c26735f7
fix formatting issues
2014-12-16 10:59:02 -05:00
Antoine Beaupré
d58b6ddf28
fix reference errors and remove reference to source code
2014-12-16 10:55:03 -05:00
Antoine Beaupré
688ba109ef
reorder to be more logical and more gentle
2014-12-16 10:35:53 -05:00
Antoine Beaupré
ddca3b856b
add a more gentle introduction
2014-12-16 10:30:57 -05:00
