borgbackup 1.4.4__tar.gz → 1.4.6rc1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- borgbackup-1.4.6rc1/.claude/CLAUDE.md +171 -0
- borgbackup-1.4.6rc1/.claude/settings.json +48 -0
- borgbackup-1.4.6rc1/.pre-commit-config.yaml +8 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/.readthedocs.yaml +1 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/CHANGES.rst +202 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/LICENSE +1 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/PKG-INFO +6 -8
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/README.rst +4 -20
- borgbackup-1.4.6rc1/docs/_templates/downloads.html +27 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/binaries/00_README.txt +10 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/borg_theme/css/borg.css +14 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/changes.rst +202 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/conf.py +6 -4
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/deployment/automated-local.rst +20 -14
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/deployment/pull-backup.rst +13 -3
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/development.rst +16 -28
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/faq.rst +205 -23
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/data-structures.rst +3 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-benchmark-crud.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-benchmark.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-break-lock.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-check.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-common.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-compact.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-compression.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-config.1 +8 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-create.1 +30 -3
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-delete.1 +8 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-diff.1 +11 -8
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-export-tar.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-extract.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-import-tar.1 +5 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-info.1 +9 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-init.1 +25 -20
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-key-change-passphrase.1 +2 -2
- borgbackup-1.4.6rc1/docs/man/borg-key-export-related-secrets.1 +109 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-key-export.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-key-import.1 +5 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-key-migrate-to-repokey.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-key.1 +4 -3
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-list.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-mount.1 +28 -6
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-patterns.1 +6 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-placeholders.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-prune.1 +8 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-recreate.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-rename.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-serve.1 +3 -3
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-umount.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-upgrade.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-version.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg-with-lock.1 +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borg.1 +46 -11
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man/borgfs.1 +28 -6
- borgbackup-1.4.6rc1/docs/misc/asciinema/Containerfile +48 -0
- borgbackup-1.4.6rc1/docs/misc/asciinema/README.md +62 -0
- borgbackup-1.4.6rc1/docs/misc/asciinema/borg14-demo.cast +2709 -0
- borgbackup-1.4.6rc1/docs/misc/asciinema/demo-data.py +115 -0
- borgbackup-1.4.6rc1/docs/misc/asciinema/demo.tcl +181 -0
- borgbackup-1.4.6rc1/docs/misc/asciinema/entrypoint.sh +19 -0
- borgbackup-1.4.6rc1/docs/misc/asciinema/record.exp +10 -0
- borgbackup-1.4.6rc1/docs/misc/asciinema/record.sh +56 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/config.rst +6 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/create.rst.inc +26 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/delete.rst.inc +6 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/diff.rst.inc +8 -8
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/environment.rst.inc +13 -1
- borgbackup-1.4.6rc1/docs/usage/general/return-codes.rst.inc +43 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/help.rst.inc +4 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/import-tar.rst.inc +3 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/info.rst.inc +9 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/init.rst.inc +27 -22
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/key.rst +4 -0
- borgbackup-1.4.6rc1/docs/usage/key_export-related-secrets.rst.inc +82 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/mount.rst.inc +20 -4
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/notes.rst +94 -3
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/prune.rst.inc +7 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/serve.rst.inc +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/pyproject.toml +13 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/make.py +1 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/msys2-build +2 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/msys2-install-deps +0 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/shell_completions/bash/borg +1 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/shell_completions/fish/borg.fish +1 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/shell_completions/zsh/_borg +1 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/__init__.py +1 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/_chunker.c +44 -9
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/_hashindex.c +166 -71
- borgbackup-1.4.6rc1/src/borg/_version.py +1 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/algorithms/checksums.c +3509 -2631
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/algorithms/crc32_clmul.c +22 -25
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/archive.py +218 -42
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/archiver.py +334 -97
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/cache.py +42 -12
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/chunker.c +11584 -6349
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/chunker.pyx +28 -5
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/compress.c +8658 -4222
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/key.py +27 -6
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/low_level.c +8739 -5073
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/low_level.pyx +72 -28
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/fuse.py +8 -3
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/hashindex.c +6781 -4145
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/hashindex.pyx +6 -3
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/__init__.py +5 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/errors.py +22 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/msgpack.py +1 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/parseformat.py +49 -8
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/process.py +73 -36
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/yes.py +8 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/item.c +7199 -3847
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/locking.py +15 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/lrucache.py +2 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/nanorst.py +6 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/__init__.py +4 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/base.py +40 -15
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/darwin.c +6399 -3694
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/darwin.pyx +32 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/freebsd.c +4483 -2900
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/linux.c +10721 -6871
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/linux.pyx +27 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/posix.c +4041 -2556
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/posix.pyx +2 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/syncfilerange.c +1306 -1061
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/windows.c +3297 -2379
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/remote.py +163 -116
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/repository.py +27 -9
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/selftest.py +1 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/__init__.py +3 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/archive.py +78 -2
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/archiver.py +982 -35
- borgbackup-1.4.6rc1/src/borg/testsuite/checksums.py +144 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/chunker_pytest.py +147 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/conftest.py +18 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/crypto.py +14 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/hashindex.py +7 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/helpers.py +171 -11
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/key.py +28 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/locking.py +3 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/nanorst.py +6 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/platform.py +86 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/remote.py +46 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/repository.py +105 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/version.py +3 -3
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/xattr.py +7 -1
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borgbackup.egg-info/PKG-INFO +6 -8
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borgbackup.egg-info/SOURCES.txt +15 -13
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borgbackup.egg-info/requires.txt +1 -1
- borgbackup-1.4.6rc1/src/borgbackup.egg-info/scm_file_list.json +323 -0
- borgbackup-1.4.6rc1/src/borgbackup.egg-info/scm_version.json +8 -0
- borgbackup-1.4.4/.pre-commit-config.yaml +0 -5
- borgbackup-1.4.4/docs/man/borg-change-passphrase.1 +0 -57
- borgbackup-1.4.4/docs/misc/asciinema/README +0 -4
- borgbackup-1.4.4/docs/misc/asciinema/Vagrantfile +0 -75
- borgbackup-1.4.4/docs/misc/asciinema/advanced.json +0 -3869
- borgbackup-1.4.4/docs/misc/asciinema/advanced.tcl +0 -85
- borgbackup-1.4.4/docs/misc/asciinema/basic.json +0 -2651
- borgbackup-1.4.4/docs/misc/asciinema/basic.tcl +0 -89
- borgbackup-1.4.4/docs/misc/asciinema/install.json +0 -1007
- borgbackup-1.4.4/docs/misc/asciinema/install.tcl +0 -38
- borgbackup-1.4.4/docs/misc/asciinema/sample-wallpapers.txt +0 -30
- borgbackup-1.4.4/docs/usage/change-passphrase.rst.inc +0 -51
- borgbackup-1.4.4/docs/usage/general/return-codes.rst.inc +0 -22
- borgbackup-1.4.4/scripts/sdist-sign +0 -20
- borgbackup-1.4.4/scripts/upload-pypi +0 -18
- borgbackup-1.4.4/src/borg/_version.py +0 -1
- borgbackup-1.4.4/src/borg/testsuite/checksums.py +0 -43
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/AUTHORS +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/Brewfile +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/MANIFEST.in +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/README_WINDOWS.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/SECURITY.md +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/Makefile +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_static/Makefile +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_static/favicon.ico +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_static/logo.pdf +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_static/logo.png +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_static/logo.svg +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_static/logo_font.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_templates/globaltoc.html +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_templates/layout.html +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_templates/logo-text.html +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/_templates/versionselector.html +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/authors.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/book.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/deployment/central-backup-server.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/deployment/hosting-repositories.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/deployment/image-backup.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/deployment/non-root-user.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/deployment.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/global.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/index.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/installation.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/compaction.png +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/compaction.vsd +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/encryption.png +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/encryption.vsd +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/frontends.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/object-graph.png +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/object-graph.vsd +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/security.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/structure.png +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals/structure.vsd +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/internals.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/introduction.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/man_intro.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/misc/benchmark-crud.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/misc/borg-data-flow.png +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/misc/borg-data-flow.vsd +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/misc/create_chunker-params.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/misc/internals-picture.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/misc/logging.conf +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/misc/prune-example.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/quickstart.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/quickstart_example.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/support.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/benchmark.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/benchmark_crud.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/borgfs.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/borgfs.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/break-lock.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/check.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/check.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/common-options.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/compact.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/compact.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/config.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/create.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/debug.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/delete.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/diff.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/export-tar.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/extract.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/extract.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/date-time.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/file-metadata.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/file-systems.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/logging.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/positional-arguments.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/repository-locations.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/repository-urls.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/resources.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general/units.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/general.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/help.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/info.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/init.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/key_change-passphrase.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/key_export.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/key_import.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/key_migrate-to-repokey.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/list.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/list.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/lock.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/mount.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/prune.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/recreate.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/recreate.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/rename.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/rename.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/serve.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/tar.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/umount.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/upgrade.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/upgrade.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/usage_general.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/version.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/version.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage/with-lock.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage.rst +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/docs/usage_general.rst.inc +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/requirements.d/development.lock.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/requirements.d/development.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/requirements.d/docs.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/Dockerfile.linux-run +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/borg.exe.spec +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/errorlist.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/fetch-binaries +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/fuzz-cache-sync/HOWTO +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/fuzz-cache-sync/main.c +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/fuzz-cache-sync/testcase_dir/test_simple +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/glibc_check.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/hash_sizes.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/linux-run +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/scripts/sign-binaries +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/setup.cfg +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/setup.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/__main__.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/_endian.h +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/_item.c +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/algorithms/__init__.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/algorithms/checksums.pyx +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/algorithms/crc32_dispatch.c +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/algorithms/crc32_slice_by_8.c +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/cache_sync/cache_sync.c +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/cache_sync/sysdep.h +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/cache_sync/unpack.h +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/cache_sync/unpack_define.h +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/cache_sync/unpack_template.h +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/compress.pyx +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/constants.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/__init__.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/_crypto_helpers.c +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/_crypto_helpers.h +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/file_integrity.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/keymanager.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/crypto/nonces.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/fuse_impl.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/checks.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/datastruct.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/fs.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/manifest.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/misc.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/progress.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/helpers/time.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/item.pyx +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/logger.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/paperkey.html +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/patterns.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/freebsd.pyx +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/syncfilerange.pyx +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/windows.pyx +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platform/xattr.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/platformflags.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/shellpattern.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/attic.tar.gz +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/benchmark.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/cache.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/chunker.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/chunker_slow.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/compress.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/efficient_collection_queue.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/file_integrity.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/hashindex_pytest.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/issue_8535.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/item.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/logger.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/lrucache.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/nonces.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/patterns.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/shellpattern.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/upgrader.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/version.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/testsuite/xattr.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borg/upgrader.py +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borgbackup.egg-info/dependency_links.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borgbackup.egg-info/entry_points.txt +0 -0
- {borgbackup-1.4.4 → borgbackup-1.4.6rc1}/src/borgbackup.egg-info/top_level.txt +0 -0
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
4
|
+
|
|
5
|
+
Machine-specific settings (e.g. the local virtualenv path) live in the gitignored `CLAUDE.local.md`:
|
|
6
|
+
|
|
7
|
+
@CLAUDE.local.md
|
|
8
|
+
|
|
9
|
+
## Branch context
|
|
10
|
+
|
|
11
|
+
This checkout is based on `1.4-maint`, a stable maintenance branch (main development happens on
|
|
12
|
+
`master`). The current branch is either `1.4-maint` itself or a branch forked from it (e.g. to work on
|
|
13
|
+
a bug fix).
|
|
14
|
+
|
|
15
|
+
Only backport data-loss/corruption/security/forward-compat/doc fixes here — most PRs should target
|
|
16
|
+
`master` instead.
|
|
17
|
+
|
|
18
|
+
On the 1.4 line, `src/borg/archiver.py` is one large monolithic file (all `do_*` command
|
|
19
|
+
implementations); on `master` it is split into separate modules in `src/borg/archiver/` package.
|
|
20
|
+
Don't be surprised by the difference if you're comparing against upstream docs or memory of the codebase.
|
|
21
|
+
|
|
22
|
+
## Build
|
|
23
|
+
|
|
24
|
+
Borg has Cython/C extensions and must be built before it can run.
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
source <project-virtualenv>/bin/activate # see @CLAUDE.local.md for the local path
|
|
28
|
+
pip install -r requirements.d/development.txt
|
|
29
|
+
pip install -e . # builds Cython/C extensions in place
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Requires Python >=3.10, Cython >=3.0.3, pkgconfig, and dev headers for OpenSSL, lz4, zstd, xxhash.
|
|
33
|
+
|
|
34
|
+
Env vars to point the build at non-standard lib locations: `BORG_OPENSSL_PREFIX`, `BORG_LIBLZ4_PREFIX`,
|
|
35
|
+
`BORG_LIBZSTD_PREFIX`, `BORG_LIBXXHASH_PREFIX`.
|
|
36
|
+
|
|
37
|
+
After editing any `.pyx`/`.c` file, rebuild the extensions:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
python scripts/make.py clean && pip install -e .
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
If you are requested to build a BINARY (the usual borg build does not build a binary as it is Python),
|
|
44
|
+
a pyinstaller-made binary is meant. On this `1.4-maint` branch:
|
|
45
|
+
|
|
46
|
+
- POSIX: `pyinstaller --clean --distpath=dist/binary/ scripts/borg.exe.spec`
|
|
47
|
+
|
|
48
|
+
## Writing tests
|
|
49
|
+
|
|
50
|
+
Always write pytest-style tests unless unittest-style is explicitly required.
|
|
51
|
+
|
|
52
|
+
## Writing docstrings, comments, documentation
|
|
53
|
+
|
|
54
|
+
The docs shall always be in sync with the current code, algorithms and data structures.
|
|
55
|
+
|
|
56
|
+
The docs must:
|
|
57
|
+
- describe how it works, what it does, in its CURRENT state.
|
|
58
|
+
- use "TODO:" comments to refer to future tasks
|
|
59
|
+
|
|
60
|
+
The docs must not:
|
|
61
|
+
- describe what the code did in the past
|
|
62
|
+
- describe something that the code is NOT doing in its current state.
|
|
63
|
+
|
|
64
|
+
## Running code or tests
|
|
65
|
+
|
|
66
|
+
Always activate the project virtualenv first (see `@CLAUDE.local.md` for its local path).
|
|
67
|
+
|
|
68
|
+
## Tests
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# Run everything (never omit --benchmark-skip unless you specifically want the slow benchmarks).
|
|
72
|
+
# Running all the tests without parallelizing them is very slow, the parallel variant should be preferred.
|
|
73
|
+
pytest --benchmark-skip -v -rs -n auto # parallel variant
|
|
74
|
+
pytest --benchmark-skip -v -rs # sequential (slow)
|
|
75
|
+
|
|
76
|
+
# Single file / single test
|
|
77
|
+
pytest src/borg/testsuite/archiver.py
|
|
78
|
+
pytest src/borg/testsuite/archiver.py::TestClass::test_method
|
|
79
|
+
|
|
80
|
+
# Via tox (matches CI; needs fakeroot for full coverage, most tests still work without it)
|
|
81
|
+
fakeroot -u tox # all tests
|
|
82
|
+
fakeroot -u tox --recreate # after changing tox.ini
|
|
83
|
+
fakeroot -u tox -e py310 # one Python version only
|
|
84
|
+
fakeroot -u tox borg.testsuite.locking # one test module
|
|
85
|
+
fakeroot -u tox borg.testsuite.locking -- -k 'not Timer' # -- requires the module path too
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Test env vars: `BORG_TESTS_IGNORE_MODES` (disable mode/permission tests), `BORG_FUSE_IMPL=llfuse|pyfuse3`
|
|
89
|
+
(select FUSE implementation for mount tests).
|
|
90
|
+
|
|
91
|
+
Tests live in `src/borg/testsuite/`, see `python_files` in `pyproject.toml`.
|
|
92
|
+
|
|
93
|
+
macOS users without a Linux box can run the Linux test matrix via Podman: `./scripts/linux-run tox -e py311-pyfuse3`.
|
|
94
|
+
|
|
95
|
+
## Lint
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
tox -e ruff # or: ruff check .
|
|
99
|
+
pre-commit install # one-time, so pre-commit hooks run automatically on commit
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Style: PEP 8 at 120 columns (not 79). Comments/docstrings that are full sentences end with a period.
|
|
103
|
+
Per-file ruff ignores (mostly `E501`/`F401`/legacy `E722`/`E741`) are listed in `pyproject.toml`
|
|
104
|
+
under `[tool.ruff.per-file-ignores]` — check there before "fixing" a lint warning in an old file;
|
|
105
|
+
it may be intentionally exempted.
|
|
106
|
+
|
|
107
|
+
Python code files must never have trailing blanks at the end of lines.
|
|
108
|
+
Python code files must always end with exactly one linefeed character at the end of the file.
|
|
109
|
+
|
|
110
|
+
## Committing
|
|
111
|
+
|
|
112
|
+
The working tree has a lot of stray untracked scratch files at the repo root — these are the user's
|
|
113
|
+
own working notes, not build artifacts.
|
|
114
|
+
Never do `git add -A` / `git add .`; stage only the files you intentionally changed.
|
|
115
|
+
|
|
116
|
+
## Architecture
|
|
117
|
+
|
|
118
|
+
Borg is a client encrypting/deduplicating/compressing data *before* it ever reaches the repository,
|
|
119
|
+
so the repository storage layer never sees plaintext or has any notion of files/archives.
|
|
120
|
+
|
|
121
|
+
**Layering, bottom to top:**
|
|
122
|
+
|
|
123
|
+
- **`repository.py`** — a transactional, append-only key→value store (`Repository`). Keys are 32-byte
|
|
124
|
+
IDs; the repo doesn't know what an "archive" or "file" is. Segments in `data/` are the journal; a
|
|
125
|
+
segment ordering + `COMMIT` entries define transaction boundaries and crash consistency. The
|
|
126
|
+
`HashIndex` (`_hashindex.c`/`hashindex.pyx`) maps object IDs to segment+offset. See
|
|
127
|
+
`docs/internals/data-structures.rst` for the full on-disk format spec — read it before touching
|
|
128
|
+
repository/segment/index code.
|
|
129
|
+
- **`remote.py`** — `RemoteRepository` (client) / `RepositoryServer` (server side of `borg serve`)
|
|
130
|
+
implement the same key-value API over a RPC protocol on stdin/stdout (used for
|
|
131
|
+
`ssh://` repos). Every method callable remotely must be allowlisted in `RepositoryServer.rpc_methods`.
|
|
132
|
+
- **`crypto/key.py`, `crypto/low_level.pyx`** — encryption/authentication (AES + HMAC-SHA256, or
|
|
133
|
+
ChaCha20-Poly1305/BLAKE2) and key file handling (keyfile vs repokey storage). `id_hash` used for
|
|
134
|
+
deduplication depends on the encryption mode.
|
|
135
|
+
- **`compress.pyx`**, **`chunkers/`** (buzhash, buzhash64, fastcdc in Cython/C) — per-chunk compression
|
|
136
|
+
and content-defined chunking; chunking is what makes dedup insensitive to shifted/inserted bytes.
|
|
137
|
+
- **`cache.py`, `cache_sync/`** — the local chunks/files cache (which chunk IDs already exist in the
|
|
138
|
+
repo, refcounts) used to decide what needs uploading; synced against the repository's authoritative
|
|
139
|
+
state via `cache_sync` (C-accelerated msgpack stream unpacking).
|
|
140
|
+
- **`archive.py`** — `Archive`/`Manifest`: the next layer up, turning the flat KV store into archives
|
|
141
|
+
made of `Item`s (files/dirs/links, see `item.pyx`) referencing chunk lists. The manifest
|
|
142
|
+
(`helpers/manifest.py`) is itself an object in the repo listing all archives.
|
|
143
|
+
- **`archiver.py`** — the CLI: argument parsing (`build_parser`, one `subparsers.add_parser(...)` block
|
|
144
|
+
per subcommand) and one `do_<command>` method per subcommand, e.g. `do_create`, `do_check`. This is
|
|
145
|
+
the file to search first when changing or adding a CLI command/flag.
|
|
146
|
+
- **`platform/`** — per-OS backends (Linux/Darwin/FreeBSD/NetBSD/Windows) for xattrs, ACLs, syncing,
|
|
147
|
+
process info; `platform/__init__.py` picks the right implementation at import time.
|
|
148
|
+
- **`helpers/`** — grab-bag of utilities used across layers (arg/format parsing, msgpack helpers,
|
|
149
|
+
progress reporting, filesystem helpers); check here before writing a new utility, it may exist.
|
|
150
|
+
|
|
151
|
+
**Client/server split:** most `do_*` archiver commands operate against a `Repository` or
|
|
152
|
+
`RemoteRepository` transparently — the choice of local vs. `ssh://` is resolved by `Location` parsing
|
|
153
|
+
in `helpers/` and doesn't otherwise change command logic. `borg serve` on the remote end runs
|
|
154
|
+
`RepositoryServer`, which allowlists and dispatches RPCs to a local `Repository`.
|
|
155
|
+
|
|
156
|
+
**Docs as source of truth for on-disk formats:** `docs/internals/data-structures.rst` documents the
|
|
157
|
+
repository/segment/index/manifest/archive/item/cache formats in detail and is more authoritative than
|
|
158
|
+
guessing from code — read the relevant section before changing serialization or the transaction log.
|
|
159
|
+
CLI usage docs (`docs/usage/`) and man pages are generated from the argparse definitions in
|
|
160
|
+
`archiver.py` (`python scripts/make.py build_usage`/`build_man`); don't hand-edit generated usage docs,
|
|
161
|
+
and don't feel obligated to regenerate them for every CLI change — that's normally done at release time.
|
|
162
|
+
|
|
163
|
+
## Logging conventions
|
|
164
|
+
|
|
165
|
+
Use the correct log level (debug only for debugging; info/warning/error/critical as appropriate).
|
|
166
|
+
|
|
167
|
+
When directly prompting the user (e.g. Y/N confirmations), write straight to stderr, not through the
|
|
168
|
+
logger and not to stdout (stdout may be piped). Info-level volume is controlled via flags like
|
|
169
|
+
`--stats`/`--list` feeding topic loggers — see `_setup_implied_logging()` in `archiver.py`.
|
|
170
|
+
|
|
171
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"permissions": {
|
|
4
|
+
"allow": [
|
|
5
|
+
"Read",
|
|
6
|
+
"Grep",
|
|
7
|
+
"Glob",
|
|
8
|
+
"Bash(ls:*)",
|
|
9
|
+
"Bash(cat:*)",
|
|
10
|
+
"Bash(rg:*)",
|
|
11
|
+
"Bash(find:*)",
|
|
12
|
+
"Bash(which:*)",
|
|
13
|
+
"Bash(pytest:*)",
|
|
14
|
+
"Bash(python -m pytest:*)",
|
|
15
|
+
"Bash(ruff:*)",
|
|
16
|
+
"Bash(tox:*)",
|
|
17
|
+
"Bash(fakeroot -u tox:*)",
|
|
18
|
+
"Bash(pre-commit run:*)",
|
|
19
|
+
"Bash(python scripts/make.py:*)",
|
|
20
|
+
"Bash(git status:*)",
|
|
21
|
+
"Bash(git diff:*)",
|
|
22
|
+
"Bash(git log:*)",
|
|
23
|
+
"Bash(git show:*)",
|
|
24
|
+
"Bash(git branch:*)",
|
|
25
|
+
"Bash(git blame:*)",
|
|
26
|
+
"Bash(git stash list:*)",
|
|
27
|
+
"Bash(PAGER=cat gh:*)"
|
|
28
|
+
],
|
|
29
|
+
"ask": [
|
|
30
|
+
"Bash(git push:*)",
|
|
31
|
+
"Bash(gh pr create:*)",
|
|
32
|
+
"Bash(gh pr merge:*)",
|
|
33
|
+
"Bash(pip install:*)"
|
|
34
|
+
],
|
|
35
|
+
"deny": [
|
|
36
|
+
"Bash(git add -A:*)",
|
|
37
|
+
"Bash(git add --all:*)",
|
|
38
|
+
"Bash(git add .)",
|
|
39
|
+
"Bash(rm -rf /:*)",
|
|
40
|
+
"Bash(rm -rf ~:*)",
|
|
41
|
+
"Read(.env)",
|
|
42
|
+
"Read(.env.*)",
|
|
43
|
+
"Read(**/.ssh/**)",
|
|
44
|
+
"Read(**/*_key)",
|
|
45
|
+
"Read(**/*.pem)"
|
|
46
|
+
]
|
|
47
|
+
}
|
|
48
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
3
|
+
rev: v0.0.287
|
|
4
|
+
hooks:
|
|
5
|
+
- id: ruff
|
|
6
|
+
# Use only this repo's config: without --config, this ruff version also parses any
|
|
7
|
+
# pyproject.toml in parent directories and fails on newer settings it can't parse.
|
|
8
|
+
args: [--config, pyproject.toml]
|
|
@@ -414,14 +414,214 @@ Compatibility notes:
|
|
|
414
414
|
Change Log
|
|
415
415
|
==========
|
|
416
416
|
|
|
417
|
-
Version 1.4.
|
|
418
|
-
|
|
417
|
+
Version 1.4.6rc1 (2026-11-16)
|
|
418
|
+
-----------------------------
|
|
419
419
|
|
|
420
420
|
For upgrade and compatibility hints, please also read the "Upgrade Notes" section
|
|
421
421
|
above.
|
|
422
422
|
|
|
423
423
|
New features:
|
|
424
424
|
|
|
425
|
+
- info: add --quick-stats option
|
|
426
|
+
|
|
427
|
+
As with create/import-tar/delete/prune, --quick-stats skips the
|
|
428
|
+
slow repository-wide "All archives" and chunk index statistics.
|
|
429
|
+
|
|
430
|
+
Fixes:
|
|
431
|
+
|
|
432
|
+
- fixed chunker: fix silent truncation of archived files, #10565.
|
|
433
|
+
|
|
434
|
+
Files returning short reads (e.g. --read-special from a FIFO) were archived
|
|
435
|
+
incompletely. A short read does not imply EOF!
|
|
436
|
+
- fixed chunker: ignore posix_fadvise() errors, e.g. ESPIPE for a FIFO, #10565
|
|
437
|
+
- buzhash chunker: retry read() on EINTR, #10617.
|
|
438
|
+
|
|
439
|
+
Previously, a signal (first Ctrl-C / SIGINT, SIGUSR1, SIGINFO) arriving
|
|
440
|
+
during a read dropped the file being read from the archive with a read error.
|
|
441
|
+
- chunkers: improve validation of chunker params to avoid crashes
|
|
442
|
+
- xattrs: failing to get an xattr is now a warning rc (was: success rc), #10612.
|
|
443
|
+
|
|
444
|
+
Fixed half-silent loss of metadata: for xattrs that could not be read (e.g.
|
|
445
|
+
because they were too big or access was denied), borg emitted a warning,
|
|
446
|
+
but did not exit with a warning rc.
|
|
447
|
+
- prepare_subprocess_env: remove all passphrase-related env vars, #6480
|
|
448
|
+
- create:
|
|
449
|
+
|
|
450
|
+
- back up automounted directories, #6652.
|
|
451
|
+
|
|
452
|
+
borg used to skip automounted directories (and their contents) because it
|
|
453
|
+
suspected a race condition (the inode of the mountpoint directory changed
|
|
454
|
+
when it was opened).
|
|
455
|
+
- do not archive an atime we caused ourselves, #6194
|
|
456
|
+
- Ctrl-C writes the checkpoint and stops, #10625
|
|
457
|
+
- extract:
|
|
458
|
+
|
|
459
|
+
- report a failing close() of a destination file as a warning
|
|
460
|
+
- remote: use deques for the RPC call queues (performance fix), #10450
|
|
461
|
+
- never try to remove the extraction directory itself
|
|
462
|
+
- skip a hard link item that refers to itself, see #10393
|
|
463
|
+
- recreate:
|
|
464
|
+
|
|
465
|
+
- also do the work if --timestamp is the only change requested
|
|
466
|
+
- keep chunker_params if not rechunkifying, #10127
|
|
467
|
+
- show --stats output without --info
|
|
468
|
+
- import-tar: fix nfiles being counted twice for regular files
|
|
469
|
+
- diff: fix --numeric-ids having no effect
|
|
470
|
+
- serve: log the "connection closed before repository was opened" message to stderr, not stdout
|
|
471
|
+
- --bypass-lock: also skip the cache lock, #7255
|
|
472
|
+
- fix a false repo relocation warning on macOS due to NFC/NFD path differences, #2913
|
|
473
|
+
- locking: fix broken exclusivity on Cygwin, #7218
|
|
474
|
+
- macOS: fix TypeError when _get_birthtime_ns gets called with an FD
|
|
475
|
+
- security: the same local repo dir accessed via another path is not a relocation, #8188
|
|
476
|
+
- add_warning: store exceptions given as args as text, not the exception (uses much less memory)
|
|
477
|
+
- fix daemonizing: don't lose an early notify signal from the background process
|
|
478
|
+
- let Ctrl-C / SIGINT abort interactive prompts (y/n and passphrase), #8521
|
|
479
|
+
- repository:
|
|
480
|
+
|
|
481
|
+
- do not crash on missing segment files/dirs, #3225
|
|
482
|
+
- rebuild index/hints if integrity.N is malformed
|
|
483
|
+
- remote: drain stderr in close() to avoid a deadlock, #10165
|
|
484
|
+
- ellipsis_truncate: pad a truncated string to the full width (CJK fix), #10481
|
|
485
|
+
- Haiku: tolerate failures reading the lock directory
|
|
486
|
+
- crc32_clmul: only feed full aligned blocks to the folding code, #10151
|
|
487
|
+
- hashindex: check the marker length in iteritems()
|
|
488
|
+
|
|
489
|
+
Other changes:
|
|
490
|
+
|
|
491
|
+
- Release automation for sdist, GitHub release and PyPI (similar as in already
|
|
492
|
+
done for borg2 beta releases).
|
|
493
|
+
|
|
494
|
+
Support PyPI's new security tab with provenance attestation.
|
|
495
|
+
|
|
496
|
+
On GitHub releases, every release asset now comes with the sigstore bundle
|
|
497
|
+
of its provenance attestation as <asset>.sigstore.jsonl.
|
|
498
|
+
|
|
499
|
+
Release assets are no longer built and GPG-signed locally.
|
|
500
|
+
- support Python 3.15
|
|
501
|
+
- support msgpack up to 1.2.4
|
|
502
|
+
- hashindex: read/write buckets in <= 256 MiB slices, works around #6140
|
|
503
|
+
- platform: determine hostname / fqdn / hostid lazily, refs #9470
|
|
504
|
+
- cache sync: log per-archive messages at debug level, #9659
|
|
505
|
+
- crypto: raise IntegrityError for truncated AE envelopes
|
|
506
|
+
- docs:
|
|
507
|
+
|
|
508
|
+
- fix the init epilog about what "none" mode can (not) detect
|
|
509
|
+
- FAQ: chunker params for SQLite databases, #5877
|
|
510
|
+
- FAQ: document how to limit bandwidth in both directions, #8838
|
|
511
|
+
- refactor return code docs, #9948
|
|
512
|
+
- update README, #9931
|
|
513
|
+
- new borg 1.4 demo screencast
|
|
514
|
+
- automated-local: support multiple backup drives, #9834
|
|
515
|
+
- list additional help topics in the main borg help, #3432
|
|
516
|
+
- nanorst: do not require 2 empty lines at the end of a string after a code block, #9714
|
|
517
|
+
- tests / CI:
|
|
518
|
+
|
|
519
|
+
- fix inode-order dependence in test_multiple_link_exclusion, #8740
|
|
520
|
+
- update and pin GitHub Actions
|
|
521
|
+
- re-enable the Windows MSYS2 build
|
|
522
|
+
- use PyInstaller 6.22.3 for MSYS2 py314
|
|
523
|
+
- test_atime: do not create a hard link (fixes the test on Cygwin)
|
|
524
|
+
- relax the sparse file SEEK_DATA check
|
|
525
|
+
- speed up the prune tests
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
Version 1.4.5 (2026-07-19)
|
|
529
|
+
--------------------------
|
|
530
|
+
|
|
531
|
+
New features:
|
|
532
|
+
|
|
533
|
+
- create/import-tar/delete/prune --quick-stats: faster than --stats by omitting "All archives"
|
|
534
|
+
and repository chunk statistics, #9579, #9757
|
|
535
|
+
- prune: show total vs matching archives in output, #9262
|
|
536
|
+
- create --exclude-dataless: macOS: skip cloud files not materialized locally, #9746
|
|
537
|
+
- support BORG_HOSTNAME and BORG_USERNAME env vars to override the hostname/username stored
|
|
538
|
+
in archives and used by the {hostname}/{user} placeholders, #9651
|
|
539
|
+
- Minimal implementation of "related repositories", #9645
|
|
540
|
+
|
|
541
|
+
This feature allows multiple repositories to share deduplication-relevant secrets
|
|
542
|
+
(id_key and chunk_seed) while maintaining secure, independent encryption keys.
|
|
543
|
+
|
|
544
|
+
- borg key export-related-secrets <REPO> <SPATH>
|
|
545
|
+
- borg init --import-related-secrets <SPATH> <REPO>
|
|
546
|
+
- BORG_JSON_INDENT env var for JSON output formatting, #3605
|
|
547
|
+
- BORG_HOSTNAME and BORG_USERNAME env vars, #9651
|
|
548
|
+
|
|
549
|
+
Fixes:
|
|
550
|
+
|
|
551
|
+
- extract: security fixes for CVE-2026-62268 (low severity: attacker would need
|
|
552
|
+
repository write access and, if the repo is encrypted, also borg key and passphrase).
|
|
553
|
+
- create: do not wrap repository writes in backup_io("read"), #9854
|
|
554
|
+
- Archive.delete: don't reuse msgpack Unpacker after an unpacking failure
|
|
555
|
+
- slashdot hack: fix exclusion of source directory metadata, #9534
|
|
556
|
+
- hashindex: fix new checks for big endian archs, #9521
|
|
557
|
+
|
|
558
|
+
- Note:
|
|
559
|
+
|
|
560
|
+
Many of the fixed issues listed below relate to rather rare or theoretical
|
|
561
|
+
issues and were found by automated code checking.
|
|
562
|
+
|
|
563
|
+
- LRUCache: resolve KeyError and memory leaks, #9587
|
|
564
|
+
- crypto.low_level: fix freeing of memory, #9585
|
|
565
|
+
- extract: resolve memory leak on abandoned async requests in RemoteRepository, #9588.
|
|
566
|
+
This can happen if borg fails to extract a file due to permission or other errors
|
|
567
|
+
or if the archived file had all-zero replacement chunks or inconsistent size.
|
|
568
|
+
- Chunker fixes, #9586:
|
|
569
|
+
|
|
570
|
+
- Strictly check the return value of fd.read(n) and reject if it returns more
|
|
571
|
+
bytes than requested.
|
|
572
|
+
- Avoid giving len <= 0 to posix_fadvise(), which could drop the rest of the
|
|
573
|
+
file from the cache.
|
|
574
|
+
- buzhash: check for len == 0 edge case
|
|
575
|
+
- Correctly Py_DECREF in cases of errors.
|
|
576
|
+
- Check for malloc/calloc failures.
|
|
577
|
+
- Hashindex fixes, #9575:
|
|
578
|
+
|
|
579
|
+
- Make it possible to look up in compacted hashtables.
|
|
580
|
+
- Avoid buckets_length integer overflow on 32-bit systems via huge num_buckets.
|
|
581
|
+
- Deal safely with empty index: we must use num_buckets = 1 to avoid division
|
|
582
|
+
by zero and sanity check in hashindex_read.
|
|
583
|
+
- Always initialize min_empty and num_empty.
|
|
584
|
+
- Reinitialize upper/lower limit and min_empty after compact.
|
|
585
|
+
- Fix size_idx / fit_size / grow_size / shrink_size (mind array bounds).
|
|
586
|
+
- Deal with growing when already at max capacity.
|
|
587
|
+
- hashindex_resize: replace num_entries assertion, return an error instead.
|
|
588
|
+
- Correctly free memory when header validation fails.
|
|
589
|
+
- BaseIndex.clear: always stay in valid state.
|
|
590
|
+
Do not free the old index before we successfully have allocated a new one.
|
|
591
|
+
|
|
592
|
+
Other changes:
|
|
593
|
+
|
|
594
|
+
- msgpack: also allow up to 1.2.1
|
|
595
|
+
- use F_FULLFSYNC on macOS for SyncFile data durability, #9383
|
|
596
|
+
- mount: drop runtime warning about symlinks and improve corresponding docs
|
|
597
|
+
- mount: improve error msg when uid/gid cannot be resolved, #9574
|
|
598
|
+
- properly handle invalid and dev versions in version parser, fixes #9014
|
|
599
|
+
- tests: reset borg.output.progress logger between tests to fix flakiness
|
|
600
|
+
- docs:
|
|
601
|
+
|
|
602
|
+
- borgbackup.readthedocs.io: offer PDF and html downloads in sidebar, #9731
|
|
603
|
+
- fix 'borg key change-passphrase' docs, #9697
|
|
604
|
+
- impact of the slashdot hack on pattern matching, #9647
|
|
605
|
+
- pull-backup.rst minor fixes
|
|
606
|
+
- sshfs + chroot does not support different CPU architectures, #6878
|
|
607
|
+
- document max_segment_size adjustment, #7858
|
|
608
|
+
- add section about rolling back a transaction, #9270
|
|
609
|
+
- clarify storage quota run-time settings, #3948
|
|
610
|
+
- add FAQ entry about scalability, #4742
|
|
611
|
+
- add FAQ entry for full repository filesystem, #9573
|
|
612
|
+
- add FAQ entry for bad backups and deduplication, #4744
|
|
613
|
+
- add FAQ entry for SSH connection timeouts, #5629
|
|
614
|
+
- improve macOS Keychain instructions, #5156
|
|
615
|
+
- add DoS warning for none encryption mode, #6715
|
|
616
|
+
- document error handling in borg create, #4912
|
|
617
|
+
- update year in LICENSE and docs/conf.py
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
Version 1.4.4 (2026-03-19)
|
|
621
|
+
--------------------------
|
|
622
|
+
|
|
623
|
+
New features:
|
|
624
|
+
|
|
425
625
|
- prune: added -v / --info output, #9262.
|
|
426
626
|
- mount: warn about symlinks pointing outside of the mount point, #9254.
|
|
427
627
|
- create/info: remember/show cwd at the time of archive creation, #6191.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: borgbackup
|
|
3
|
-
Version: 1.4.
|
|
3
|
+
Version: 1.4.6rc1
|
|
4
4
|
Summary: Deduplicated, encrypted, authenticated and compressed backups
|
|
5
5
|
Author: The Borg Collective (see AUTHORS file)
|
|
6
6
|
Maintainer-email: Thomas Waldmann <tw@waldmann-edv.de>
|
|
@@ -26,12 +26,13 @@ Classifier: Programming Language :: Python :: 3.11
|
|
|
26
26
|
Classifier: Programming Language :: Python :: 3.12
|
|
27
27
|
Classifier: Programming Language :: Python :: 3.13
|
|
28
28
|
Classifier: Programming Language :: Python :: 3.14
|
|
29
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
29
30
|
Classifier: Topic :: Security :: Cryptography
|
|
30
31
|
Classifier: Topic :: System :: Archiving :: Backup
|
|
31
32
|
Requires-Python: >=3.10
|
|
32
33
|
License-File: LICENSE
|
|
33
34
|
License-File: AUTHORS
|
|
34
|
-
Requires-Dist: msgpack<=1.
|
|
35
|
+
Requires-Dist: msgpack<=1.2.4,>=1.0.3
|
|
35
36
|
Requires-Dist: packaging
|
|
36
37
|
Provides-Extra: llfuse
|
|
37
38
|
Requires-Dist: llfuse>=1.3.8; extra == "llfuse"
|
|
@@ -56,10 +57,8 @@ fully trusted targets.
|
|
|
56
57
|
|
|
57
58
|
See the `installation manual`_ or, if you have already
|
|
58
59
|
downloaded Borg, ``docs/installation.rst`` to get started with Borg.
|
|
59
|
-
There is also an `offline documentation`_ available, in multiple formats.
|
|
60
60
|
|
|
61
61
|
.. _installation manual: https://borgbackup.readthedocs.io/en/stable/installation.html
|
|
62
|
-
.. _offline documentation: https://readthedocs.org/projects/borgbackup/downloads
|
|
63
62
|
|
|
64
63
|
Main features
|
|
65
64
|
~~~~~~~~~~~~~
|
|
@@ -168,7 +167,7 @@ Now doing another backup, just to show off the great deduplication::
|
|
|
168
167
|
-----------------------------------------------------------------------------
|
|
169
168
|
|
|
170
169
|
|
|
171
|
-
For
|
|
170
|
+
For demo videos, check out our homepage: https://www.borgbackup.org/#demo
|
|
172
171
|
|
|
173
172
|
Helping, donations and bounties, becoming a Patron
|
|
174
173
|
--------------------------------------------------
|
|
@@ -179,16 +178,15 @@ Spread the word, give feedback, help with documentation, testing or development.
|
|
|
179
178
|
|
|
180
179
|
You can also give monetary support to the project, see there for details:
|
|
181
180
|
|
|
182
|
-
https://www.borgbackup.org
|
|
181
|
+
https://www.borgbackup.org/#fund
|
|
183
182
|
|
|
184
183
|
Links
|
|
185
184
|
-----
|
|
186
185
|
|
|
187
|
-
* `Main website <https://borgbackup.
|
|
186
|
+
* `Main website <https://www.borgbackup.org/>`_
|
|
188
187
|
* `Releases <https://github.com/borgbackup/borg/releases>`_,
|
|
189
188
|
`PyPI packages <https://pypi.python.org/pypi/borgbackup>`_ and
|
|
190
189
|
`Changelog <https://github.com/borgbackup/borg/blob/master/docs/changes.rst>`_
|
|
191
|
-
* `Offline documentation <https://readthedocs.org/projects/borgbackup/downloads>`_
|
|
192
190
|
* `GitHub <https://github.com/borgbackup/borg>`_ and
|
|
193
191
|
`Issue tracker <https://github.com/borgbackup/borg/issues>`_.
|
|
194
192
|
* `Web chat (IRC) <https://web.libera.chat/#borgbackup>`_ and
|
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
|screencast_basic|
|
|
2
|
-
|
|
3
|
-
More screencasts: `installation`_, `advanced usage`_
|
|
4
|
-
|
|
5
1
|
What is BorgBackup?
|
|
6
2
|
-------------------
|
|
7
3
|
|
|
@@ -16,10 +12,8 @@ fully trusted targets.
|
|
|
16
12
|
|
|
17
13
|
See the `installation manual`_ or, if you have already
|
|
18
14
|
downloaded Borg, ``docs/installation.rst`` to get started with Borg.
|
|
19
|
-
There is also an `offline documentation`_ available, in multiple formats.
|
|
20
15
|
|
|
21
16
|
.. _installation manual: https://borgbackup.readthedocs.io/en/stable/installation.html
|
|
22
|
-
.. _offline documentation: https://readthedocs.org/projects/borgbackup/downloads
|
|
23
17
|
|
|
24
18
|
Main features
|
|
25
19
|
~~~~~~~~~~~~~
|
|
@@ -128,7 +122,7 @@ Now doing another backup, just to show off the great deduplication::
|
|
|
128
122
|
-----------------------------------------------------------------------------
|
|
129
123
|
|
|
130
124
|
|
|
131
|
-
For
|
|
125
|
+
For demo videos, check out our homepage: https://www.borgbackup.org/#demo
|
|
132
126
|
|
|
133
127
|
Helping, donations and bounties, becoming a Patron
|
|
134
128
|
--------------------------------------------------
|
|
@@ -139,16 +133,15 @@ Spread the word, give feedback, help with documentation, testing or development.
|
|
|
139
133
|
|
|
140
134
|
You can also give monetary support to the project, see there for details:
|
|
141
135
|
|
|
142
|
-
https://www.borgbackup.org
|
|
136
|
+
https://www.borgbackup.org/#fund
|
|
143
137
|
|
|
144
138
|
Links
|
|
145
139
|
-----
|
|
146
140
|
|
|
147
|
-
* `Main website <https://borgbackup.
|
|
141
|
+
* `Main website <https://www.borgbackup.org/>`_
|
|
148
142
|
* `Releases <https://github.com/borgbackup/borg/releases>`_,
|
|
149
143
|
`PyPI packages <https://pypi.python.org/pypi/borgbackup>`_ and
|
|
150
144
|
`Changelog <https://github.com/borgbackup/borg/blob/master/docs/changes.rst>`_
|
|
151
|
-
* `Offline documentation <https://readthedocs.org/projects/borgbackup/downloads>`_
|
|
152
145
|
* `GitHub <https://github.com/borgbackup/borg>`_ and
|
|
153
146
|
`Issue tracker <https://github.com/borgbackup/borg/issues>`_.
|
|
154
147
|
* `Web chat (IRC) <https://web.libera.chat/#borgbackup>`_ and
|
|
@@ -177,7 +170,7 @@ see ``docs/support.rst`` in the source distribution).
|
|
|
177
170
|
:alt: Documentation
|
|
178
171
|
:target: https://borgbackup.readthedocs.io/en/stable/
|
|
179
172
|
|
|
180
|
-
.. |build| image:: https://github.com/borgbackup/borg/workflows/
|
|
173
|
+
.. |build| image:: https://github.com/borgbackup/borg/actions/workflows/ci.yml/badge.svg?branch=1.4-maint
|
|
181
174
|
:alt: Build Status (1.4-maint)
|
|
182
175
|
:target: https://github.com/borgbackup/borg/actions
|
|
183
176
|
|
|
@@ -185,15 +178,6 @@ see ``docs/support.rst`` in the source distribution).
|
|
|
185
178
|
:alt: Test Coverage
|
|
186
179
|
:target: https://codecov.io/github/borgbackup/borg?branch=1.4-maint
|
|
187
180
|
|
|
188
|
-
.. |screencast_basic| image:: https://asciinema.org/a/133292.png
|
|
189
|
-
:alt: BorgBackup Basic Usage
|
|
190
|
-
:target: https://asciinema.org/a/133292?autoplay=1&speed=1
|
|
191
|
-
:width: 100%
|
|
192
|
-
|
|
193
|
-
.. _installation: https://asciinema.org/a/133291?autoplay=1&speed=1
|
|
194
|
-
|
|
195
|
-
.. _advanced usage: https://asciinema.org/a/133293?autoplay=1&speed=1
|
|
196
|
-
|
|
197
181
|
.. |bestpractices| image:: https://bestpractices.coreinfrastructure.org/projects/271/badge
|
|
198
182
|
:alt: Best Practices Score
|
|
199
183
|
:target: https://bestpractices.coreinfrastructure.org/projects/271
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<p class="borg-downloads" id="borg-downloads" style="display:none;">Downloads: <span id="borg-downloads-list"></span></p>
|
|
2
|
+
<script type="text/javascript">
|
|
3
|
+
// Populate offline download links (PDF, HTMLzip, ...) on a single line using ReadTheDocs data if available.
|
|
4
|
+
function borgInitDownloads(data) {
|
|
5
|
+
var downloads = data && data.versions && data.versions.current && data.versions.current.downloads;
|
|
6
|
+
if (!downloads) return;
|
|
7
|
+
var labels = {pdf: "PDF", htmlzip: "HTML", epub: "ePub"};
|
|
8
|
+
var span = document.getElementById("borg-downloads-list");
|
|
9
|
+
if (!span) return;
|
|
10
|
+
var first = true;
|
|
11
|
+
Object.keys(downloads).forEach(function(fmt) {
|
|
12
|
+
var url = downloads[fmt];
|
|
13
|
+
if (!url) return;
|
|
14
|
+
if (!first) span.appendChild(document.createTextNode(" | "));
|
|
15
|
+
var a = document.createElement("a");
|
|
16
|
+
a.href = url;
|
|
17
|
+
a.textContent = labels[fmt] || fmt;
|
|
18
|
+
span.appendChild(a);
|
|
19
|
+
first = false;
|
|
20
|
+
});
|
|
21
|
+
if (!first) document.getElementById("borg-downloads").style.display = "";
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
document.addEventListener("readthedocs-addons-data-ready", function(event) {
|
|
25
|
+
borgInitDownloads(event.detail.data());
|
|
26
|
+
});
|
|
27
|
+
</script>
|
|
@@ -56,7 +56,7 @@ To check the GPG signature, download both the file and the corresponding
|
|
|
56
56
|
signature (*.asc file) and then (on the shell) type, for example:
|
|
57
57
|
|
|
58
58
|
gpg --recv-keys 9F88FB52FAF7B393
|
|
59
|
-
gpg --verify
|
|
59
|
+
gpg --verify borg-linux64.asc borg-linux64
|
|
60
60
|
|
|
61
61
|
The files are signed by:
|
|
62
62
|
|
|
@@ -83,6 +83,15 @@ Practical example (Linux, 1.4.3 tag):
|
|
|
83
83
|
If verification succeeds, gh prints a summary stating the subject (your file),
|
|
84
84
|
that it was attested by GitHub Actions, and the job/workflow reference.
|
|
85
85
|
|
|
86
|
+
The source distribution (borgbackup-X.Y.Z.tar.gz, also on PyPI) is built on
|
|
87
|
+
GitHub, too, and has a provenance attestation that is verified the same way:
|
|
88
|
+
|
|
89
|
+
gh attestation verify --repo borgbackup/borg --source-ref refs/tags/X.Y.Z borgbackup-X.Y.Z.tar.gz
|
|
90
|
+
|
|
91
|
+
Its sigstore bundle is attached to the GitHub release as
|
|
92
|
+
borgbackup-X.Y.Z.tar.gz.sigstore.jsonl, so it can also be verified offline
|
|
93
|
+
(gh attestation verify --bundle) or with other sigstore tooling.
|
|
94
|
+
|
|
86
95
|
|
|
87
96
|
Installing
|
|
88
97
|
----------
|
|
@@ -236,3 +236,17 @@ readthedocs-flyout {
|
|
|
236
236
|
.sphinxsidebar > .sidebar-block:has(#main-search):after {
|
|
237
237
|
margin: 7px 22px 0 22px;
|
|
238
238
|
}
|
|
239
|
+
/* Downloads line in the sidebar: a single line, left-aligned with the boxes
|
|
240
|
+
above it and the table of contents below it. */
|
|
241
|
+
.borg-downloads {
|
|
242
|
+
padding: 0 22px;
|
|
243
|
+
margin: 7px 0 7px 0;
|
|
244
|
+
font-size: 14px;
|
|
245
|
+
color: #000;
|
|
246
|
+
}
|
|
247
|
+
.borg-downloads:after {
|
|
248
|
+
content: '';
|
|
249
|
+
display: block;
|
|
250
|
+
border-top: 1px solid #ccc;
|
|
251
|
+
margin: 7px 0 0 0;
|
|
252
|
+
}
|