Thomas Waldmann
d0167d8cdf
docs: forward port DoS warning for none mode ( fixes #6715 )
2026-05-13 10:14:36 +02:00
Thomas Waldmann
4dc21d7ed1
docs: improve macOS Keychain instructions ( fixes #5156 )
...
(cherry picked from commit fb8bab1c2d )
2026-05-13 07:56:52 +00:00
Hugo Wallenburg
c8f8defc0f
Fixes tests/docs assuming XDG_* vars not used on macOS
...
The move to platformdirs and its current usage _does_ honor XDG_*
variables on macOS if they are set. Tests were set up to assume this to
be untrue and the docs matched that.
This commit adds tests asserting that XDG_* variables are used when they
are present on macOS, with default locations still in ~/Library.
2026-04-03 11:34:10 +02:00
TW
be640e982f
Merge pull request #9348 from trxvorr/fix-9339-msys2-paths
...
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 (OmniOS, false, omnios, r151056) (push) Has been cancelled
CI / vm_tests (OpenBSD, false, openbsd, 7.8) (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
archiver: warn about MSYS2 path translation, fixes #9339
2026-03-17 15:37:13 +01:00
Thomas Waldmann
2d6d900231
update CHANGES
2026-03-15 17:03:12 +01:00
trxvorr
d7bbcfb98b
archiver: warn about MSYS2 path translation, fixes #9339
...
This adds a runtime warning when running under MSYS2/Git Bash without the necessary environment variables to disable automatic path translation. The documentation is also updated to explain this behavior and how to mitigate it.
2026-03-15 20:54:59 +05:30
Thomas Waldmann
f12f67a76d
build_usage build_man
2026-03-15 14:37:50 +01:00
Thomas Waldmann
d0c5a04a2a
update CHANGES
2026-03-13 15:29:33 +01:00
Thomas Waldmann
0f1e3f90fe
CI: use locked requirements, add canary job, fixes #9361
2026-03-12 15:01:00 +01:00
Thomas Waldmann
4f2f2255c3
create --paths-from-shell-command, fixes #5968
...
This adds the `--paths-from-shell-command` option to the `create` command, enabling the use of shell-specific features like pipes and redirection when specifying input paths. Includes related test coverage.
2026-03-10 20:16:26 +01:00
Thomas Waldmann
f2bdb689c5
improve configuration precedence docs
2026-03-10 18:36:34 +01:00
Thomas Waldmann
678df16bad
add support for auto-generated environment variables (jsonargparse)
2026-03-10 18:36:31 +01:00
Thomas Waldmann
63a45c6c21
add support for yaml config files, default config
2026-03-10 18:36:30 +01:00
Suryansh Pal
ba6706395a
use xxhash from PyPI, fixes #6535
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 (OmniOS, false, omnios, r151056) (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
2026-03-08 13:06:01 +01:00
Thomas Waldmann
dd38e2c2df
docs: archive specification, FAQ, fixes #9248 , fixes #9053
2026-03-06 21:36:05 +01:00
Thomas Waldmann
cb6a7b6fcf
update CHANGES
2026-03-03 14:03:54 +01:00
Thomas Waldmann
9a02947d40
docs: move RTD version selector to sidebar top-left
...
That way, right below the docs version number that is currently
being displayed, it is easier to find for users.
Also: hide the default readthedocs-flyout (bottom right)
Co-authored-by: Junie <junie@jetbrains.com>
Co-authored-by: Junie <junie@jetbrains.com>
2026-03-02 20:46:26 +01:00
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
Mrityunjay Raj
1c0bf36275
remove handwritten bash/zsh shell completions, fixes #9178
...
Remove the handwritten bash and zsh shell completion scripts now that
auto-generated completions via borg completion bash/zsh (powered by
shtab, #9172 ) are tested and working. Fish completions are kept as
shtab does not yet support fish.
Replace string-matching tests with focused behavior tests: script size
sanity, shell syntax validation (bash -n / zsh -n), and tests that
invoke the custom preamble functions in bash (sortby key dedup,
filescachemode mutual exclusivity, archive name and aid: prefix
completion against a real repository).
2026-02-17 19:33:54 +01:00
TW
045701558e
Merge pull request #9343 from mr-raj12/fix-http-urls-master
...
Lint / lint (push) Waiting to run
CI / lint (push) Waiting to run
CI / security (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 (OmniOS, false, omnios, r151056) (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
CI / windows_tests (push) Blocked by required conditions
CodeQL / Analyze (push) Waiting to run
upgrade http:// URLs to https:// and remove dead librelist.com link, fixes #9342
2026-02-16 18:40:51 +01:00
Mrityunjay Raj
f1ed09965f
docs: fix broken :ref: references in man pages, fixes #7239
2026-02-16 22:36:07 +05:30
Mrityunjay Raj
fc89a66dc7
upgrade http:// URLs to https:// and remove dead librelist.com link, fixes #9342
2026-02-16 01:42:09 +05:30
Mrityunjay Raj
44693da753
docs: remove unused targz_url extlink from Sphinx config
2026-02-15 21:42:36 +05:30
Mrityunjay Raj
c7d62c0ebd
docs: update deprecated pypi.python.org URLs to pypi.org, fixes #9337
2026-02-15 16:53:42 +05:30
Thomas Waldmann
40a2bb7032
linux-run: run commands (e.g. tox) in a podman linux container
...
this is useful to run the linux tests on a mac, e.g. to test fuse stuff.
2026-02-14 12:19:32 +01:00
Mrityunjay Raj
d712776b42
docs: replace insecure http:// links with https://, fixes #9302
2026-02-13 01:59:19 +05:30
Mrityunjay Raj
ffe360a2ec
fix typos found by codespell
...
- backupped → backed-up (docs/faq.rst)
- splitted → expected (src/borg/testsuite/xattr_test.py)
- uptodate → up-to-date (docs/development.rst, src/borg/repository.py)
Closes #9295
2026-02-13 00:16:54 +05:30
Thomas Waldmann
f646d2c4d0
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-02-08 11:50:31 +01:00
Thomas Waldmann
d75604b293
update CHANGES
2026-01-28 15:05:25 +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
Fabian Fröhlich
c7073ca06d
Add a note that you need to install boto3 if you want to use s3/b2 URLs in the docs ( #9273 )
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
2026-01-25 21:08:22 +01:00
Thomas Waldmann
461f78b2b0
update release date
2025-12-23 18:01:59 +01:00
Thomas Waldmann
fcbf7f3572
build_usage build_man
2025-12-23 18:00:09 +01:00
Thomas Waldmann
f4a2ff13d2
update CHANGES
2025-12-23 16:47:31 +01:00
Thomas Waldmann
661d2b6c5d
docs: mfusepy >= 3.1.0 is required
2025-12-23 16:13:50 +01:00
Thomas Waldmann
2e9ebe4d95
docs: add missing link definition for mfusepy
2025-12-23 16:13:45 +01:00
Thomas Waldmann
43c7878a56
docs: update installation requirements and BORG_FUSE_IMPL about mfusepy
2025-12-20 19:31:51 +01:00
Thomas Waldmann
28de075535
update CHANGES
2025-12-16 13:51:27 +01:00
Thomas Waldmann
ac73be4b09
CI: use macOS 15 for binary builds
...
Github EOLed all other macOS Intel action runners.
As Apple Silicon users tend to have more
recent OSes, we bump that to macOS 15 also.
2025-12-15 17:40:51 +01:00
Thomas Waldmann
4db56e3f71
update binary readme
2025-12-15 17:37:14 +01:00
Thomas Waldmann
3642c7903b
docs: some fixes/update to the FAQ
2025-11-21 17:16:35 +01:00
Thomas Waldmann
4eb19d9e14
update CHANGES
2025-11-19 17:42:11 +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
7548f523e6
update CHANGES
2025-11-17 20:28:50 +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
352cf7bdcc
update CHANGES
2025-11-03 17:33:19 +01:00
Thomas Waldmann
eba3f8cfb0
docs: update attestation instructions in binary readme
2025-11-02 18:48:08 +01:00
Thomas Waldmann
a5c8aed7cf
CI: add GitHub artifact attestations for release binaries ( fixes #9134 )
...
- grant id-token and attestations permissions to posix_tests job
- add actions/attest-build-provenance@v1 step for built artifacts
This publishes SLSA-style provenance for our tag builds (only when binaries
are produced) so users can verify the origin of downloaded borg binaries.
2025-11-02 17:17:23 +01:00
Thomas Waldmann
3fe9102b29
update binary readme
2025-11-01 20:02:22 +01:00
Thomas Waldmann
943e68b20e
docs: release binaries are built on GitHub now
...
bad:
- no *BSD testing and FreeBSD binary building on gh
- binaries not signed by me, because they are built on gh
good:
- for linux intel/amd64 and arm64, built on ubuntu
- for macOS intel and arm64, built on a relatively recent macOS
- I can get rid of that ancient macOS VM I used for building.
- the source code distribution (sdist) is still made locally on
my machine and thus signed with my signature (*.asc).
2025-11-01 20:02:20 +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
Thomas Waldmann
73e2543b53
update CHANGES
2025-10-16 13:34:27 +02:00
Thomas Waldmann
c4a9582fdf
build binaries on github
...
also:
- speed up CI for PRs
- update README for binaries
2025-10-16 00:37:46 +02:00
TW
b988f9c3a2
Merge pull request #9050 from ThomasWaldmann/keyfile-same-repo-path-master
...
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 / linux (ubuntu-22.04, 3.10, mypy) (push) Has been cancelled
CI / linux (ubuntu-22.04, 3.10, py310-fuse2) (push) Has been cancelled
CI / linux (ubuntu-22.04, 3.11, docs) (push) Has been cancelled
CI / linux (ubuntu-22.04, 3.11, py311-fuse3) (push) Has been cancelled
CI / linux (ubuntu-24.04, 3.12, py312-fuse3) (push) Has been cancelled
CI / linux (ubuntu-24.04, 3.13, py313-fuse3) (push) Has been cancelled
CI / linux (ubuntu-24.04, 3.14, py314-fuse3) (push) Has been cancelled
CI / macOS (macos-14, 3.11, py311-none) (push) Has been cancelled
CI / windows (push) Has been cancelled
docs: What happens when a new keyfile repo is created at the same path?
2025-10-10 20:24:54 +02:00
Thomas Waldmann
d0dab94c07
docs: What happens when a new keyfile repo is created at the same path?, fixes #6230
...
Also add a test.
2025-10-10 14:24:05 +02: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
ff7f2ab2ab
binary readme: fix typos and grammar
2025-09-23 14:53:56 +02:00
TW
5b85f47618
Merge pull request #9015 from PhrozenByte/docs-build-src-version
...
Update install docs to include `SETUPTOOLS_SCM_PRETEND_VERSION`
2025-09-21 15:43:12 +02:00
Daniel Rudolf
5b765b9ec5
Add Arch Linux to installing from source docs
...
Note that Arch Linux usually has no separate `-dev` packages, but ships development headers with the normal package.
2025-09-19 16:55:45 +02:00
Daniel Rudolf
8f63d984be
Update install docs to include SETUPTOOLS_SCM_PRETEND_VERSION
2025-09-13 20:37:52 +02:00
TW
332ef28c7e
Merge pull request #8988 from ThomasWaldmann/vagrant-debian-testing-master
...
Vagrant: debian testing/trixie box (master)
2025-08-17 16:50:52 +02:00
dataprolet
5b01535768
Adds systemd-inhibit and examples ( #8989 )
2025-08-11 15:06:36 +02:00
Thomas Waldmann
85e0e05f35
vagrant: add debian trixie box
...
currently still known as "testing",
but soon to be released.
2025-08-09 16:28:47 +02:00
Thomas Waldmann
4905fd8bea
update CHANGES
2025-08-02 11:21:28 +02:00
Thomas Waldmann
f327af11a6
build_usage build_man
2025-08-02 11:12:20 +02:00
Thomas Waldmann
1f75c40d34
update CHANGES
2025-08-01 20:19:04 +02:00
Thomas Waldmann
9b26b1011a
build_usage build_man
2025-06-18 17:35:37 +02:00
Thomas Waldmann
840c0c4788
update CHANGES
2025-06-18 17:31:57 +02:00
Thomas Waldmann
1e40d74f88
update CHANGES
2025-06-14 17:20:53 +02:00
Thomas Waldmann
d23704e112
buzhash64: docs
2025-06-10 23:42:22 +02:00
Thomas Waldmann
b116971217
update CHANGES
2025-06-10 01:09:25 +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
5ca22e9c10
update CHANGES
2025-06-03 20:26:10 +02:00
Thomas Waldmann
456e319bb6
docs: fix mistyped CVE number
2025-05-23 09:26:26 +02:00
Thomas Waldmann
7072f6263d
ChunkerParams: reject even window size for buzhash, fixes #8868
2025-05-23 06:49:52 +02:00
Thomas Waldmann
6b87fec1f7
update CHANGES
2025-05-22 14:22:10 +02:00
Thomas Waldmann
fa01a2d46a
build_usage build_man
2025-05-22 13:21:21 +02:00
Thomas Waldmann
5b24e774b7
update CHANGES
2025-05-22 12:46:05 +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
6e0a11cb96
update CHANGES
2025-05-18 09:57:29 +02:00
Thomas Waldmann
b6ee18fffc
docs: minor formatting changes in development docs
2025-05-07 17:02:29 +02:00
Thomas Waldmann
b68552aef2
docs: announce releases on Mastodon, bsky, X
2025-05-07 16:53:30 +02:00
Thomas Waldmann
32ce149caa
docs: refer to more current 1.4-maint
2025-05-07 16:48:55 +02:00
Thomas Waldmann
ae423cfd10
docs: must have the release tags in the local repo, fixes #8582
2025-05-07 16:45:53 +02:00
Thomas Waldmann
524d927871
build_usage build_man
2025-05-06 01:37:17 +02:00
Thomas Waldmann
3bca22a0a3
update CHANGES
2025-05-06 01:35:29 +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