Mrityunjay Raj
02f447536c
docs: document platformdirs change and platform-specific directory paths, fixes #7332
2026-02-27 11:50:35 +05:30
Thomas Waldmann
0b05b44c0a
rename BORG_RLIST_FORMAT to BORG_REPO_LIST_FORMAT, #9411
2026-02-24 10:42:50 +01:00
defnvary
4344eb37d1
use zstd from python stdlib or backport.zstd, closes #9261
2026-02-23 00:33:21 +05:30
Rohan salunke
179b5cdd92
Regenerate usage docs from current CLI help source
...
This also fixes #8146 (experimental markings in docs).
2026-02-22 11:50:58 +01:00
Thomas Waldmann
4073bb263f
fix S3 url description, fixes #9249
...
- profile also must be followed by @
- in URL specs, it is "scheme", not "schema"
- note that the scheme is usually https
2026-01-28 12:12:26 +01:00
Thomas Waldmann
fcbf7f3572
build_usage build_man
2025-12-23 18:00:09 +01:00
Thomas Waldmann
43c7878a56
docs: update installation requirements and BORG_FUSE_IMPL about mfusepy
2025-12-20 19:31:51 +01:00
TW
1b9779b4f3
Merge pull request #9162 from ThomasWaldmann/docs/archive-series-note-8955
...
Lint / lint (push) Has been cancelled
CI / lint (push) Has been cancelled
CI / security (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
CI / asan_ubsan (push) Has been cancelled
CI / native_tests (push) Has been cancelled
CI / vm_tests (Haiku, false, haiku, r1beta5) (push) Has been cancelled
CI / vm_tests (NetBSD, false, netbsd, 10.1) (push) Has been cancelled
CI / vm_tests (OpenBSD, false, openbsd, 7.7) (push) Has been cancelled
CI / vm_tests (borg-freebsd-14-x86_64-gh, FreeBSD, true, freebsd, 14.3) (push) Has been cancelled
CI / windows_tests (push) Has been cancelled
docs: highlight archive series naming for fast incrementals (fixes #8955 )
2025-11-18 02:11:46 +01:00
Thomas Waldmann
15f59233b5
completion: borg can now generate completion scripts for supported shells, fixes #9172
...
Added `shtab` dependency for shell completion functionality:
- bash completion (works).
- zsh completion (known-broken due to iterative/shtab#183 ).
2025-11-17 18:47:00 +01:00
Thomas Waldmann
71ca0ac6a7
docs: add prominent note to borg create about archive series and files cache; recommend stable NAME per series for performance ( #8955 )
2025-11-10 02:37:55 +01:00
Thomas Waldmann
5c44dad125
diff --sort-by: enhanced sorting, fixes #8998
...
use borg diff --sort-by=spec1,spec2,spec2 for enhanced sorting.
remove legacy --sort behaviour (sort by path), this was deprecated
since 1.4.2.
Co-authored-by: Daniel Rudolf <github.com@daniel-rudolf.de>
This is a port of #9005 to master branch.
2025-11-03 19:25:02 +01:00
Thomas Waldmann
7e6dea9408
BORG_MSGPACK_VERSION_CHECK=no to disable the version check, fixes #9109
...
(cherry picked from commit 2d63dc9a4f
2025-11-01 16:48:00 +01:00
Atemu
fdabbd7633
extract: document how to use wildcards in PATHs
...
Fixes https://github.com/borgbackup/borg/issues/8589
2025-10-10 11:20:08 +02:00
Thomas Waldmann
2c7bec0149
manual corrections/reverts
2025-09-23 14:56:35 +02:00
Thomas Waldmann
3120f9cd1c
fixed typos and grammar (AI)
...
this was done by Junie AI.
2025-09-23 14:56:23 +02:00
Thomas Waldmann
f327af11a6
build_usage build_man
2025-08-02 11:12:20 +02:00
Thomas Waldmann
9b26b1011a
build_usage build_man
2025-06-18 17:35:37 +02:00
Thomas Waldmann
7741b503ad
reformat text
2025-06-09 14:19:14 +02:00
Thomas Waldmann
c850f508f8
fix grammar
2025-06-09 14:19:12 +02:00
TW
f3cfc72b9d
Merge pull request #8331 from qyanu-pull-requests/3818simplifyexport-master
...
docs: borg-serve: simplify example of env in authorized_keys
2025-06-09 14:17:46 +02:00
Thomas Waldmann
81bacd04c5
docs: add docs for serve --permissions / BORG_REPO_PERMISSIONS
2025-06-08 13:49:09 +02:00
Thomas Waldmann
6e548ed1f0
build_man build_usage
2025-05-19 23:20:38 +02:00
Thomas Waldmann
7644b04df2
docs: remove outdated docs/man files about borg change-passphrase
...
this is borg key change-passphrase now.
2025-05-19 23:18:19 +02:00
Vaskebjoern
15e55bfd2e
docs: add S3/B2 urls to documentation for repository urls, fixes #8833
2025-05-19 10:41:07 +02:00
Thomas Waldmann
524d927871
build_usage build_man
2025-05-06 01:37:17 +02:00
Thomas Waldmann
bcb178418e
BORG_DEBUG_PASSPHRASE: also show "other" env vars, docs
2025-05-05 21:21:38 +02:00
Thomas Waldmann
ae4aaa96b9
better support other repo by misc. passphrase env vars, fixes #8457
...
- borg repo-create and borg transfer not only support --repo / --other-repo options,
but also already supported related BORG_REPO and BORG_OTHER_REPO env vars.
- similar to that, the passphrases now come from BORG_[OTHER_]PASSPHRASE, BORG_[OTHER_]PASSCOMMAND or BORG_[OTHER_]PASSPHRASE_FD.
- borg repo-create --repo B --other-repo A does not silently copy the passphrase of key A
to key B anymore, but either asks for the passphrase or reads it from env vars.
2025-05-05 21:09:31 +02:00
Thomas Waldmann
477e8f53fb
build_man build_usage
2025-04-28 21:42:30 +02:00
Thomas Waldmann
9e6d90754e
remove remainders of append-only support
...
Some features like append-only repositories rely on a server-side component
that enforces them (because that shall only be controllable server-side,
not client-side).
So, that can only work, if such a server-side component exists, which is the
case for borg 1.x ssh: repositories (but not for borg 1.x non-ssh: repositories).
For borg2, we currently have:
- fs repos
- sftp: repos
- rclone: repos (enabling many different cloud providers)
- s3/b3: repos
- ssh: repos using client/server rpc code similar as in borg 1.x
So, only for the last method we have a borg server-side process that could enforce some features, but not for any of the other repo types.
For append-only the current idea is that this should not be done within borg,
but solved by a missing repo object delete permission enforced by the storage.
borg create could then use credentials that miss permission to delete,
while borg compact would use credentials that include permission to delete.
2025-04-28 18:55:15 +02:00
Thomas Waldmann
4550a49b0f
build_usage / build_man
2025-04-21 21:08:42 +02:00
vancheese
8df4bf75d4
docs: borg commands updated with --repo option, fixes #8550
2025-04-01 17:28:57 +02:00
Ken Kundert
45b8e629ac
update prune documentation for new --keep-within intervals
2025-01-10 11:12:20 -08:00
Ken Kundert
b9498ca571
Allow timespan to be specified with common time units ( #8626 )
...
allow timespan to be specified with common time units, fixes #8624
Co-authored-by: Ken Kundert <ken@theKunderts.net>
2025-01-08 18:48:10 +01:00
Max-Julian Pogner
048ff2afba
docs: borg serve: recommend using a simple shell ( closes #3818 )
...
Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2025-01-05 19:19:14 +01:00
Max-Julian Pogner
75687b469d
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-01-04 01:09:33 +01:00
Björn Ketelaars
cf6a324afa
borg2 - Support other OpenSSL versions on OpenBSD
...
`setup.py` hardcoded crypto library paths for OpenBSD, causing build
issue when OpenBSD drops specific OpenSSL version. Solution is to make
paths configurable.
Addresses #8553 .
2024-11-23 23:01:44 +01:00
Thomas Waldmann
37077a55e7
build_usage build_man
2024-11-16 20:14:16 +01:00
TW
b553452911
Merge pull request #8484 from mrichtarsky/docs
...
Docs: Remove --bypass-lock, small changes regarding compression
2024-11-01 12:26:06 +01:00
TW
168d34664e
Merge pull request #8483 from mrichtarsky/faq
...
docs/FAQ: Clean up entries regarding SSH settings
2024-11-01 12:16:37 +01:00
Martin Richtarsky
b913d9dd1a
docs/FAQ: Clean up entries regarding SSH settings
...
Link to recommended ones
2024-11-01 07:43:47 +01:00
Thomas Waldmann
66e17ff6c8
build_usage, build_man
2024-10-31 20:50:06 +01:00
Martin Richtarsky
411f6f3222
docs: Remove --bypass-lock
2024-10-22 08:44:56 +02:00
Thomas Waldmann
6adf18d97c
update URL docs
2024-10-14 23:30:12 +02:00
Thomas Waldmann
414f18a354
docs: better link modern return codes, fixes #8370
2024-10-05 14:12:53 +02:00
Thomas Waldmann
4b7ab4f087
build_usage / build_man
2024-10-03 12:30:58 +02:00
Thomas Waldmann
e274860983
tag: set, add, remove tags
2024-10-02 23:52:39 +02:00
Thomas Waldmann
ecd0cd07e2
docs: fix typo
2024-10-02 17:28:21 +02:00
Thomas Waldmann
940ec7b455
docs: point to rclone docs
2024-10-02 17:27:42 +02:00
Thomas Waldmann
de439ee839
analyze: sum up changed chunks per parent directory
2024-10-02 16:14:44 +02:00
TW
9c9a75bdf9
Merge pull request #8421 from ThomasWaldmann/rel200b11
...
Release 2.0.0 beta11
2024-09-26 20:06:30 +02:00
