Thalian
1d9dadd6b7
[DOCS] #4883 – Borg documentation downplays severity of Nonce reuse issue
...
Shorten the log info for deleting/keeping security info. Fix bad wording.
2020-04-03 17:40:30 +02:00
Thalian
41ecd1ae30
[DOCS] #3428 – Borg repo restore instructions needed
...
Adapt FAQ to the new delete option.
2020-03-26 20:02:31 +01:00
Thalian
df67b9ea11
[DOCS] #3428 – Borg repo restore instructions needed
...
Add new FAQ: A repo is corrupt and must be replaced with an older repo.
2020-03-25 19:56:51 +01:00
Thalian
a08b058fa0
[DOCS] #2929 – Document how to completely delete data
...
Add new FAQ entry that lists two ways how to really delete files from archives.
fixes #2929
2020-03-20 21:28:40 +01:00
Thalian
07c89cd794
[DOCS] #4941 – FAQ Borg config dir ( #5029 )
...
[DOCS] #4941 – How important is Borg config?
Add one FAQ with for $HOME/.config/borg, describing its content and how to take care of it.
Change "Default to" to "Defaults to".
Move TMPDIR to "Directories and files" section.
Add link to new FAQ for Borg config directory.
Add link to cache internals.
2020-03-16 00:17:46 +01:00
Milkey Mouse
f7f2493f75
docs: reflow some really long lines
...
I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and
reflowed them where reasonable. Line length in the docs isn't too important (it
doesn't matter once they're compiled), but it's nice not to have super-long
lines in one's editor.
2020-03-11 16:27:57 -07:00
finefoot
61b8234704
Add paragraph regarding cache security assumptions ( #4900 )
...
docs: tell about borg cache security precautions
2020-01-13 12:25:03 +01:00
Thalian
053b0db009
Add FAQ describing difference between a local repo vs. repo on a server.
...
Taken from a Q/A on the mailing list.
2019-12-23 13:13:08 +01:00
Thalian
87abe5d927
Doc/4532 faq retain original paths ( #4794 )
...
More general FAQ for backup and retain original paths, fixes #4532
2019-10-20 16:51:06 +02:00
Thalian
f07bcb1387
[DOC] #3866 - Add FAQ for preventing SSH timeout in extract. ( #4782 )
...
Add FAQ for preventing SSH timeout in extract, fixes #3866
2019-10-19 21:19:17 +02:00
Thalian
21dc2b9ca0
[DOC] #4591 - Improve password FAQ (decrease pw length, add -w 0 option to base64 to prevent line wrap).
2019-10-18 21:11:25 +02:00
Dmitry Astapov
dc1c8c062c
Reiterate that 'file cache names are absolute' in FAQ ( #4738 )
...
Reiterate that 'file cache names are absolute'
Drive home the point that relative source names does not save you from re-chunking if absolute pathnames change.
Also: mention bind mount solution.
2019-08-30 15:29:17 +02:00
ntova
627ca1376b
Fix various code blocks in the docs ( #4708 )
...
Fix various code blocks in the docs
- rst markup: put codeblock markup on separate line to make it better visible / separate it from normal text colons.
- borg help texts in archiver.py: put codeblock markup instead of colon - that way it looks like a single colon when using the cli help and also works as code block markup.
2019-08-09 23:13:11 +02:00
Thomas Waldmann
8622014188
timestamps in the files cache are now usually ctime, fixes #4583
2019-08-09 21:27:30 +02:00
Thomas Waldmann
897e81dbe9
extract: document limitation "needs empty destination", fixes #4598
2019-06-10 21:39:35 +02:00
Ori Livneh
92049f5405
Fix reference in FAQ
2019-05-12 13:35:31 -04:00
anarcat
10a4e011c0
add warnings on repository copies to avoid future problem like #4272 ( #4285 )
...
docs: add warnings about repo copies to avoid problems like #4272
2019-02-10 20:23:59 +01:00
Manuel Riel
7e7d74c1c1
Add new FAQ regarding change of compression settings. Fixes #4222 ( #4282 )
...
FAQ regarding change of compression settings. Fixes #4222
2019-01-31 05:58:33 +01:00
Manu
b37aceb469
Add FAQ regarding free disk space check. Fixes #3905
2019-01-31 12:45:41 +08:00
Manu
d13ddb224a
Update BORG_PASSCOMMAND example and clarify variable expansion. Fixes #4249
2019-01-30 10:12:47 +08:00
Marvin Gaube
2a4ed3f0e8
Note regarding borg version ( #3987 )
...
add a note regarding in-file checkpointing and borg versions
2018-07-20 16:25:16 +02:00
infectormp
8f6be74993
Add note from borg with-lock about copy repo ( #3749 )
...
docs: Improve FAQ about copying a repo
2018-04-19 15:34:11 +02:00
Thomas Waldmann
2588e50f0b
readme / docs: mention zstd
2017-12-18 22:55:00 +01:00
Thomas Waldmann
f2a1539f25
docs: fix examples with problematic option placements, fixes #3356
...
have options to the left OR to the right of all positional arguments,
but not on BOTH sides and not in between them.
2017-11-25 19:29:34 +01:00
TW
c5dc75ae23
Merge pull request #3312 from milkey-mouse/borg-config-cmd
...
Add borg config command
2017-11-24 16:56:15 +01:00
Milkey Mouse
5b47cf6fa5
Add borg config command ( fixes #3304 )
...
This command works similarly to "git config" - it parses repo and
cache configs to get, set, and delete values. It only works on local
repos so a malicious client can't e.g. override their storage quota
or reset the append_only flag.
Add tests for borg config
Add documentation for borg config
Change manual config edits -> borg config
There were a couple places in the documentation where it was advised
to edit the repository or cache config file, a process that is stream-
lined by borg config.
2017-11-23 14:51:54 -08:00
TW
483d3e8a8b
Merge pull request #3292 from milkey-mouse/document-ntfsclone
...
Add instructions for using ntfsclone
2017-11-23 22:07:15 +01:00
Milkey Mouse
c0edc60ca6
Move image backup-related FAQ entries to a new page
2017-11-23 12:14:35 -08:00
Milkey Mouse
759c8f77cf
Mention break-lock in checkpointing FAQ entry ( #3340 )
...
Mention break-lock in checkpointing FAQ entry, fixes #3328
2017-11-20 23:18:37 +01:00
TW
22ae15f5b4
Merge pull request #3327 from anarcat/faq-remove
...
add FAQ about removing old files and policies
2017-11-18 21:01:31 +01:00
Milkey Mouse
7cb36a20b4
Document sshfs rename workaround ( fixes #3315 ) ( #3325 )
...
Document sshfs rename workaround, fixes #3315
2017-11-18 20:57:39 +01:00
Antoine Beaupré
1a2906ae7e
add FAQ about removing old files and policies
...
This has been asked twice already this year:
https://mail.python.org/pipermail/borgbackup/2017q3/000796.html
https://mail.python.org/pipermail/borgbackup/2017q4/000891.html
... and I was asked again privately today, so this qualifies as FAQ to
me.
2017-11-18 09:08:37 -05:00
Tom Denley
c6591a7c06
Correct usage of "fewer" in place of "less"
2017-11-11 11:21:45 +00:00
Milkey Mouse
b0d68036c2
Add instructions for zerofree
2017-11-10 11:54:45 -08:00
Milkey Mouse
2b254abb39
Add instructions for ntfsclone ( fixes #81 )
2017-11-10 11:54:45 -08:00
Milkey Mouse
7b485c23f7
Clarify create --stats duration vs. wall time ( fixes #3301 ) ( #3303 )
...
clarify create --stats duration vs. wall time, fixes #3301
2017-11-10 17:44:34 +01:00
TW
ddecd4b618
Merge pull request #3182 from TBurchfield/master
...
Removal of |project_name|.
2017-11-01 02:41:02 +01:00
Milkey Mouse
87a9952f3b
Clarify using a blank passphrase in keyfile mode
2017-10-25 19:42:02 -07:00
8bit
8d830d069f
Removed all |project_name
...
| instances, replaced with Borg
2017-10-17 11:50:55 -05:00
Thomas Waldmann
e674822888
remove hardlinked symlinks warning, update docs, fixes #3175
...
the warning was annoying for people with a lot of such items and
they can not do anything about it anyway.
thus, just document this as a limitation.
2017-10-17 18:34:32 +02:00
Thomas Waldmann
fe08437337
faq: we do not implement futile attempts of ETA / progress displays
2017-10-05 22:19:39 +02:00
Alexander Meshcheryakov
f7ec13eabb
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.
2017-09-25 15:43:07 +03:00
Markus Engelbrecht
e157328228
Use correct casing for macOS
2017-09-03 20:04:28 +02:00
Markus Engelbrecht
aadb9cd2ee
Fix macOS keychain integration command
2017-09-03 20:03:11 +02:00
enkore
77797a2fbf
Merge pull request #2837 from milkey-mouse/fix392
...
Detail how to use macOS/GNOME/KDE keyrings for repo passwords (fixes #392 )
2017-07-24 11:03:00 +02:00
TW
d806d5213d
fix checkpoints/parts reference in FAQ, fixes #2859 ( #2861 )
...
fix checkpoints/parts reference in FAQ, fixes #2859
2017-07-23 01:47:13 +02:00
Milkey Mouse
756dea7e20
Detail how to use macOS/GNOME keyrings for repo passwords ( fixes #392 )
2017-07-19 14:20:28 -07:00
Marian Beermann
bde828d747
docs: faq: fix typo and strange link text
2017-06-18 02:34:25 +02:00
Marian Beermann
5aa865c8d8
docs: double backticks for --options
2017-06-17 12:27:53 +02:00
Marian Beermann
07deaf14cb
docs: faq: Can I use Borg on SMR hard drives?
2017-06-07 11:28:43 +02:00
Marian Beermann
3faafb1dee
docs: faq: specify "using inline shell scripts"
2017-06-06 21:30:58 +02:00
TuXicc
578b76af3a
Added BORG_PASSCOMMAND environment variable ( #2573 )
2017-05-31 19:25:21 +02:00
Marian Beermann
65d1deae1a
faq: separate section for attic-stuff
2017-05-22 20:55:16 +02:00
enkore
decee5389b
Merge pull request #2529 from enkore/faq/errors
...
faq: I get an IntegrityError or similar - what now?
2017-05-22 20:34:59 +02:00
Marian Beermann
0bcb8c2a39
faq: rewrote IntegrityError answer
2017-05-22 11:46:10 +02:00
Marian Beermann
be40e2fcfa
faq: I get an IntegrityError or similar - what now?
2017-05-18 20:01:06 +02:00
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
