borgbackup/docs/usage
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
..
general Merge pull request #9103 from PhrozenByte/docs-repokey-change-passphrase 2025-10-29 19:24:45 +01:00
benchmark.rst docs: usage: add benchmark page 2017-06-07 00:42:43 +02:00
benchmark_crud.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
borgfs.rst [DOCS] #4587 – Make Sphinx warnings break docs build 2020-03-16 19:06:00 +01:00
borgfs.rst.inc build_usage (master) 2017-11-25 14:35:52 +01:00
break-lock.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
change-passphrase.rst.inc build_usage (master) 2017-11-25 14:35:52 +01:00
check.rst docs: split usage 2017-06-07 00:38:48 +02:00
check.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
common-options.rst.inc build_usage 2021-05-11 22:33:55 +02:00
compact.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
compact.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
config.rst docs: document max_segment_size adjustment, fixes #7858 2026-05-13 10:08:53 +02:00
config.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
create.rst create: add the slashdot hack, fixes #4685 2024-01-30 14:01:40 +01:00
create.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
debug.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
delete.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
delete.rst.inc build_usage / build_man 2025-04-18 18:26:48 +02:00
diff.rst diff --sort-by: enhanced sorting, fixes #8998 2025-09-18 23:32:23 +02:00
diff.rst.inc build_usage build_man 2025-12-02 00:20:09 +01:00
export-tar.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
extract.rst extract: document how to use wildcards in PATHs 2025-10-13 19:54:49 +02:00
extract.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
general.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
help.rst docs: split usage 2017-06-07 00:38:48 +02:00
help.rst.inc build_usage build_man 2025-12-02 00:20:09 +01:00
import-tar.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
info.rst docs: info: update and add examples 2017-06-29 11:49:27 +02:00
info.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
init.rst docs: clarify borg init's encryption modes 2020-04-16 21:35:33 +02:00
init.rst.inc Minimal implementation of "related repositories" for Borg 1.4.x. 2026-05-15 13:21:00 +02:00
key.rst Minimal implementation of "related repositories" for Borg 1.4.x. 2026-05-15 13:21:00 +02:00
key_change-passphrase.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
key_export-related-secrets.rst Minimal implementation of "related repositories" for Borg 1.4.x. 2026-05-15 13:21:00 +02:00
key_export-related-secrets.rst.inc Minimal implementation of "related repositories" for Borg 1.4.x. 2026-05-15 13:21:00 +02:00
key_export.rst.inc build_usage build_man 2026-03-18 23:56:10 +01:00
key_import.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
key_migrate-to-repokey.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
list.rst list: fix --pattern examples, fixes #7611 2023-06-27 21:00:05 +02:00
list.rst.inc build_usage build_man 2025-12-02 00:20:09 +01:00
lock.rst docs: split usage 2017-06-07 00:38:48 +02:00
mount.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
mount.rst.inc build_usage build_man 2026-03-18 23:56:10 +01:00
notes.rst docs: document max_segment_size adjustment, fixes #7858 2026-05-13 10:08:53 +02:00
prune.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
prune.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
recreate.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
recreate.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
rename.rst docs: split usage 2017-06-07 00:38:48 +02:00
rename.rst.inc docs: use DOM ready event, not document loaded event 2017-06-20 15:48:30 +02:00
serve.rst docs: borg serve: recommend using a simple shell, fixes #8318 2025-10-10 13:48:26 +02:00
serve.rst.inc build_usage build_man 2026-03-18 23:56:10 +01:00
tar.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
umount.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
upgrade.rst docs: fix typos and grammar 2025-08-11 15:26:24 +02:00
upgrade.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
usage_general.rst.inc [DOCS] #4587 – Make Sphinx warnings break docs build 2020-03-16 19:22:59 +01:00
version.rst build_usage build_man 2024-01-20 19:25:08 +01:00
version.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00
with-lock.rst.inc build_usage build_man 2025-10-31 19:12:42 +01:00