1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-25 09:19:31 +00:00
Commit graph

168 commits

Author SHA1 Message Date
Nehalenniæ Oudin
810d82395d
Complete documentation on append-only remote repos (#5519)
improve docs/FAQ about append-only remote repos, fixes #5497
2020-12-06 15:53:39 +01:00
Guinness
046acb882a
Add a hint on sleeping computer in the FAQ
Now the FAQ warns that a sleeping computer can lead to a broken pipe
when backing up over ssh.

Fixes #5301
2020-11-17 10:50:45 +01:00
Guinness
3278d253c5
Update the documentation on hacked backup client.
Fixes #5480.
2020-11-13 10:31:05 +01:00
Thomas Waldmann
60ee199a0f docs: how to approach borg speed issues, fixes #5371
also: give a speed example for unchanged files

also: explicitly mention chmod/chown changing ctime

also: reformat one paragraph
2020-11-02 17:36:08 -08:00
viq
e00ffabd10
Better description of how cache and rebuilds of it work
and how the workaround applies to that
2020-08-03 22:35:23 +02:00
Thalian
668a136794 docs: add security faq explaining AES-CTR crypto issues, fixes #5254 2020-07-25 12:12:32 +02:00
Thomas Portmann
dfc5e915cc
Fixed locking, issue #4923 (#4928)
locking: fix ExclusiveLock race condition bug, fixes #4923

- ExclusiveLock is now based on os.rename instead of os.mkdir.
- catch FileNotFoundError observed under race condition in ExclusiveLock.release()
  and .kill_stale_lock()
- added TestExclusiveLock.test_race_condition() which reveals issue #4923
- updated docs
- locking: use "raise LockTimeout from None" for prettier traceback

Co-authored-by: Thomas Portmann <thomas@portmann.org>
Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2020-07-03 10:09:32 +02:00
Uriel
8b6f4a1afe
docs: explain hash collision (#5188)
explain hash collision probability, fixes #4884
2020-06-02 22:19:54 +02:00
Thalian
d0054f4482 [DOC] linked recommended restrictions to ssh public keys on borg servers in faq, #4946
fixes #4946
2020-04-08 03:02:50 +02:00
Thalian
25ab198d41
[DOCS] #4883 – Doc downplays severity of Nonce reuse issue (#5082)
docs: Borg documentation downplays severity of Nonce reuse issue, fixes #4883
2020-04-05 23:31:08 +02:00
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