Commit graph

73 commits

Author SHA1 Message Date
Alexander Meshcheryakov
61f0acd93b Simplified rate limiting wrapper in FAQ
Exporting $RATE as environment variable is not need in this case.

And example does not use any bash specific features.
It should use default system shell instead.

(cherry picked from commit d3533de5f7)
2017-09-26 23:55:25 +02:00
TuXicc
8c1da1adda Added BORG_PASSCOMMAND environment variable (#2573)
(cherry picked from commit 578b76af3a)
2017-06-26 04:08:42 +02:00
Marian Beermann
9aa3fe19d7 docs: faq: specify "using inline shell scripts"
(cherry picked from commit 3faafb1dee)
2017-06-26 03:21:24 +02:00
Fredrik Mikker
8b2c9fd7db 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>

(cherry picked from commit d01a8f54b6)

Plus typo-fix by @enkore.

(cherry picked from commit dfdf590445)
2017-04-03 21:38:53 +02:00
kmq
9f07d13c4a
document snapshot usage #2178 2017-02-27 00:30:26 +02:00
sherbang
33be583920 Update faq.rst 2017-01-07 18:48:48 -05:00
Marian Beermann
a2505517ee FAQ: fix link to changelog 2016-11-27 20:15:05 +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
enkore
ce72d24825 Clarify FAQ regarding backup of virtual machines (#1672) 2016-10-02 20:11:34 +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
f70008238a link reference docs and faq about BORG_FILES_CACHE_TTL, fixes #1561 2016-09-03 19:23:59 +02:00
Thomas Waldmann
c834b2969c document archive limitation, #1452 2016-08-12 17:54:15 +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
5f7b466969 implement BORG_FILES_CACHE_TTL, update FAQ
raise default ttl to 20 (previously: 10).
2016-07-31 01:33:46 +02:00
Marian Beermann
c5fffbefff Platform feature matrix 2016-07-27 23:54:15 +02:00
Marian Beermann
b9952efd68 faq: 'A' unchanged file; remove ambiguous entry age sentence. 2016-07-15 00:43:49 +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
1fe3781186 backport some FAQ entries from master branch 2016-07-07 21:56:06 +02:00
Jens Rantil
2922948100 Update faq.rst
Fix misspelling.
2016-07-05 18:23:42 +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
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