Thomas Waldmann
d1bb892c3d
fix placement of return codes docs
2015-07-11 19:45:37 +02:00
Thomas Waldmann
05b21e3c0d
document return codes
2015-07-11 19:27:00 +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
77577b7417
add related projects, fix web site url
2015-06-29 23:30:36 +02:00
Thomas Waldmann
9ead4097cf
we are now on #borgbackup on chat.freenode.net
...
it seems like there is currently no bureaucracy required, freenode web site says group registration is suspended.
i also asked on the freenode channel, they said just make sure you are right here and use it. so we do that now.
2015-06-29 23:07:07 +02:00
Thomas Waldmann
6964799d13
borg create --compression 0..9 for variable compression
2015-06-25 22:16:23 +02:00
Thomas Waldmann
41a37e77db
add a misc docs directory, add a usecase for --chunker-params
2015-06-21 02:11:02 +02:00
Thomas Waldmann
54e8dd8419
misc chunker parameter changes
...
- use power-of-2 sizes / n bit hash mask so one can give them more easily
- chunker api: give seed first, so we can give *chunker_params after it
- fix some tests that aren't possible with 2^N
- make sparse file extraction zero detection flexible for variable chunk max size
2015-06-21 01:46:41 +02:00
Per Guth
e168b41406
Update installation.rst
2015-06-15 14:40:11 +02:00
Per Guth
041357e48a
Update installation.rst
...
Replicated Ubuntus dependency list.
2015-06-15 14:39:04 +02:00
Per Guth
1dc00e7937
Update installation.rst
...
please test on fresh installation.
2015-06-15 13:09:39 +02:00
Thomas Waldmann
21cfdde73b
adjust docs theme colours for note divs
2015-06-11 22:26:02 +02:00
Thomas Waldmann
dd78e1a56e
improve docs, usage help, changelog
2015-06-11 22:18:12 +02:00
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
Jonas Borgström
8cc9c02baa
Update faq regarding acl support
...
Closes #66
2014-05-03 23:27:01 +02:00
Jonas Borgström
e2452c3f83
docs: Make font link protocol agnostic
2014-04-08 21:20:33 +02:00
Jonas Borgström
02a8172eee
docs: More improvements
2014-04-06 22:47:22 +02:00
Jonas Borgström
ead1511948
docs: More documentation improvements
2014-04-06 15:16:25 +02:00
Jonas Borgström
2b91d6620a
docs: quickstart improvements
2014-04-06 14:03:14 +02:00
Jonas Borgström
7231315f08
docs: added to questions to the faq
...
closes #64
2014-04-05 21:08:11 +02:00
Jonas Borgström
f685eb162c
docs: New layout and some initial documentation improvements
2014-04-05 20:24:46 +02:00
Jonas Borgström
c20aba8c4c
docs: Add link to Slackware packages
2014-03-12 21:00:30 +01:00
Jonas Borgström
fe9e2e3303
website: github ribbon should be a https link
2014-03-09 22:39:44 +01:00
Jonas Borgström
10ef7fe0f2
Move website to attic-backup.org
2014-03-09 15:12:07 +01:00
Jonas Borgström
3982c34e6c
Improve attic check documentation
...
Closes #24 .
2014-02-26 23:13:48 +01:00
Dan Christensen
4c4018e1d7
Update prune documentation to use new command line options,
...
and also to say that the time that matters is the time each
backup completes.
2014-02-24 19:32:18 -05:00
Jonas Borgström
e458f859d3
Added command line deprecation functionality
...
The following deprecations are currently handled:
- attic verify -> attic extract --dry-run
- attic prune --hourly|daily|... -> attic prune --keep-X
2014-02-19 22:53:44 +01:00
Jonas Borgström
052e4f2074
Remove some autogenerated files
2014-02-18 23:10:32 +01:00
Jonas Borgström
7b31f23722
Replace verify command with "extract --dry-run"
...
closes #25
2014-02-18 21:33:06 +01:00
Dan Christensen
2d4382b2ee
Updates to quickstart.rst, including sshfs locking warning
2014-02-09 16:15:27 -05:00
Jonas Borgström
faedaf8160
Basic repository consistency check functionality.
...
Still no archive metadata validation or repair functionality.
2014-02-05 00:04:30 +01:00
Dan Christensen
0b9969d162
Various minor documentation updates: mention sshfs, Linux packages,
...
minor changes to prose, etc.
2014-02-03 21:26:36 -05:00
Dan Christensen
6b639e4c22
Update prune docs and a few other things in usage.rst.
2014-02-03 20:11:47 -05:00
Jonas Borgström
1520a911af
Add a "fork me on Github" ribbon.
2014-01-30 20:32:43 +01:00
Jonas Borgström
9c80089c04
Documentation update.
...
Added links to Debian, Ubuntu and Arch linux packages and
added a comment about Cython dependency when installing from git.
Closes #21 .
2014-01-26 12:51:56 +01:00
Jonas Borgström
3a064aba56
Fix sorting of segment names to ignore NFS left over files.
...
Closes #17 .
2014-01-03 14:47:44 +01:00
Jonas Borgström
530dfd1558
Documentation update
2013-10-03 21:00:54 +02:00
Jonas Borgström
012e0d4153
New syntax to enable repository encryption
2013-08-10 13:02:20 +02:00
Jonas Borgström
9ebeb0f98d
Documentation: Added info about mailing list
2013-08-06 22:17:28 +02:00
Jonas Borgström
3b4875cf2e
Start using versioneer for version numbers
2013-08-05 23:05:15 +02:00
Jonas Borgström
781a9552f0
Remove nature.css and make sure docs folder is included by sdist
2013-08-05 22:43:50 +02:00
Jonas Borgström
a51a10a96c
More documentation improvements.
2013-08-04 23:20:22 +02:00
Jonas Borgström
a35339f2c2
Renamed commands.rst to usage.rst
2013-08-04 21:23:12 +02:00
Jonas Borgström
b6c8392c03
More documentation work
2013-08-03 13:05:06 +02:00
Jonas Borgström
e016a4ee92
A new Attic sphinx theme
2013-08-03 13:04:57 +02:00
Jonas Borgström
41c18f950b
Document ATTIC_PASSPHRASE
2013-07-30 21:51:21 +02:00
Jonas Borgström
43a4bf6829
Updated documentation
2013-07-30 13:54:04 +02:00
Jonas Borgström
5df3e91474
Bump version number to 0.6.1
2013-07-19 13:22:22 +02:00
Jonas Borgström
b718a443a8
Project rename
2013-07-09 20:14:18 +02:00
Jonas Borgström
a9272ce913
Update documentation
2013-07-08 21:19:50 +02:00