Thomas Waldmann
83f520cfbe
improve internals docs
2015-06-07 02:15:13 +02:00
Thomas Waldmann
8d0c5316f8
remove gh-pages Makefile target (not used)
2015-05-23 00:40:30 +02:00
Thomas Waldmann
cd3a76909d
faq: markup fixes, typos
2015-05-23 00:15:58 +02:00
Thomas Waldmann
f6442fe7f0
automate updating the borgbackup.github.io repo/website
...
cd docs ; make gh-io
2015-05-23 00:12:17 +02:00
Thomas Waldmann
9d1560f830
faq: updates, fixes
2015-05-22 23:56:29 +02:00
TW
da8a600b44
Merge pull request #25 from anarcat/fork-faq
...
explain the reason behind the fork
2015-05-22 23:05:08 +02:00
Antoine Beaupré
1edd5daef9
try to clarify link
2015-05-22 16:09:46 -04:00
Antoine Beaupré
ef373b120f
uppercase borg
2015-05-22 16:09:38 -04:00
Thomas Waldmann
906ea629f6
use py.test for testing, document it
...
locally (via tox) and also on travis ci.
2015-05-22 21:26:41 +02:00
Thomas Waldmann
5e98400a5a
fix all references to package name
...
use relative imports if possible
reorder imports (1. stdlib 2. dependencies 3. borg 4. borg.testsuite)
2015-05-22 19:21:41 +02:00
Antoine Beaupré
622e05bcee
add more information about the objectives of borg
2015-05-21 21:55:29 -04:00
Antoine Beaupré
22acb80bf9
explain the reason behind the fork
2015-05-21 21:49:44 -04:00
Thomas Waldmann
afc2dab71e
docs: more borg (or project_name)
2015-05-15 19:22:52 +02:00
Thomas Waldmann
56fd96589b
docs: make clear that remote repos used via ssh need a remote borg
2015-05-15 18:35:14 +02:00
Thomas Waldmann
37c923d4f0
misc. minor docs fixes
2015-05-15 01:50:45 +02:00
Thomas Waldmann
ff0c264e3e
fix small doc bug in prune examples, fix attic #306
...
--monthly is old/deprecated, --keep-monthly is new way.
2015-05-15 01:07:04 +02:00
Thomas Waldmann
f30d05fcd4
docs: install docs, faq improvements, other minor changes
2015-05-14 20:47:08 +02:00
Thomas Waldmann
c3370a5f07
improve docs about what is preserved and what not
...
UNIX domain sockets: explain why not, see attic issue #259
Symlinks: say that they are backed up as is and not followed, replacement for attic PR #294
Sparse files: explain what the "simple" in simple sparse file support means.
Plus some other explanations / mentions that were missing.
2015-05-14 18:48:14 +02:00
Thomas Waldmann
7cbff6925f
Documentation for 'attic serve'
...
Thanks to @lfam (attic PR #277 )!
Note: As I already had refactored a lot of these pathes you changed, it was easier
to just cherry pick the hunks with the other changes and apply them manually.
2015-05-14 17:36:53 +02:00
Thomas Waldmann
35d06afd6b
get rid of some .borg, be consistent with the backup repo name and path
...
it's pretty useless to have .borg as a directory extension, especially
since there is a README in there stating that this is a borg repo.
conistency:
"backup" is always used as relative backup repository path
"/mnt/backup" is always used as absolute repository path
2015-05-13 15:02:33 +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
Thomas Waldmann
f9d90482c4
merged master
2015-05-10 16:36:10 +02:00
Jonas Borgström
c79b5357f8
Improve installatoin instructions.
...
Specifically refer to pip3 instead of pip to avoid potential
confusion.
Also mention virtualenv
2015-04-27 22:35:06 +02:00
Thomas Waldmann
2fbef266f9
PR #156 - Merge branch 'doc-multi' of https://github.com/anarcat/attic into merge
2015-03-06 21:46:02 +01:00
Thomas Waldmann
9e77251d8c
PR #155 - Merge branch 'doc-encryption' of https://github.com/anarcat/attic into merge
2015-03-06 21:44:47 +01:00
Thomas Waldmann
c191ab189f
PR #153 - Merge branch 'dependencies' of https://github.com/anarcat/attic into merge
2015-03-06 21:36:44 +01:00
Thomas Waldmann
dd641ddc5b
PR #152 - Merge branch 'patch-1' of https://github.com/anarcat/attic into merge
2015-03-06 21:32:31 +01:00
anarcat
effab97d11
clarify that simultaneous backups may be a problem
2015-03-05 09:06:20 -05: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
Andraz Brodnik
6d64a1c76b
Fix documentation 'snapshot' to 'checkpoint'
...
In the code the string `checkpoint` is appended.
./attic/archive.py:137
2014-12-25 13:23:30 +01:00
anarcat
b7718f044d
Update internals.rst
2014-12-17 10:11:02 -05:00
Antoine Beaupré
2676c5fae8
document that multiple clients can backup to a single remote
...
answer comes from author here: http://librelist.com/browser//attic/2014/11/11/backing-up-multiple-servers-into-a-single-repository/#e96345aa5a3469a87786675d65da492b
this should address the last remaining issue in #60
2014-12-16 11:16:30 -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
Antoine Beaupré
1fde2a9771
add more details on how encryption works
2014-12-16 10:20:52 -05:00
Antoine Beaupré
fd56bf0887
document the repo config file and more storage properties
...
again taken from the mailing list, mostly
2014-12-16 10:20:23 -05:00
Antoine Beaupré
3f27c367fe
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 10:04:37 -05:00
Antoine Beaupré
9f0ed2a8c0
clarify some bits I missed
2014-12-16 10:03:20 -05:00
Antoine Beaupré
a8ab9c3445
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 09:10:34 -05:00
Antoine Beaupré
ac87360c7c
document better different dependencies
...
this is written with recent Ubuntu and Debian in mind, but should be
working everywhere. the idea here is to make sure anyone can install
this without knowning too much about ACLs or anything similar.
closes #135
2014-12-15 22:07:05 -05:00
anarcat
7d2ec79f95
document that hardlinks and symlinks are supported
...
it seems that hardlinks are supported, but were not explicitely documented in the documentation. the FAQ seems like the right place to do this. closes #133 .
2014-12-15 21:53:05 -05:00
kannes
aee2983c6e
fixing two typos
2014-11-19 13:09:53 +01:00
Jonas Borgström
7ce3290fb2
docs: Added link to prebuilt Linux binaries.
2014-06-29 14:24:45 +02:00