Commit Graph

182 Commits

Author SHA1 Message Date
Andrey Bienkowski 6bc1f48e4e Apply review suggestions 2022-02-05 09:07:13 +03:00
Andrey Bienkowski d6c16d77cb Review suggestion: mention local nonce path
> do we maybe also want to mention the specific path where the local
> nonce is kept?
2022-02-05 09:07:13 +03:00
Andrey Bienkowski fab5024cb7 Doc: warn about tampered server nonce
https://github.com/borgbackup/borg/pull/6188#discussion_r794752672
> Well, guess one could also use max(list of trusted nonce values).
>
> The real issue is if you have lost all or some of the trusted
> (client side) nonce values and you also have reason to not trust the
> server side nonce, because someone might attack you on the server.
2022-02-05 09:07:13 +03:00
Andrey Bienkowski 62fe1cab30 Doc: impact of deleting path/to/repo/nonce
Fixes: https://github.com/borgbackup/borg/issues/5858
2022-02-05 09:07:04 +03:00
Andrey Bienkowski 98fcef57ce
Doc: ~/.config/borg/keys is not used w/ repokey (#6185)
docs: ~/.config/borg/keys is not used for repokey keys, fixes #6107

Thanks to ThomasWaldmann for suggesting this
https://github.com/borgbackup/borg/pull/6185#discussion_r793995379
2022-01-28 18:29:40 +01:00
Tavlor 2c7253dcbb
clarify who starts the remote agent
It was unclear that the user _only_ needs to have borg installed on a remote system to use client/server mode. Hopefully this change makes it apparent that the user doesn't start anything on the remote system themselves.
2022-01-18 02:07:01 +00:00
AJ Jordan 284b26f6cc
Fix manifest-timestamp path 2021-10-18 02:54:12 -04:00
Jubjub 0393cfac6c
docs: document behavior for filesystems with inconsistent inodes, fixes borgbackup#5770 (#5965) 2021-08-25 21:43:47 +02:00
Dmitry Astapov a35c7add95
docs: mention tar --compare (#5880)
docs: mention tar --compare (compare archive to fs files)
2021-07-03 17:10:19 +02:00
remyabel 1c7602f9e0
docs: add info on renaming repositories (#5866)
docs: add info on renaming repositories, fixes #5240
2021-06-23 00:08:49 +02:00
Thomas Waldmann 06c6e7e79c docs: add unsafe workaround to use an old repo copy, fixes #5722 2021-04-19 20:11:37 +02:00
Thomas Waldmann b1fff5dd39 FAQ: project_name -> Borg
see changeset 8d830d069f where this was
started.
2021-02-06 01:24:14 +01:00
Ryan Polley 921cac0177 fix grammar in faq 2021-01-22 14:35:45 -06:00
Andrea Gelmini 72e7c46fa7 Fix typos 2021-01-07 17:54:33 +01:00
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