Commit Graph

222 Commits

Author SHA1 Message Date
Thomas Waldmann 37f237d3e0 remove PassphraseKey code and borg key migrate-to-repokey command
"passphrase" encryption mode repos can not be created since borg 1.0.
back then, users were advised to switch existing repos of that type
to repokey mode using the "borg key migrate-to-repokey" command.
that command is still available in borg 1.0, 1.1 and 1.2, but not
any more in borg >= 1.3.

while we still might see the PassphraseKey.TYPE byte in old repos,
it is handled by the RepoKey code since borg 1.0.
2022-03-06 15:26:18 +01:00
Thomas Waldmann 9a8eec6af1 build_usage 2022-02-19 18:47:47 +01:00
Thomas Waldmann b430c8d15a build_usage 2022-02-05 17:52:25 +01:00
Thomas Waldmann 6c517e4c25 docs: FUSE "versions" view is not experimental any more 2022-01-31 21:01:49 +01:00
Thomas Waldmann c643210741 docs: fix tar-related doc structure 2022-01-23 17:16:20 +01:00
Thomas Waldmann 572e996d9a build_usage 2022-01-23 15:52:21 +01:00
Thomas Waldmann 78f0f3518e remove leftovers of BORG_HOSTNAME_IS_UNIQUE from docs
thanks to @snsmac for the hint: there is no code implementing this any more. it was replaced by
BORG_HOST_ID (if needed).
2022-01-20 23:38:43 +01:00
Chen Yufei 7e746e10e7
docs: excluded parent dir's metadata can't restore. (#6062)
docs: if parent dir is not extracted, we do not have its metadata
2022-01-20 02:04:15 +01:00
Reiko Asakura e38f0b26b0
Workaround for volume shadow copy in WSL1 2021-12-24 15:15:23 -05:00
TW 03ab4dc116
Merge pull request #6085 from hexagonrecursion/fix-build-man
Fix exceptions thrown by `setup.py build_man`
2021-12-10 18:15:20 +01:00
Andrey Bienkowski dbfef31783
borg serve: improve ssh forced commands docs (#6083)
borg serve: improve ssh forced commands docs

Co-authored-by: Andrey Bienkowski <hexagon-recursion@posteo.net>
2021-12-10 18:11:25 +01:00
Andrey Bienkowski 37e1ae4735 Fix exceptions thrown by `setup.py build_man`
While doing some doc updates I needed a way to test them - to build
the documentation and inspect the output. I ran into an issue:
running python setup.py build_man was throwing exceptions:

1. The import-tar parser had a None description causing:

    File "/home/user/borg/setup_docs.py", line 451, in write_heading
      write(char * len(header))
    TypeError: object of type 'NoneType' has no len()

2. There was no docs/usage/import-tar.rst causing an exception too
2021-12-10 10:51:26 +03:00
remyabel e25095364b
docs: clarify pattern usage with commands (#5959)
docs: clarify pattern usage with commands, fixes #5176
2021-08-21 16:02:11 +02:00
Tommy Nguyen 7639465ad4
docs: clarify pp pattern type
Fixes: #5300

This incorporates the comments from `patterns.py` into the documentation
to clarify the difference between `pp` and `pf`.
2021-08-07 07:38:04 -04:00
TW e6811748b1 Merge pull request #5873 from ThomasWaldmann/disable-selftest-1.1
implement BORG_SELFTEST env variable, fixes #5871
2021-07-03 12:31:13 +02:00
James Buren 4f9e30e980 resolve clarify borg check --verify-data (#5808) 2021-06-18 15:00:14 -05:00
James Buren 8394ae6932 add notice about defective hardware to check documentation (#5753) 2021-06-18 01:26:57 -05:00
Thomas Waldmann a99ae950c9 build_usage 2021-05-11 22:33:55 +02:00
Robert Blenis b2dea4422e add --json-lines option to diff command 2021-03-13 11:50:55 -05:00
Thomas Waldmann e48289e8b7 build_usage 2021-02-06 01:32:02 +01:00
Ryan Polley 83116e58f2
add examples for --paths-from-stdin, --paths-from-command, --paths-separator (#5644)
docs: add examples for --paths-from-stdin, --paths-from-command, --paths-separator
2021-01-27 00:15:14 +01:00
Thomas Waldmann 0984e00d31 revert changes to autogenerated files
this stuff will be auto-generated, regularly done at release time.
2021-01-07 18:08:49 +01:00
Andrea Gelmini 72e7c46fa7 Fix typos 2021-01-07 17:54:33 +01:00
axapaxa b291b91962
Add remote upload buffer (--remote-buffer) (#5574)
add remote upload buffer (--remote-buffer)

- added new option --remote-buffer
- allow to_send to grow to selected size
- don't grow if wait is specified
- fill pipe on any command (including 'async_response')
- add new option to docs
- create EfficientBytesQueue to prevent recreation of buffer each time we send something
- add tests for EfficientBytesQueue
2021-01-03 17:37:16 +01:00
Thomas Waldmann b8bb0494f6 create --sparse, file map support for the "fixed" chunker, see #14
a file map can be:

- created internally inside chunkify by calling sparsemap, which uses
  SEEK_DATA / SEEK_HOLE to determine data and hole ranges inside a
  seekable sparse file.
  Usage: borg create --sparse --chunker-params=fixed,BLOCKSIZE ...
  BLOCKSIZE is the chunker blocksize here, not the filesystem blocksize!

- made by some other means and given to the chunkify function.
  this is not used yet, but in future this could be used to only read
  the changed parts and seek over the (known) unchanged parts of a file.

sparsemap: the generate range sizes are multiples of the fs block size.
           the tests assume 4kiB fs block size.
2020-12-27 22:06:08 +01:00
Thomas Waldmann f75c561e07 docs: add another case of attempted hardlink usage 2020-12-26 00:04:24 +01:00
Thomas Waldmann 3a828bea0b docs: fix description of borg upgrade hardlink usage, fixes #5518 2020-12-26 00:03:34 +01:00
Robin Schneider fb38ba579f
Use HTTPS everywhere (mechanical edit using util from https-everywhere)
Ref: https://github.com/EFForg/https-everywhere/tree/master/utils/rewriter

```Shell
~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js .
```

A few changes were reset/fixed manually before the commit.
2020-12-22 16:36:40 +01:00
Nehalenniæ Oudin 5017bc4d04
Add a --list switch to borg delete (#5503)
add a --list switch to borg delete, fixes #5116
2020-12-11 19:11:47 +01:00
Thomas Waldmann 4f7aa1a92f build usage 2020-12-06 20:44:59 +01:00
TW ac77dd491d
Merge pull request #5433 from luke-jr/files_cache_suffix
Allow appending the files cache filename with BORG_FILES_CACHE_SUFFIX env var
2020-11-16 18:51:40 +01:00
Luke Dashjr 561fbb748c docs: Document BORG_FILES_CACHE_SUFFIX environment variable 2020-11-15 17:01:36 +00:00
TW b05182260c
Merge pull request #5430 from ThomasWaldmann/pyfuse3
add pyfuse3 as an alternative lowlevel fuse implementation
2020-11-02 22:51:17 +01:00
Thomas Waldmann 49b1421682 FUSE: support pyfuse3 additionally to llfuse, fixes #5407
FUSE implementation can be switched via env var BORG_FUSE_IMPL.
2020-10-31 22:04:44 +01:00
Mher Kazandjian 5bcb52db77
add example for excluding content using the --pattern cmd line arg (#5456)
add example for excluding content using the --pattern command line argument
2020-10-28 23:32:40 +01:00
Thomas Waldmann ab31dc476e build_usage 2020-10-04 20:32:38 +02:00
Thomas Waldmann 8d1ae6f0f7 Revert "add double force"
This reverts commit 6fac203d86.

Fix was applied to an autogenerated file,
it needs to be applied to the builtin help of the borg code.
2020-09-27 23:46:45 +02:00
Alex Vorona 6fac203d86 add double force 2020-08-25 21:27:18 +03:00
TW 303c11f245
rephrase some warnings, fixes #5164 (#5241)
rephrase some warnings, fixes #5164

borg check --repair and borg recreate are now present in the code since rather long, so they are not experimental any more.

borg recreate might be used wrongly (e.g. accidentally excluding everything / not matching anything when recreating an archive). added some warning words in the docs, but it will not ask for confirmation any more.

borg check: there might be kinds of corruption borg check --repair can not fix and it might make things even worse while trying to fix. so this will still ask for confirmation, just with different wording.
2020-07-10 19:26:18 +02:00
Thomas Portmann dfc5e915cc
Fixed locking, issue #4923 (#4928)
locking: fix ExclusiveLock race condition bug, fixes #4923

- ExclusiveLock is now based on os.rename instead of os.mkdir.
- catch FileNotFoundError observed under race condition in ExclusiveLock.release()
  and .kill_stale_lock()
- added TestExclusiveLock.test_race_condition() which reveals issue #4923
- updated docs
- locking: use "raise LockTimeout from None" for prettier traceback

Co-authored-by: Thomas Portmann <thomas@portmann.org>
Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2020-07-03 10:09:32 +02:00
TW 7033d5054f
Merge pull request #5226 from ThomasWaldmann/server-enforces-umask
--umask is for the local borg process only, fixes #4947
2020-06-28 14:58:41 +02:00
Thomas Waldmann c531901763 --umask is for the local borg process only, fixes #4947
The umask value is NOT transmitted from client to server any more,
so the borg client can not influence the borg server umask any more.

If one wants to have a specific umask on the server side, one needs to
use a ssh forced command in .ssh/authorized_keys file.

OTOH, as the default value is 077 (in general, for client as well as for
the server) and the server does not take the value from the client any more,
there usually should be no need to give it on the server side, IF you are
happy with the default value.
2020-06-14 18:35:03 +02:00
Matthew Glazar 5a32de918e allow key-import+BORG_KEY_FILE to create key files
Running 'borg key import' on a keyfile repository with the BORG_KEY_FILE
environment variable set works correctly if the BORG_KEY_FILE file
already exists. However, the command crashes if the BORG_KEY_FILE file
does not exist:

    $ BORG_KEY_FILE=newborgkey borg key import /home/strager/borg-backups/straglum borgkey
    Local Exception
    Traceback (most recent call last):
      [snip]
      File "[snip]/borg/crypto/key.py", line 713, in sanity_check
        with open(filename, 'rb') as fd:
    FileNotFoundError: [Errno 2] No such file or directory: '[snip]/newborgkey'

    Platform: Linux straglum 5.0.0-25-generic #26~18.04.1-Ubuntu SMP Thu Aug 1 13:51:02 UTC 2019 x86_64
    Linux: debian buster/sid
    Borg: 1.1.11  Python: CPython 3.7.7 msgpack: 0.5.6
    PID: 15306  CWD: /home/strager/Projects/borg
    sys.argv: ['[snip]/borg', 'key', 'import', '/home/strager/borg-backups/straglum', 'borgkey']
    SSH_ORIGINAL_COMMAND: None

Make 'borg key import' not require the BORG_KEY_FILE file to already
exist.

This commit does not change the behavior of 'borg key import' without
BORG_KEY_FILE. This commit also does not change the behavior of 'borg
key import' on a repokey repository.
2020-06-04 19:29:15 -07:00
Thomas Waldmann 17220e09ab build_usage 2020-04-21 22:56:55 +02:00
Thomas Waldmann b5d6e23d84 docs: clarify borg init's encryption modes 2020-04-16 21:35:33 +02:00
Thomas Waldmann 56c599e6dc build_usage 2020-04-12 19:51:49 +02:00
TW c867ebfeb6
Merge pull request #5048 from finefoot/patch-8
Option to bypass locking to use sensible borg commands with read-only repositories
2020-04-11 22:18:37 +02:00
finefoot e49a17143d Add option to bypass locking mechanism 2020-04-11 17:04:52 +02:00
Thomas Waldmann 888949c641 Improve description of path variables
Original commit by @finefoot, re-applied due to merge conflict.
2020-04-01 18:54:45 +02:00
Thalian 08a7661e67 [FEATURE] #4489 – Deprecate --nobsdflags option
Replaced by --noflags. In internal data structure the key 'bsdflags' is kept for backwards compatibility.
2020-03-25 06:35:15 +01:00