mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
1,613 Commits 9 Branches 135 Tags 55 MiB
Commit Graph

286 Commits

Author SHA1 Message Date
Thomas Waldmann 30bd38b51b update linux glibc requirement (binaries built on debian7 now) 2015-10-07 15:08:09 +02:00
Thomas Waldmann 6299f2d02c docs: pyinstaller 3.0 is released now 
this or any later 3.x or git master checkout should work.
 2015-10-07 03:42:08 +02:00
Thomas Waldmann 28a85bf0aa update website sidebar link also 2015-10-06 21:53:20 +02:00
Thomas Waldmann ee66c4c435 remove docs about binary wheels 
we stop supporting them, because there are better alternatives:
- use a distribution package (from your linux distribution), if available
- use a pyinstaller binary provided by us (they include all you need in 1 file and
  thus have better compatibility properties and are easier to install than a wheel)
- install from source (pypi or git) if everything else fails
 2015-10-06 21:49:21 +02:00
Antoine Beaupré a0ef4e25dd add support for arbitrary SSH commands (attic#99) 
while SSH options can be specified through `~/.ssh/config`, some users
may want to use a completely different SSH command for their backups,
without overriding their $PATH variable. it may also be easier to do
ad-hoc configuration and tests that way.

plus, the POLA tells us that users expects something like this to be
supported by commands that talk to ssh. it is supported by rsync, git
and so on.
 2015-10-05 18:54:00 -04:00
Thomas Waldmann bf3cf21ac5 docs: add warning about prune 2015-10-03 14:12:16 +02:00
TW d27da99208 Merge pull request #230 from anarcat/api 
add automatically generated API
 2015-10-01 19:52:15 +02:00
Antoine Beaupré a2cf0025c2 add automatically generated API 
this is a crude hack for now, and could use a better table of contents

but at least we have some way of linking and showing the different
internal functions

the next phase here is obviously to document that API through the
addition of docstrings. a static api.rst could also be easier to read,
but maybe that could go through some docstrings as well, to be tested
 2015-09-30 18:35:57 -04:00
Antoine Beaupré b72d955c3e remove api file introduced by mistake in #228 2015-09-30 18:33:45 -04:00
Antoine Beaupré 50e7d0f345 more human-readable output in usage generation 2015-09-30 17:42:18 -04:00
Antoine Beaupré e3433f433c generate usage include files only as needed 
right now, the update_usage script regenerates the usage files at
every call

by moving this into the makefile, we make those files be generated
only when the source file change, which makes testing docs much faster
 2015-09-30 17:30:56 -04:00
Thomas Waldmann bc9679f0e5 development docs: update / fix / add Vagrant section 
thanks to level323 for the vagrant docs
 2015-09-30 17:38:51 +02:00
Thomas Waldmann ba5fa0ba99 update / improve / reformat FAQ 
- reduce redundancy (platforms are documented in README.rst)
- reformat to 80 chars width
- clarify checkpoints
- remove workarounds for stuff that was fixed
 2015-09-30 17:13:22 +02:00
Thomas Waldmann 524ca297ea document binary and non-binary requirements 2015-09-28 00:22:20 +02:00
Thomas Waldmann 86502d2729 docs: explain --read-special in more detail, fixes #220 2015-09-26 14:24:37 +02:00
Thomas Waldmann 22f335e0a0 docs: add how to build wheels and standalone binaries 2015-09-21 21:48:46 +02:00
Thomas Waldmann 7dbe2b80b3 docs: add a note about the single-file binaries 2015-09-21 21:28:18 +02:00
Thomas Waldmann 4410f1c3c3 docs: must run make html after tagging, so the html titel says correct version 2015-09-19 22:38:00 +02:00
Thomas Waldmann 688488d62d docs: must run make html before release 2015-09-19 22:20:41 +02:00
Thomas Waldmann 0f68f1ccd1 add docs about release process 2015-09-19 21:35:02 +02:00
Thomas Waldmann fb8d1cc602 also mention libattr 
ACLs are implemented as xattrs, so libattr is pulled in as a dependency of libacl.
 2015-09-19 20:31:26 +02:00
Thomas Waldmann ff64b4c424 be more precise about OpenBSD/NetBSD support 
xattrs/ACLs need platform specific code and new have none (yet) for them.
 2015-09-16 11:53:53 +02:00
Thomas Waldmann f138d06dd5 more platform support, works on py 3.5 
xattrs and ACLs on OpenBSD and NetBSD need development or adaptation of
the platform-specific code.
 2015-09-16 11:44:53 +02:00
Thomas Waldmann cff7dffc95 detect lz4.h header file location 
use similar code as for openssl headers
 2015-09-12 19:38:38 +02:00
Thomas Waldmann d74da7c031 llfuse 0.41 install troubles on some platforms, require < 0.41 
UnicodeDecodeError exception due to non-ascii llfuse setup.py
 2015-09-12 19:26:46 +02:00
Thomas Waldmann e8f4fe0b88 pkg-config is needed for llfuse installation 2015-09-12 19:19:52 +02:00
TW 947fc095d8 Merge pull request #183 from ThomasWaldmann/borg-repo-envvar 
BORG_REPO env var support
 2015-09-06 21:51:24 +02:00
Thomas Waldmann b3f5231bac BORG_REPO env var support 
sets the default repository to use, e.g. like:

export BORG_REPO=/mnt/backup/repo
borg init
borg create ::archive
borg list
borg mount :: /mnt
fusermount -u /mnt
borg delete ::archive
 2015-09-06 18:18:24 +02:00
Thomas Waldmann 0b1035746e read special files as if they were regular files, update docs, closes #79 
do not use the files cache for such special files
 2015-09-06 00:29:46 +02:00
Thomas Waldmann 2332ee433e remove docs/misc/create_compression.txt 
outdated - it just showed different levels of zlib compression,
but not we additionally have "lzma", "lz4" and "none" compression.
the "usage" and "internals" docs give some hints about them, too.
 2015-08-29 13:35:58 +02:00
Thomas Waldmann d2e5ce90f2 add FAQ entry about OS X commandline vs. HFS+ encoding issue, see #143. 
a real fix for this is in development, but needs some time.
 2015-08-29 05:41:41 +02:00
Thomas Waldmann 1a949eab3e docs: internals: improve structure and formatting 2015-08-29 04:23:57 +02:00
Thomas Waldmann ddd0e2700b docs: improve faq and support section 2015-08-29 04:16:03 +02:00
Thomas Waldmann c823554b6b docs: usage: improved formatting, cosmetic changes 2015-08-29 04:00:22 +02:00
Thomas Waldmann e4dc482598 docs: quickstart: key modes, cosmetic changes 2015-08-29 03:39:53 +02:00
Thomas Waldmann 8a483511cb docs: theme: use a lighter green 2015-08-29 03:01:39 +02:00
Thomas Waldmann cebb61d8dd docs: add pypi, wheel, dist package based install docs 2015-08-29 02:55:09 +02:00
Thomas Waldmann 79d7f49a44 docs: split install into system-specific preparations and generic instructions 2015-08-29 01:17:19 +02:00
Thomas Waldmann ee58d4f074 docs: be more specific about Debian/Ubuntu release 2015-08-29 00:45:54 +02:00
Thomas Waldmann fdc18eb0a0 support docs: write some words about BountySource 2015-08-21 00:25:24 +02:00
Thomas Waldmann 2402a2269e update docs about fakeroot 2015-08-20 23:39:40 +02:00
Thomas Waldmann 1e11e24fc4 document locking system 2015-08-20 22:37:38 +02:00
Per Guth 0926c2821f docs: installation: korora/fedora -> `lz4-devel` 2015-08-17 17:10:37 +02:00
Per Guth 8cf0ead693 docs: added `favicon.ico` 2015-08-17 12:58:49 +02:00
Per Guth 1c7b5b23f4 minor change in copyright notice 2015-08-17 11:31:42 +02:00
Thomas Waldmann 1d16e7a37c compression: update / refine docs 2015-08-15 15:45:15 +02:00
Thomas Waldmann bf757738f7 Merge branch 'master' into compression 2015-08-14 23:24:04 +02:00
Thomas Waldmann feff0f0c94 install docs: replace hack for llfuse with proper solution 
found out why it could not install llfuse into virtual env: it always complained about
not being able to find fuse.pc - which is part of libfuse-dev / fuse-devel and was missing.

once one adds the fuse dev stuff, llfuse installs to virtual env without problems.
 2015-08-12 03:15:44 +02:00
Thomas Waldmann 8b1d46caa4 docs: more about compression 2015-08-10 20:36:21 +02:00
Thomas Waldmann 8af3aa3397 merged master 2015-08-09 23:51:46 +02:00
Thomas Waldmann 822379048f added some sidebar links 2015-08-09 22:32:14 +02:00
Thomas Waldmann 4c668a85b6 update docs copyright (to be same as project copyright) 2015-08-09 14:16:56 +02:00
Thomas Waldmann dcdcbda87d try if readthedocs finds the borg package this way 2015-08-06 15:17:07 +02:00
Thomas Waldmann e3baeefa1b docs: reorganize sidebar, prev/next at top 2015-08-06 13:10:56 +02:00
Thomas Waldmann d65ca51d54 deduplicate and refactor the docs 
README.rst (shown on github and also at the start of the html docs) shall
be like an elevator speech - convince readers in a very short time.
this is most important, everything else can come after we got the reader's interest.

include README into docs to avoid duplication.
also include CHANGES into docs.
add developer docs, move examples from tox.ini there
add separate support docs
remove glossary, most of what was there can be understood by an admin from context
move attic and compatibility note to the end
 2015-08-06 12:59:51 +02:00
Thomas Waldmann 27de1b0a43 add a wrapper around liblz4 2015-08-01 15:07:54 +02:00
Thomas Waldmann 9d21e4ad69 docs: add some words about resource usage (fixed wording) 2015-07-29 21:48:57 +02:00
Thomas Waldmann 1e097bfd6b docs: add some words about resource usage 2015-07-29 21:39:20 +02:00
Thomas Waldmann 729cc4d82d document how to backup raw disk 2015-07-27 22:27:13 +02:00
Thomas Waldmann fb998cbd66 docs: add note about how to run borg from virtual env 2015-07-26 14:47:18 +02:00
Thomas Waldmann 859c33d42b docs: add solutions for (ll)fuse installation problems 2015-07-25 19:07:24 +02:00
Thomas Waldmann 12a50bc6fe tested and updated cygwin docs, thanks to fvia 2015-07-25 18:38:16 +02:00
Thomas Waldmann 59c519b3bb remove outdated locking problem warning 2015-07-25 15:37:30 +02:00
Thomas Waldmann 2907dd0094 add BountySource link 2015-07-17 22:55:28 +02:00
Thomas Harold e3472a248a Fix format issue in installation.rst for Cygwin 
Fixed formatting issue in installation.rst where packages were listed all on one line.
 2015-07-16 16:40:33 -04:00
Thomas Waldmann 9b9c808713 fixed some minor issues found by pycharm/pytest-flakes 2015-07-15 11:30:25 +02:00
Thomas Waldmann 50c0bb0c32 Merge branch 'master' into keyfile-in-repo 2015-07-15 00:05:18 +02:00
Thomas Waldmann b644565546 repo key mode (and deprecate passphrase mode), fixes #85 
see usage.rst change for a description and why this is needed
 2015-07-15 00:01:07 +02:00
Thomas Waldmann f330b4bd2a some doc updates, see below 
faq about redundancy / integrity
compression is optional
having borg installed on backup server is optional (but faster)
cygwin installation tipps
do not document passphrase encryption mode example, use keyfile mode
 2015-07-14 21:31:35 +02:00
Thomas Waldmann 3c34ef8145 clarify that borg extract uses the cwd as extraction target 2015-07-14 20:25:10 +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
Thomas Waldmann afae720112 document environment variables 2015-07-11 20:08:22 +02:00
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