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
TW
1f6c026032
docs: document max_segment_size adjustment, fixes #7858
CI / lint (push) Waiting to run
CI / asan_ubsan (push) Blocked by required conditions
CI / native_tests (push) Blocked by required conditions
CI / vm_tests (Haiku, false, haiku, r1beta5) (push) Blocked by required conditions
CI / vm_tests (NetBSD, false, netbsd, 10.1) (push) Blocked by required conditions
CI / vm_tests (OpenBSD, false, openbsd, 7.7) (push) Blocked by required conditions
CI / vm_tests (borg-freebsd-14-x86_64-gh, FreeBSD, true, freebsd, 14.3) (push) Blocked by required conditions
CodeQL / Analyze (push) Waiting to run
Windows CI / msys2-ucrt64 (push) Waiting to run
2026-05-13 10:08:53 +02:00
TW
5b8184be25
docs: add section about rolling back a transaction, fixes #9270
2026-05-13 10:02:56 +02:00
Thomas Waldmann
7f4ebba21a
docs: clarify storage quota run-time settings ( fixes #3948 )
2026-05-13 01:22:03 +02:00
Thomas Waldmann
ff5be71f73
build_usage build_man
2026-03-18 23:56:10 +01:00
Thomas Waldmann
4efaaca751
clarify append-only != write-only, fixes #9304
2026-03-18 19:11:35 +01:00
Thomas Waldmann
509c5695e0
build_usage build_man
2025-12-02 00:20:09 +01:00
Thomas Waldmann
8e1a4248c0
build_usage build_man
2025-10-31 19:12:42 +01:00
TW
83d9d28fa4
Merge pull request #9103 from PhrozenByte/docs-repokey-change-passphrase
...
CI / lint (push) Waiting to run
CI / pytest (push) Blocked by required conditions
CodeQL / Analyze (push) Waiting to run
Windows CI / msys2-ucrt64 (push) Waiting to run
Docs: Rewrite `borg init --encryption` docs
2025-10-29 19:24:45 +01:00
Thomas Waldmann
2d63dc9a4f
BORG_MSGPACK_VERSION_CHECK=no to disable the version check, fixes #9109
2025-10-28 23:20:53 +01:00
Daniel Rudolf
d42453fde4
Docs: Rewrite borg init docs
2025-10-26 23:13:59 +01:00
Atemu
908c506e3f
extract: document how to use wildcards in PATHs
...
Fixes https://github.com/borgbackup/borg/issues/8589
2025-10-13 19:54:49 +02:00
Thomas Waldmann
5bce73301d
docs: borg serve: recommend using a simple shell, fixes #8318
2025-10-10 13:48:26 +02:00
Thomas Waldmann
7f9dd37536
diff --sort-by: enhanced sorting, fixes #8998
...
use borg diff --sort-by=spec1,spec2,spec2 for enhanced sorting.
keep legacy --sort behaviour (sort by path) for compatibility,
but deprecate it.
Co-authored-by: Daniel Rudolf <github.com@daniel-rudolf.de>
2025-09-18 23:32:23 +02:00
Thomas Waldmann
3f9ad883cb
manual fixes
...
sometimes the AI got it wrong.
also some other fixes.
2025-08-17 16:05:51 +02:00
Thomas Waldmann
6602cf1679
docs: fix typos and grammar
2025-08-11 15:26:24 +02:00
Thomas Waldmann
850734be77
reformat text
2025-06-09 14:45:57 +02:00
Thomas Waldmann
144a52f4ee
fix grammar
2025-06-09 14:43:47 +02:00
Max-Julian Pogner
c77f005307
docs: borg-serve: simplify example of env in authorized_keys
...
see #8318
so long as it can be assumed that the user has configured a POSIX
compliant login shell, using a simple command [1] looks cleaner, as
no ``export`` or ``;`` are used.
[1] Section "2.9.1 Simple Commands" in volume "Shell & Utilities" of POSIX.1-2024
2025-06-09 14:43:11 +02:00
Thomas Waldmann
ecf2dfa170
build_usage / build_man
2025-04-18 18:26:48 +02:00
goebbe
66e92636d2
Clarify excluded and included flags for dry-run in borg the docs
...
Rewording of the "flags" description in the docs of borg 1.4.
https://github.com/borgbackup/borg/issues/8556
2024-11-24 13:44:39 +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
Thomas Waldmann
cf472302dc
docs: better link modern return codes, fixes #8370
2024-10-05 19:14:51 +02: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
7b8acc925f
docs: add examples using :: positional argument, fixes #8255
...
Simply omitting the first positional argument (REPO) does
not work because borg then gets confused.
2024-06-30 17:31:22 +02:00
Thomas Waldmann
a41cc1750f
build_usage ; build_man
2024-03-30 22:19:39 +01:00
Thomas Waldmann
5b96d5acc3
create: add the slashdot hack, fixes #4685
2024-01-30 14:01:40 +01:00
Thomas Waldmann
4a65f9c943
docs: do not refer to setup.py installation method
...
Invoking setup.py is deprecated.
2024-01-29 20:39:02 +01:00
Thomas Waldmann
bdacc84ceb
build_usage build_man
2024-01-20 19:25:08 +01:00
Thomas Waldmann
5eaabea647
build_usage
2024-01-01 21:16:30 +01:00
Thomas Waldmann
62ad0369ef
update "modern" error RCs (docs and code)
2023-12-27 13:45:48 +01:00
Marc Kohaupt
05fa6fcab2
typo: notes.rst
2023-12-23 18:58:47 +01:00
Thomas Waldmann
46c1e01d29
build_usage
2023-12-02 01:01:46 +01:00
Thomas Waldmann
05cec8b3b0
docs: OS X -> macOS
2023-10-27 20:31:26 +02:00
Thomas Waldmann
661e5cccd3
docs: minor fixes/update to notes
2023-10-27 20:27:51 +02:00
Thomas Waldmann
d13b5d5557
docs: remove info about borg 1.0 files per dir
2023-10-27 20:26:27 +02:00
Thomas Waldmann
d05d02f238
implement BORG_WORKAROUNDS=ignore_invalid_archive_tam, see #7791
2023-08-31 00:36:04 +02:00
Thomas Waldmann
509a5fd71c
build_usage / build_man
2023-08-30 03:49:47 +02:00
Thomas Waldmann
276781081b
docs: fix borg init command in environment.rst.inc
...
It mentioned borg rcreate due to a bad backport from master.
Must be borg init in borg 1.2.x.
2023-08-24 11:49:17 +02:00
Thomas Waldmann
b419b6ad03
build_man / build_usage
2023-07-20 18:57:22 +02:00
TW
4721a35863
Merge pull request #7702 from ThomasWaldmann/authenticated-no-key-1.2
...
BORG_WORKAROUNDS=authenticated_no_key, fixes #7700
2023-07-07 01:02:41 +02:00
Tim Düsterhus
b58c6ce3b1
Improve the documentation for --keep-within
...
Move the explanation below the general explanation of the `--keep-*` option
behavior rephrase the last sentence to make it clear that it works like the
other options that were explained in the previous paragraph.
Resolves #7687
(cherry picked from commit a6f452a050
2023-07-04 09:16:39 +02:00
Thomas Waldmann
8ac7178ab9
BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos without key, fixes #7700
2023-07-03 15:38:21 +02:00
Thomas Waldmann
893530fdac
list: fix --pattern examples, fixes #7611
...
- pattern needs to start with + - !
- first match wins
- the default is to list everything, thus a 2nd pattern
is needed to exclude everything not matched by 1st pattern.
2023-06-27 21:00:05 +02:00
Thomas Waldmann
0d14f3b36f
build_usage
2023-03-23 22:11:45 +01:00
Thomas Waldmann
e6b8e03e19
BORG_KEY_FILE: clarify docs, fixes #7444
2023-03-22 18:52:58 +01:00
Thomas Waldmann
47e0f9bcb0
remove BORG_LIBB2_PREFIX (not used any more)
...
the code now uses hashlib.blake2b from python stdlib.
2023-01-10 14:09:28 +01:00
Thomas Waldmann
ec49d60d1f
build_usage
2022-12-24 18:09:32 +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
