Commit Graph

202 Commits

Author SHA1 Message Date
Marian Beermann e8b74fcac3 docs: faq: fix title underlines 2017-04-28 10:39:32 +02:00
Steve Groesz 3eb3e31a8c FAQ to explain warning when running --repair (#2393)
FAQ to explain warning when running --repair, fixes #2341
2017-04-23 12:52:44 +02:00
rugk 5ddf7e7922 Add --one-file-system note for root backup 2017-04-15 12:38:58 +02:00
Marian Beermann dfdf590445 docs: typos 2017-03-25 15:42:00 +01:00
Fredrik Mikker d01a8f54b6 Added FAQ section about backing up root partition
Using borgbackup to backup the root partition works fine, just
remember to exclude non-essential directories.

Signed-off-by: Fredrik Mikker <fredrik@mikker.se>
2017-03-24 16:49:07 +01:00
Marian Beermann 988e452bc0 faq: mention --remote-ratelimit in bandwidth limit question 2017-03-16 15:13:03 +01:00
Marian Beermann 332f7898bc update docs for create -C default change 2017-02-26 23:07:31 +01:00
kmq f7d28e76a0
document snapshot usage #2178 2017-02-26 13:47:26 +02:00
Marian Beermann 3d79d441a5 faq: update Which file types, attributes, etc. are *not* preserved?
ext4 immutable has been supported for a while.
2017-02-16 16:49:26 +01:00
Marian Beermann 9e0ea92a9d docs: FAQ by categories as proposed by @anarcat in #1802
Usage & Limitations
Security
Common issues
Miscellaneous (only three items, two fork-related)

Note: This does not change any links to FAQ items.
2017-02-16 16:06:15 +01:00
Marian Beermann ecad0ed53a Merge branch '1.0-maint' into merge/1.0-maint
# Conflicts: ... everywhere ...
#	.travis.yml
#	Vagrantfile
#	borg/testsuite/key.py
#	docs/changes.rst
#	docs/quickstart.rst
#	docs/usage.rst
#	docs/usage/upgrade.rst.inc
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/crypto.pyx
#	src/borg/helpers.py
#	src/borg/key.py
#	src/borg/remote.py
#	src/borg/repository.py
#	src/borg/testsuite/archive.py
#	src/borg/testsuite/archiver.py
#	src/borg/testsuite/crypto.py
#	src/borg/testsuite/helpers.py
#	src/borg/testsuite/repository.py
#	src/borg/upgrader.py
#	tox.ini
2017-01-12 15:01:41 +01:00
sherbang 33be583920 Update faq.rst 2017-01-07 18:48:48 -05:00
Marian Beermann 9147c7038b update 1.1 beta CHANGES 2016-12-11 15:18:52 +01:00
Thomas Waldmann c83a124e65 Merge branch '1.0-maint' (into master) 2016-11-28 02:23:32 +01:00
Marian Beermann a2505517ee FAQ: fix link to changelog 2016-11-27 20:15:05 +01:00
Marian Beermann 05a52ec8ec
Merge branch '1.0-maint' into merge/1.0-maint 2016-11-09 23:56:54 +01:00
Antoine Beaupré 057ad07d4b fix a heading that was incorrectly set 2016-11-04 21:16:41 -04:00
Antoine Beaupré 19ae2a7870 add FAQ about security 2016-11-04 20:58:27 -04:00
Antoine Beaupré 7f9a147e46 move fork differences to FAQ
it seems now that the fork is more of historical value than a current
thing. people interested in the differences between borg and attic can
look in the FAQ, but I do not see why this is present in the README.

a new section regarding compatibility is created to keep that warning
in place.
2016-11-04 12:34:41 -04:00
Thomas Waldmann b0cc4fd74a Merge branch '1.0-maint' into merge-1.0-maint 2016-10-13 19:10:04 +02:00
enkore ce72d24825 Clarify FAQ regarding backup of virtual machines (#1672) 2016-10-02 20:11:34 +02:00
Thomas Waldmann 28c57f98c9 Merge branch '1.0-maint'
# Conflicts:
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/helpers.py
#	src/borg/testsuite/archiver.py
2016-09-25 17:30:55 +02:00
Stefano Probst deadc81729 Fix inconsistency in FAQ
The script in the FAQ is named pv-wrapper. But in the variable export pv-wrapper.sh was used.
2016-09-17 09:14:01 +02:00
Thomas Waldmann 1287d1ae92 Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	docs/development.rst
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/hashindex.pyx
#	src/borg/testsuite/hashindex.py
2016-09-14 02:53:41 +02:00
Thomas Waldmann f70008238a link reference docs and faq about BORG_FILES_CACHE_TTL, fixes #1561 2016-09-03 19:23:59 +02:00
Thomas Waldmann 8be6761c26 Merge commit 'feb7e2517ef7ec07cc638953a86c726aada7d37e' 2016-08-14 15:05:11 +02:00
Thomas Waldmann c834b2969c document archive limitation, #1452 2016-08-12 17:54:15 +02:00
Thomas Waldmann dbe862f3d8 Merge branch '1.0-maint' into merge-1.0-maint 2016-08-06 01:24:22 +02:00
Robert Marcano bc6050bc3c Add backup using stable filesystem names recommendation 2016-08-03 22:54:51 -04:00
Thomas Waldmann 8e222d8fd9 glibc compatibility: add FAQ entry, fixes #491 2016-07-31 14:42:34 +02:00
Thomas Waldmann ad38f794e0 add hint about borg with-lock to FAQ, fixes #1353 2016-07-31 02:04:56 +02:00
Thomas Waldmann 5f7b466969 implement BORG_FILES_CACHE_TTL, update FAQ
raise default ttl to 20 (previously: 10).
2016-07-31 01:33:46 +02:00
Thomas Waldmann 04ad1d1b0b use "part file", "part", etc. consistently
use .borg_part_N as filename to avoid collisions
2016-07-28 19:39:29 +02:00
Thomas Waldmann a7fca52f07 create part items rather than checkpoint items
checkpoint items: chunks abc, abcdef, abcdefghi, ....
part items: chunks abc, def, ghi

solves the "restore a big file over unstable connection issue" (not very comfortably, but
one can just extract one part after the other and concatenate them to get the full file)
2016-07-28 19:39:29 +02:00
Thomas Waldmann e5bd6cef20 add --consider-checkpoint-files option, update FAQ 2016-07-28 19:39:29 +02:00
Thomas Waldmann 0ea6745250 update faq: we have in-file checkpoints now
note: until there is some means to list and extract the (partial) checkpoint
items, we do not need to talk about them.
2016-07-28 19:39:29 +02:00
Marian Beermann ac8c8119a7
Merge branch '1.0-maint' into master 2016-07-28 00:29:43 +02:00
Marian Beermann c5fffbefff Platform feature matrix 2016-07-27 23:54:15 +02:00
Thomas Waldmann b33f8b4ff1 update faq with new 30 mins checkpoint interval 2016-07-21 21:03:22 +02:00
Marian Beermann b9952efd68 faq: 'A' unchanged file; remove ambiguous entry age sentence. 2016-07-15 00:43:49 +02:00
Marian Beermann 2e6eb63174
Merge branch '1.0-maint' into master 2016-07-14 01:28:26 +02: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
Thomas Waldmann fe627246e4 Merge branch '1.0-maint' 2016-07-08 12:13:52 +02:00
Thomas Waldmann 1fe3781186 backport some FAQ entries from master branch 2016-07-07 21:56:06 +02:00
Thomas Waldmann 12f55f4e9f Merge branch '1.0-maint' 2016-07-06 01:33:53 +02:00
Jens Rantil 2922948100 Update faq.rst
Fix misspelling.
2016-07-05 18:23:42 +02:00
Thomas Waldmann ed128e517b Merge branch '1.0-maint' 2016-06-25 17:18:14 +02:00
Thomas Waldmann b10025c6e5 document sshd settings, fixes #545 2016-06-24 23:30:27 +02:00
Thomas Waldmann f54f159db8 more details about checkpoints, add split trick, fixes #1171 2016-06-24 22:32:38 +02:00
Thomas Waldmann 4c52fcffcc faq: be more detailed about how checkpoints work, fixes #994 2016-05-05 18:59:03 +02:00
TW 571329e6ae Merge pull request #1013 from ThomasWaldmann/docs-fix-issue-links
faq: fix issue links
2016-05-05 18:31:04 +02:00
Thomas Waldmann 619654b802 faq: fix issue links 2016-05-05 18:16:32 +02:00
Thomas Waldmann 8304b8a591 FAQ: add entries about compromised machines and other troubles
also: fix append-only mode description - "multiple machines" and "central server" are over-specific and not required for this scenario.
2016-05-05 17:52:31 +02:00
Thomas Waldmann b6966a56dc document how to debug / file filesystem issues, fixes #664
if the filesystem issue can't be reproduced with a known-good,
local fs like ext4 on linux, the issue is likely not borg's fault.
2016-03-12 00:48:26 +01:00
Teemu Toivanen 9883b1af51 Faq: how to limit bandwidth
Example to faq documentation how bandwidth limiting can be done with pipeviewer.
2016-03-02 08:40:16 +02:00
Thomas Waldmann af2eaaabd4 update and improve docs
use the travis status image as png as svg does not show an image in firefox.
2016-02-27 17:22:56 +01:00
Thomas Waldmann 6db6c22cd4 docs: add faq entry and point to issue 636 2016-02-07 21:01:49 +01:00
Thomas Waldmann 435d30d61b docs: updates and fixes 2016-02-01 03:22:02 +01:00
Thomas Waldmann a2843bc939 docs: require python 3.4+
remove references to older pythons.
2016-01-24 14:57:48 +01:00
Thomas Waldmann 9ea79d738e add chunks.archive.d trick to FAQ 2016-01-23 22:57:26 +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 576348a9d4
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 22:31:08 +01:00
Hartmut Goebel 0c2e517e04 Update FAQ
Clarify that user and group of owner are stored as name, except if --numeric-owner is given.
2016-01-09 23:50:41 +01:00
Antoine Beaupré 48bb4c326d cross-reference the status oddity in the usage 2015-11-23 19:48:33 -05:00
Antoine Beaupré af7b17960e clarify documentation on the A status oddity 2015-11-23 19:44:54 -05:00
Thomas Waldmann 559c8908c1 add FAQ entry about unexpected 'A' status for unchanged file(s), fixes #403 2015-11-16 21:30:16 +01:00
Antoine Beaupré de9e9d14b7 soften environment security warning to a note, and cross-ref to avoid dupe 2015-10-19 16:25:24 -04:00
Antoine Beaupré 5cd5fa72f6 warn users about the environment on multi-user systems 2015-10-19 11:29:22 -04:00
Antoine Beaupré 3d906ab731 word-wrap a bullet list as paragraphs instead
it looks nicer that way
2015-10-19 11:17:10 -04:00
Antoine Beaupré b122fca580 use titles instead of definitions in FAQ
this way the titles show up in the table of contents and we can link
to individual entries
2015-10-19 11:12:14 -04:00
Antoine Beaupré 500c2a8a20 fix warnings in docs generation 2015-10-19 11:09:28 -04:00
Thomas Waldmann e7f25d7821 docs: use zlib,6 compression in some examples, fixes #275
This is what attic used by default, but borgbackup defaults to "no compression".

I just adjusted the command invocation, so we can keep the example output
(which shows that stuff was compressed).

Also: add FAQ item about compression.
2015-10-16 01:18:37 +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 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 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 ddd0e2700b docs: improve faq and support section 2015-08-29 04:16:03 +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 dd78e1a56e improve docs, usage help, changelog 2015-06-11 22:18:12 +02:00
Thomas Waldmann cd3a76909d faq: markup fixes, typos 2015-05-23 00:15:58 +02:00
Thomas Waldmann 9d1560f830 faq: updates, fixes 2015-05-22 23:56:29 +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
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 37c923d4f0 misc. minor docs fixes 2015-05-15 01:50:45 +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 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 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 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
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
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
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
Jonas Borgström 8cc9c02baa Update faq regarding acl support
Closes #66
2014-05-03 23:27:01 +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 b6c8392c03 More documentation work 2013-08-03 13:05:06 +02:00
Jonas Borgström 41c18f950b Document ATTIC_PASSPHRASE 2013-07-30 21:51:21 +02:00
Jonas Borgström b718a443a8 Project rename 2013-07-09 20:14:18 +02:00
Jonas Borgström 6052a1ed74 Minor docs tweaks 2013-07-03 22:38:07 +02:00
Jonas Borgström a32c5651c1 Docs improvements 2013-06-29 23:58:31 +02:00