Commit graph

213 commits

Author SHA1 Message Date
Thomas Waldmann
5035710042
Minimal implementation of "related repositories" for Borg 1.4.x.
This feature allows multiple repositories to share deduplication-relevant secrets (id_key and chunk_seed) while maintaining secure, independent encryption keys.

`borg key export-related-secrets <REPO> <SPATH>` to export the secrets to a JSON file.

`borg init --import-related-secrets <SPATH> <REPO>` to initialize a new repository using the secrets from the JSON file.

Both repositories must use the same chunk id algorithm (both HMAC-SHA256 or both BLAKE2b).

If you create related repositories with borg 1.4.x, you can later transfer their archives
to one or multiple related new borg2 repositories without breaking deduplication.

But please note that we might remove BLAKE2b support for new borg2 repos, see #8867,
so this might only work for HMAC-SHA256 in the end.
2026-05-15 13:21:00 +02:00
Thomas Waldmann
2dec0d32de add a FAQ entry about scalability, fixes #4742 2026-05-13 22:01:46 +02:00
TW
f3a6898073
Merge pull request #9617 from ThomasWaldmann/docs-enospc-faq-9573
docs: add FAQ entry for full repository filesystem (fixes #9573)
2026-05-13 09:59:59 +02:00
TW
3f745f38d4
docs: add FAQ entry for bad backups and deduplication, fixes #4744 2026-05-13 09:58:58 +02:00
TW
a5bfda12e6
docs: add FAQ entry for SSH connection timeouts, fixes #5629 2026-05-13 09:57:42 +02:00
Thomas Waldmann
4cbaab5d29 docs: add FAQ entry for full repository filesystem, fixes #9573 2026-05-13 09:53:41 +02:00
Thomas Waldmann
fb8bab1c2d
docs: improve macOS Keychain instructions (fixes #5156) 2026-05-13 01:14:24 +02:00
Thomas Waldmann
d53ff5f175
docs: consolidate key backup info in borg key export, fixes #6204
Consolidate key backup documentation into `borg key export` and reference
it from Quickstart and FAQ to avoid duplication and inconsistency.

Clarify that while `repokey` or `authenticated` mode stores the key in the
repo, a separate backup is still recommended to protect against repository
corruption or data loss.
2026-03-17 14:33:19 +01:00
Mrityunjay Raj
22297f4680 fix typos found by codespell (1.4-maint)
- backupped → backed-up (docs/faq.rst)
- abount → about (docs/faq.rst)
- unflexible → inflexible (docs/faq.rst)
- shrinked → shrunk (docs/internals/data-structures.rst)
- backupped → backed up (src/borg/archive.py)
- splitted → expected (src/borg/testsuite/xattr.py)

Closes #9295
2026-02-13 00:40:54 +05:30
Thomas Waldmann
3e7ecd6133
docs: some fixes/update to the FAQ
(cherry picked from commit 3642c7903b)
2025-11-21 17:45:42 +01:00
Thomas Waldmann
80818c1588
docs: What happens when a new keyfile repo is created at the same path?, fixes #6230
Also add a test.
2025-10-10 14:12:48 +02:00
dataprolet
ad44548b04 Adds systemd-inhibit and examples (#8989) 2025-08-11 15:35:28 +02:00
infectormp
a1a028cef9
FAQ: Why are backups slow on a Linux server that is a member of a windows domain?
backport to 1.4-maint
2025-01-19 17:32:38 +03:00
Thomas Waldmann
cda01c7ba5
docs: add FAQ entry about pure-python msgpack warning, fixes #8323 2024-12-30 22:59:01 +01:00
Helmut Grohne
f0bd01b98d
FAQ: Why is backing up an unmodified FAT filesystem slow on Linux? 2024-12-28 22:33:56 +01:00
Martin Richtarsky
05837fbeb7 docs/FAQ: Clean up entries regarding SSH settings
Link to recommended ones

(cherry picked from commit b913d9dd1a)
2024-11-15 07:40:21 +00:00
Eddie Carswell
4f110f8bde
Update repository URLs in docs to use new syntax
Fixes #8361

Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
2024-09-10 18:08:18 -05:00
William Bonnaventure
f3c1444a41 Update docs for BORG_USE_CHUNKS_ARCHIVE 2024-07-14 07:24:37 +02:00
Thomas Waldmann
6b928dac93
docs: not only attack/unsafe, can also be a fs issue, fixes #7853 2023-11-01 18:04:24 +01:00
Thomas Waldmann
55af769b71
mount -olocal: how to show mount in finder's sidebar, fixes #5321 2023-07-01 14:43:35 +02:00
Thomas Waldmann
e8573193e4
update FAQ about locale/unicode issues, fixes #6999 2023-03-04 16:32:48 +01:00
Thomas Waldmann
90a937e1ed
remove deprecated --prefix from docs, fixes #7109
also:

- rather mention --glob-archives
- rather test --glob-archives
2022-12-24 14:44:05 +01:00
Thalian
6990aca7ac [DOCS] #5960 - FAQ: Full quota / full disk
Backport from master.
2022-06-29 17:56:23 +02:00
Thalian
cfcf99ccb5 [DOCS] #4776 - FAQ: How to swap backup media
Backport from master.
2022-06-05 18:22:23 +02:00
Thalian
2694652e37 #6407 - Document Borg 1.2 pattern behavior change
Backport from master: Make clear that absolute paths always go into the matcher as if they are relative (without leading slash). Adapt all examples accordingly.
2022-05-27 15:14:01 +02:00
Andrea Gelmini
f4d7c32058 Fix typos (#6688)
fix typos

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2022-05-15 23:43:50 +02:00
Thomas Waldmann
6d6711768e docs: mention BORG_FILES_CACHE_SUFFIX as alternative to BORG_FILES_CACHE_TTL, fixes #5602 2022-05-07 18:47:41 +02:00
Andrey Bienkowski
622ec1a181 Add a troubleshooting note to the FAQ 2022-04-24 11:27:37 +03:00
Thomas Waldmann
56262b57bd FAQ: add a hint about --debug-topic=files_cache 2022-04-20 13:00:34 +02:00
Thomas Waldmann
08ed786f6d virtualisation speed tips 2022-04-13 23:08:39 +02:00
Jonathan Rascher
4b58dafd31 (docs) Recommend umask for passphrase file perms
The previous sample for creating a ~/.borg-passphrase file creates it first and then chmod's it to 400 permissions. That's probably fine in practice, but means there's a tiny window where the passphrase file is sitting with default permissions (likely world readable, depending on the system umask).

It seems safer to first change the umask to remove all group & world bits (0077) _before_ creating the file. To be polite and avoid messing with the user's previous umask, we do this in a subshell. (Note that umask 0077 leads to a mode of 600 rather than the previous 400, because removing the owner write bit doesn't seem to buy much since the owner can just chmod the file anyway.)
2022-04-09 23:58:45 -05:00
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