Thomas Waldmann
78c7aabbb6
docs: fix usage docs and references for repo-* commands
2024-09-08 18:06:26 +02:00
Thomas Waldmann
04dfadbbd6
cli: rename r* commands to repo-*
...
also:
- adapt tests
- adapt BuildMan manpage generation
- adapt help strings / doc strings
- docs
2024-09-08 18:06:24 +02:00
Thomas Waldmann
b50ed04ffc
build_usage / build_man
2024-09-08 12:02:17 +02:00
Thomas Waldmann
7442cbf8cf
update CHANGES
2024-09-08 12:01:10 +02:00
Thomas Waldmann
ace97fadec
docs: updates / removing outdated stuff
2024-09-08 12:00:50 +02:00
Thomas Waldmann
3408e942de
add sftp: / borgstore to quickstart docs
2024-09-07 22:01:18 +02:00
Thomas Waldmann
22b68b0199
add sftp: to repository url format docs
2024-09-07 22:01:16 +02:00
Thomas Waldmann
5e3f2c04d5
remove archive checkpointing
...
borg1 needed this due to its transactional / rollback behaviour:
if there was uncommitted stuff in the repo, next repo opening automatically
rolled back to last commit. thus we needed checkpoint archives to reference
chunks and commit the repo.
borg2 does not do that anymore, unused chunks are only removed when the
user invokes borg compact.
thus, if a borg create gets interrupted, the user can just run borg create
again and it will find some chunks are already in the repo, making progress
even if borg create gets frequently interrupted.
2024-09-07 22:00:54 +02:00
Thomas Waldmann
c2890efdd1
docs: update the repository filesystem docs
...
In the end, it will all depend on the borgstore backend that will be used,
so we better point to the borgstore project for details.
2024-09-07 22:00:52 +02:00
Thomas Waldmann
d6a70f48f2
remove LocalCache
...
Note: this is the default cache implementation in borg 1.x,
it worked well, but there were some issues:
- if the local chunks cache got out of sync with the repository,
it needed an expensive rebuild from the infos in all archives.
- to optimize that, a local chunks.archive.d cache was used to
speed that up, but at the price of quite significant space needs.
AdhocCacheWithFiles replaced this with a non-persistent chunks cache,
requesting all chunkids from the repository to initialize a simplified
non-persistent chunks index, that does not do real refcounting and also
initially does not have size information for pre-existing chunks.
We want to move away from precise refcounting, LocalCache needs to die.
2024-09-07 22:00:31 +02:00
Ruben Rodriguez
6978584de6
docs: align /etc/backups path in all references
2024-08-01 15:31:38 +02:00
Dominik Tugend
e715b9f5af
Add TIMESPAN to doc
...
- Closes borgbackup/borg#8310
2024-07-30 23:49:50 +02:00
Thomas Waldmann
edfca29b97
build_usage / build_man
2024-07-19 20:40:15 +02:00
Thomas Waldmann
6778f2976a
update CHANGES
2024-07-19 20:39:32 +02:00
Thomas Waldmann
6211a3dc79
key export: move examples to docs
2024-07-19 19:44:38 +02:00
Thomas Waldmann
ecddbc6691
make BORG_EXIT_CODES="modern" the default.
2024-07-19 17:31:36 +02:00
Thomas Waldmann
044acfd5dd
add docs/binaries/00_README.txt
...
I usually just uploaded that into the GH release assets,
but let's also have it in git.
2024-07-19 14:43:30 +02:00
Thomas Waldmann
b1249ebe20
update CHANGES
2024-07-18 23:52:39 +02:00
Thomas Waldmann
619a06a5ba
BORG_CACHE_IMPL defaults to "adhocwithfiles" now
...
Also: support a "cli" env var value, that does not determine
the implementation from the env var, but rather from cli options (similar to as it was before adding BORG_CACHE_IMPL).
2024-07-18 22:51:17 +02:00
Thomas Waldmann
5a500cddf8
rename NewCache -> AdHocWithFilesCache
2024-07-18 22:14:00 +02:00
Thomas Waldmann
616af8daa8
BORG_CACHE_IMPL environment variable added
...
BORG_CACHE_IMPL allows users to choose the client-side cache implementation from 'local', 'newcache' and 'adhoc'.
2024-07-15 12:45:16 +02:00
William Bonnaventure
de5d130dda
Update docs for BORG_USE_CHUNKS_ARCHIVE
2024-07-13 21:26:18 +02:00
Cthulhux
a0f23f97e1
Update installation.rst
...
Moved..
2024-06-07 03:40:17 +02:00
Cthulhux
de21d79e3d
Fixed openSUSE dependencies in installation.rst
...
Tested with today's Tumbleweed
2024-06-06 22:32:41 +02:00
tree-wall
7bc6f90dd3
Installation: update Arch Linux repo name
...
The "community" repository was merged into the "extra" repo last year.
https://archlinux.org/news/git-migration-completed/
2024-06-02 19:21:48 +01:00
Thomas Waldmann
9fbc4bc4e7
recreate: remove experimental status
...
We have this since quite a while and there were no major complaints.
2024-05-29 16:42:58 +02:00
Thomas Waldmann
670cb6eb3f
github CI: misc updates
...
- macOS: run on macos-14 (on Apple Silicon!)
- macOS: use OpenSSL 3.0 from brew
- macOS: run with Python 3.11
- pip install -e .: add -v
- use up-to-date github actions
- remove libb2 references - since borg 1.2, we use blake2 indirectly via python stdlib
2024-03-15 18:19:15 +01:00
Thomas Waldmann
6121d3d2e6
docs: remove tabs
2024-02-25 12:14:52 +01:00
Stephan Herbers
274cd8f121
add restore considerations paragraph
2024-02-24 21:17:22 +01:00
Stephan Herbers
96ae9f73eb
Apply suggestions from code review
...
Co-authored-by: NetSysFire <59517351+NetSysFire@users.noreply.github.com>
2024-02-24 21:17:09 +01:00
Stephan Herbers
a06c42cf1f
add non-root deployment strategy
2024-02-24 21:17:01 +01:00
Thomas Waldmann
b69c937cb7
build_man
2024-02-20 17:12:43 +01:00
Thomas Waldmann
3160f5063a
build_usage
2024-02-20 17:11:43 +01:00
Thomas Waldmann
0612001aa3
update release date in changes.rst
2024-02-20 17:06:53 +01:00
Thomas Waldmann
9524c20b47
update CHANGES
2024-02-20 16:29:14 +01:00
Thomas Waldmann
e7bd18d7f3
create: add the slashdot hack, fixes #4685
2024-02-20 04:08:09 +01:00
Thomas Waldmann
43a20b052e
add ConnectionBrokenWithHint for BrokenPipeErrors and similar, see #7016
...
no traceback, but error message and specific exit code.
2024-02-20 00:17:55 +01:00
Thomas Waldmann
45815554ce
check_can_create_repository: deal with PermissionErrors, see #7016
...
borg init calls this. If there is a PermissionError, it is
usually fs permission issue at path or its parent directory.
Don't give a traceback, but rather an error msg and a specific exit code.
2024-02-20 00:07:43 +01:00
Thomas Waldmann
83c069ce5a
better error msg for corrupted key data, fixes #8016
2024-02-19 19:23:48 +01:00
Thomas Waldmann
5caf747011
update frontends.rst error/warning list
2024-02-15 18:17:18 +01:00
Thomas Waldmann
97dd287584
raise BackupOSError subclasses
2024-02-15 17:53:53 +01:00
Thomas Waldmann
9ac4672254
add NotFoundWarning
2024-02-15 17:04:21 +01:00
Thomas Waldmann
5168a97782
extend errorlist script to warnings, update docs
2024-02-14 02:04:44 +01:00
Thomas Waldmann
c704e5ea9e
new warnings infrastructure to support modern exit codes
...
- implement updating exit code based on severity, including modern codes
- extend print_warning with kwargs wc (warning code) and wt (warning type)
- update a global warnings_list with warning_info elements
- create a class hierarchy below BorgWarning class similar to Error class
- diff: change harmless warnings about speed to rc == 0
- delete --force --force: change harmless warnings to rc == 0
Also:
- have BackupRaceConditionError as a more precise subclass of BackupError
2024-02-14 01:26:12 +01:00
Thomas Waldmann
b18e613627
get rid of some rare error classes, use RTError instead
2024-02-13 23:44:02 +01:00
Thomas Waldmann
9de07ebd46
update "modern" error RCs (docs and code)
2024-02-13 22:58:02 +01:00
Thomas Waldmann
3a85433ffb
update CHANGES
2024-02-13 18:20:10 +01:00
Thomas Waldmann
4d424de69e
scripts: update docs about make.py
2024-02-09 17:37:44 +01:00
Thomas Waldmann
48afc4c519
requirements are defined in pyproject.toml
2024-02-09 17:37:42 +01:00
Thomas Waldmann
38ba1c383a
docs: do not refer to setup.py installation method
...
Invoking setup.py is deprecated.
2024-02-09 17:37:40 +01:00
Thomas Waldmann
b64f6e3335
scripts/gendocs.py: make it work
...
remove unused html_write function
gendocs: update developer docs
2024-02-09 17:37:38 +01:00
Thomas Waldmann
33393946b5
docs: how to run the testsuite using the dist package
2024-02-09 00:36:58 +01:00
Thomas Waldmann
25adac4fb4
update CHANGES
2024-02-08 23:28:22 +01:00
Thomas Waldmann
576ee3532c
docs: fix markup errors
2024-01-14 17:27:21 +01:00
Stephen
438f1ddef7
docs: add brew bundle instructions (macOS)
2024-01-14 17:14:42 +01:00
ebabcock93
73a416830a
docs: add typical PR workflow to development docs, fixes #7495 ( #7656 )
2024-01-10 00:56:18 +01:00
TW
812eb352f6
Merge pull request #7955 from ThomasWaldmann/improve-session-key-gen-master
...
crypto: use a one-step kdf for session keys, fixes #7953
2024-01-04 18:42:22 +01:00
AJ Jordan
f3ae0467b5
Fix typo
2023-12-17 01:13:43 -05:00
Thomas Waldmann
74c34ba7c6
docs: update security docs about new one-step KDF
2023-12-02 20:35:16 +01:00
Thomas Waldmann
0f074fa2b6
add 1.2.7 changes
2023-12-02 18:01:00 +01:00
Thomas Waldmann
fe17ce2bba
fix typos
...
Thanks go to:
Author: Andrea Gelmini <andrea.gelmini@gelma.net>
2023-12-01 21:58:26 +01:00
Kevin Yin
4f92f9462e
Port changes to master
2023-11-23 07:48:26 -08:00
zDEFz
c4decb4fff
make SERIAL backup method compatible to borg2
2023-11-13 20:23:52 +01:00
zDEFz
6bbd327dc2
Added backup by serial method documentation ( #7932 )
...
docs: create disk/partition sector backup by disk serial number
2023-11-13 13:45:19 +01:00
Sophie Herold
cdc6154200
docs: Add "check.rebuild_refcounts" message
2023-11-09 21:32:01 +01:00
Thomas Waldmann
62114466e4
CVE-2023-36811 upgrade docs: consider checkpoint archives, fixes #7802
...
The traceback seen there came from borg not showing a .checkpoint archive
that didn't have a valid TAM and thus the user not see it / fix it:
https://github.com/borgbackup/borg/issues/7802#issuecomment-1793860606
2023-11-06 14:34:15 +01:00
Thomas Waldmann
613fdcd6fa
copy 1.2.x changelog notes from 1.2-maint
2023-11-05 17:48:30 +01:00
Thomas Waldmann
8f7f836eff
copy 1.x upgrade notes from 1.2-maint
2023-11-05 17:46:14 +01:00
Thomas Waldmann
774c899b7e
update 1.x change log, cve notes
...
fixes #7816
fixes #7813
2023-11-05 17:43:24 +01:00
Thomas Waldmann
4325656f4c
docs: not only attack/unsafe, can also be a fs issue, fixes #7853
2023-11-05 17:36:31 +01:00
Łukasz Stelmach
c68a158ffb
linux: use pkgconfig to find libacl
...
Using pkgconfig gives a more meaningful error message in case libacl
development files are missing.
2023-10-24 15:00:21 +02:00
Marc Kohaupt
a6b016f894
feat(docs): use virtualenv on Cygwin
...
Hint for Cygwin users to make sure they use a virtual environment.
Not using a virtual environment will be likely troublesome if there is already a Python installed on Windows.
2023-10-09 12:35:33 +02:00
Thomas Waldmann
bd1d734591
docs: removed TAMs, introduce typed repo objects
2023-09-24 20:11:00 +02:00
Thomas Waldmann
3f75950226
build_usage / build_man
2023-09-14 15:52:08 +02:00
Thomas Waldmann
7e15b6488a
update CHANGES
2023-09-14 15:48:18 +02:00
Thomas Waldmann
c883181609
update CHANGES
...
also:: add a note about required TAMs.
2023-09-05 13:50:59 +02:00
Thomas Waldmann
98796a2f0d
replace flake8 by ruff
2023-09-04 22:15:42 +02:00
Thomas Waldmann
aaafc36d97
update upgrade instruction in changes_1.x.rst
2023-09-03 17:27:44 +02:00
Thomas Waldmann
f334ef1b4d
fix CVE timeline, fix markup
2023-08-30 15:58:12 +02:00
Thomas Waldmann
449cd51b73
document vulnerability, repo upgrade procedure
2023-08-30 02:32:50 +02:00
Thomas Waldmann
760d01ee0c
update CHANGES
2023-08-27 20:41:40 +02:00
Thomas Waldmann
e9e74a1113
docs: fix borg delete examples, fixes #7759
2023-08-26 14:51:27 +02:00
Thomas Waldmann
3051473168
BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos without key, fixes #7700
2023-07-20 17:17:28 +02:00
TW
56dfc6dc04
Merge pull request #7567 from azrdev/patch-1
...
automated-local.rst: use GPT UUID for consistent udev rule
2023-07-11 00:06:25 +02:00
Thomas Waldmann
8db8fd601b
docs: OS X -> macOS
2023-07-04 23:59:44 +02:00
Thomas Waldmann
be731334c3
docs: update macOS hint about full disk access
2023-07-04 23:55:06 +02:00
Thomas Waldmann
96c3c90230
docs: remove hint about item_keys in manifest
2023-07-04 23:46:53 +02:00
Thomas Waldmann
ddd93c5828
docs: remove --chunker-params hint to borg < 1.0
2023-07-04 23:41:17 +02:00
Thomas Waldmann
89cfd083ba
docs: minor fixes/update to notes
2023-07-04 23:36:41 +02:00
Thomas Waldmann
84b1ad6948
docs: remove info about borg 1.0 files per dir
2023-07-04 23:32:36 +02:00
Thomas Waldmann
5fb4cc3b4b
docs: no signature upload on pypi any more
...
but we upload it on github releases,
so people can check it.
2023-07-04 20:20:35 +02:00
Thomas Waldmann
15781efab3
docs: CI only on github actions now
2023-07-04 20:11:26 +02:00
Thomas Waldmann
80188d3bdf
remove coala (outdated)
...
last coala release (0.11.0) is now over 6y old.
when using pip install coala, a ton of stuff gets installed (expected)
and a part of that downgrades some stuff we use to outdated, incompatible
versions.
when trying to run coala with python 3.11, it just crashes because the
last release was made for py35/py36 (as seen in their setup.py).
a lot of PRs and tickets pile up at the coala project on github,
but noone is maintaining it.
2023-07-02 17:25:51 +02:00
Thomas Waldmann
e142776040
update CHANGES
2023-07-01 16:42:15 +02:00
Thomas Waldmann
53991f2e51
move upgrade / compat. notes to own section, see #7546
2023-07-01 16:28:17 +02:00
Thomas Waldmann
deed47824f
mount -olocal: how to show mount in finder's sidebar, fixes #5321
2023-07-01 16:07:31 +02:00
Tim Düsterhus
a6f452a050
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
2023-06-30 15:23:07 +02:00
Thomas Waldmann
81c3cb957e
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-29 23:04:21 +02:00
azrdev
27bcc0f05a
automated-local.rst: Partition table UUID match works for MBR too
...
not only GPT
2023-06-16 23:28:36 +02:00
Thomas Waldmann
4dca508848
build_man
2023-06-11 23:10:23 +02:00
