Commit graph

1835 commits

Author SHA1 Message Date
Martin Richtarsky
b913d9dd1a docs/FAQ: Clean up entries regarding SSH settings
Link to recommended ones
2024-11-01 07:43:47 +01:00
Thomas Waldmann
66e17ff6c8
build_usage, build_man 2024-10-31 20:50:06 +01:00
Thomas Waldmann
63c74ca313
update CHANGES 2024-10-31 20:45:33 +01:00
Martin Richtarsky
f656f6b1f2 docs: Small changes regarding compression
- Mention zstd as the best general choice when not using lz4
  (as often acknowledged by public benchmarks)
- Mention 'auto' more prominently as a good heuristic to improve
  speed while retaining good compression
- Link to compression options
2024-10-25 07:44:26 +02:00
Martin Richtarsky
411f6f3222 docs: Remove --bypass-lock 2024-10-22 08:44:56 +02:00
Thomas Waldmann
b6eb5b239f
update CHANGES 2024-10-19 03:49:28 +02:00
Thomas Waldmann
6adf18d97c
update URL docs 2024-10-14 23:30:12 +02:00
TW
ee386d0bef
Merge pull request #8459 from ThomasWaldmann/prune-quarterly-master
Add quarterly pruning strategy.
2024-10-06 12:12:13 +02:00
William D. Jones
d54eefd9f4
Add quarterly pruning strategy. (#8337)
Add 13weekly and 3monthly quarterly pruning strategies.
2024-10-05 16:02:14 +02:00
Thomas Waldmann
b69edd4ae1
docs: borg/borgfs detects internally under which name it was invoked, fixes #8207 2024-10-05 14:23:21 +02:00
Thomas Waldmann
414f18a354
docs: better link modern return codes, fixes #8370 2024-10-05 14:12:53 +02:00
Thomas Waldmann
4bdb3c30f9
binary: using the directory build is faster, fixes #8008 2024-10-05 14:01:58 +02:00
Thomas Waldmann
a793d44f5b
update (c) year 2024-10-05 13:53:16 +02:00
Thomas Waldmann
090ee523ad
docs: update "Running the tests (using the pypi package)", fixes #6386 2024-10-04 19:04:43 +02:00
Thomas Waldmann
4b7ab4f087
build_usage / build_man 2024-10-03 12:30:58 +02:00
Thomas Waldmann
cb691417ac
update CHANGES 2024-10-03 12:30:56 +02:00
Thomas Waldmann
e274860983
tag: set, add, remove tags 2024-10-02 23:52:39 +02:00
Thomas Waldmann
ecd0cd07e2
docs: fix typo 2024-10-02 17:28:21 +02:00
Thomas Waldmann
940ec7b455
docs: point to rclone docs 2024-10-02 17:27:42 +02:00
Thomas Waldmann
de439ee839
analyze: sum up changed chunks per parent directory 2024-10-02 16:14:44 +02:00
TW
9c9a75bdf9
Merge pull request #8421 from ThomasWaldmann/rel200b11
Release 2.0.0 beta11
2024-09-26 20:06:30 +02:00
Thomas Waldmann
9b3a0023c3
repo-list: add hostname/username/comment to default format, reorder, adjust
borg 1.x encouraged users to put everything into the archive name:
- name of the dataset
- timestamp (usually used to make the archive name unique)
- maybe also hostname (when backing up to same repo from multiple hosts)
- maybe also username (when backing up to same repo from multiple users)

borg2 now discourages users from putting the timestamp into the name,
because we rather want same name within a series of archives - thus,
the field width for the name can be narrower.

the ID of the archive is now the only unique identifier, thus it is
moved to the leftmost place.
256bits (64 hex digits) was a bit much and as borg can also deal with
abbreviated IDs, we only show 32bits (8 hex digits) by default.

the ID is followed by the timestamp (also quite "interesting", because
it usually differs for different archives).

then following are: archive name, user name, host name - these might be
always the same if there is only one series of archives in a repo.

use 2 blanks separating the fields for better readability.
2024-09-26 15:53:36 +02:00
Thomas Waldmann
fb496bf1b7
build_usage build_man 2024-09-26 07:57:01 +02:00
Thomas Waldmann
439024cba6
update CHANGES 2024-09-26 07:54:38 +02:00
Thomas Waldmann
628990d32c
fix markup error in change log 2024-09-25 23:53:15 +02:00
Thomas Waldmann
328cd22a13
update CHANGES 2024-09-25 23:25:34 +02:00
Helmut Grohne
70f173caa7 FAQ: Why is backing up an unmodified FAT filesystem slow on Linux? 2024-09-23 10:36:56 +02:00
Thomas Waldmann
bd6caf835d
add support for rclone:// repositories (via borgstore) 2024-09-22 22:26:07 +02:00
Thomas Waldmann
a891559578
files cache improvements, fixes #8385, fixes #5658
- changes to locally stored files cache:

  - store as files.<H(archive_name)>
  - user can manually control suffix via env var
  - if local files cache is not found, build from previous archive.
- enable rebuilding the files cache via loading the previous
  archive's metadata from the repo (better than starting with
  empty files cache and needing to read/chunk/hash all files).
  previous archive == same archive name, latest timestamp in repo.
- remove AdHocCache (not needed any more, slow)
- remove BORG_CACHE_IMPL, we only have one
- remove cache lock (this was blocking parallel backups to same
  repo from same machine/user).

Cache entries now have ctime AND mtime.

Note: TTL and age still needed for discarding removed files.
      But due to the separate files caches per series, the TTL
      was lowered to 2 (from 20).
2024-09-20 00:40:49 +02:00
Thomas Waldmann
4c1a0b1ca0
msys2: disable SETUPTOOLS_USE_DISTUTILS=stdlib hack
The msys2 changelog says it is only needed for setuptools < 70.2.0:

https://www.msys2.org/docs/python/#known-issues

https://setuptools.pypa.io/en/stable/history.html#v70-2-0
2024-09-19 12:36:18 +02:00
Thomas Waldmann
1bc5902718
docs: update about archive series
in borg 1.x, we used to put a timestamp into the archive name to make
it unique, because borg1 required that.

borg2 does not require unique archive names, but it encourages you
to even use an identical archive name within the same SERIES of archives.
that makes matching (e.g. for prune, but also at other places) much
simpler and borg KNOWS which archives belong to the same series.
2024-09-18 14:05:12 +02:00
Thomas Waldmann
82a1d38bcc
docs: user@ and :port are optional in sftp and ssh URLs 2024-09-17 10:01:33 +02:00
Eddie Carswell
9fe3cb686f
Update repository URLs in docs to use new syntax
Fixes #8361

Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
2024-09-11 22:03:59 -05:00
Thomas Waldmann
bb31b42310
build_usage build_man 2024-09-09 16:58:06 +02:00
Thomas Waldmann
58fe5ad02a
update CHANGES 2024-09-09 16:51:12 +02:00
Thomas Waldmann
3ff33684c6
remove "borg config" docs
the config command was already removed before.
2024-09-09 13:42:31 +02:00
Thomas Waldmann
cfd35b4bd6
update CHANGES 2024-09-09 11:22:38 +02:00
Thomas Waldmann
7f1fc0cf63
docs: build_man 2024-09-08 18:11:44 +02:00
Thomas Waldmann
ecb838d5e7
src: fix man page names 2024-09-08 18:11:41 +02:00
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