Commit Graph

1456 Commits

Author SHA1 Message Date
Thomas Waldmann 5b60761bd7 update CHANGES 2022-01-23 15:39:40 +01:00
Mateusz Konieczny b4f54399d8
minor rewrite to make it less confusing (get rid of "Avoid to create a mixup") (#5490)
docs: permissions note rewritten to make it less confusing

Original wording was confusing "Avoid to create a mixup of users and permissions in your repository (or cache)." is not clear, what should be avoided?

Also implement some feedback of @jdchristensen.

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2022-01-22 20:21:36 +01:00
Thomas Waldmann 35d00ceb2f updated 1.0.x changes up to last one, dissect 1.0.x vs 1.1.x 2022-01-21 14:44:14 +01:00
Thomas Waldmann 5d0446ccf8 updated 1.1.x changes up to 1.1.17 2022-01-21 14:24:12 +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
TW b8419c9859
Merge pull request #6129 from ThomasWaldmann/y2022-master
it's 2022
2022-01-20 02:26:00 +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
Tavlor 2c7253dcbb
clarify who starts the remote agent
It was unclear that the user _only_ needs to have borg installed on a remote system to use client/server mode. Hopefully this change makes it apparent that the user doesn't start anything on the remote system themselves.
2022-01-18 02:07:01 +00:00
Thomas Waldmann 035c175cbb it's 2022 2022-01-16 23:28:18 +01:00
TW 836cb61b4c
Merge pull request #6127 from ThomasWaldmann/update-changes-master
update CHANGES
2022-01-16 23:07:31 +01:00
Thomas Waldmann 549f83a220 update CHANGES 2022-01-16 21:34:24 +01:00
TW 0aabff67f7
Merge pull request #6065 from enkore/patch-2
docs/data-structures: add content-defined chunking explainer
2022-01-16 21:01:09 +01:00
Thomas Waldmann 94e93ba7e6 formula is only approximately correct
the movement of the start of the hashing window stops at (file_size - window_size), thus THAT would be the factor in that formula, not just file_size.

for medium and big files, window_size is much smaller than file_size, so guess we can just say "approximately" for the general case.
2022-01-16 20:39:29 +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
enkore 79cb4e43e5
docs/data-structures: tie CDC back into dedup rationale 2021-11-27 18:45:19 +00:00
enkore 5b297849d3
docs/data-structures: add content-defined chunking explainer 2021-11-27 14:41:24 +00:00
AJ Jordan 284b26f6cc
Fix manifest-timestamp path 2021-10-18 02:54:12 -04:00
ahtaarra 09730833ec
Fix broken link to .nix file
Fix the link to .nix file which has been broken since this change: e570d93519
2021-10-05 06:53:11 +06:00
Thomas Waldmann 59b6dc5442 require python 3.8+, fixes #5975
if you do not have py38+ yet, just use borg 1.1.x.
2021-09-16 02:21:29 +02:00
Jubjub 0393cfac6c
docs: document behavior for filesystems with inconsistent inodes, fixes borgbackup#5770 (#5965) 2021-08-25 21:43:47 +02: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
remyabel 79db0b0815
docs: update referenced freebsd version (#5945)
docs: update referenced freebsd/macOS versions used for binary build

Fixes #5942.
2021-08-05 22:56:02 +02:00
TW 1e7c1414b0 Merge pull request #5902 from ThomasWaldmann/pull-chroot-problematic-1.1
docs: pull mode: add some warnings, fixes #5827
2021-07-11 18:07:14 +02:00
Dmitry Astapov a35c7add95
docs: mention tar --compare (#5880)
docs: mention tar --compare (compare archive to fs files)
2021-07-03 17:10:19 +02: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
remyabel 1c7602f9e0
docs: add info on renaming repositories (#5866)
docs: add info on renaming repositories, fixes #5240
2021-06-23 00:08:49 +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
Philip Kozeny 12c54db4d4
Update changes.rst
fix typo in changes.rst
2021-05-13 12:51:17 +02:00
lyh16 1f8a837303
It's 2021 2021-05-12 21:25:16 +09:00
Thomas Waldmann a99ae950c9 build_usage 2021-05-11 22:33:55 +02:00
Thomas Waldmann f301828241 build_man 2021-05-11 22:33:28 +02:00
Thomas Waldmann e79449157b set release version and date
yet another beta - still too many changes and unmerged
low-level changes, so we cannot go to RCs yet.
2021-05-11 22:28:59 +02:00
Thomas Waldmann 3e4169aade add a Change Log header that appears in TOC 2021-05-11 22:26:30 +02:00
Thomas Waldmann 7ac9e2efef update CHANGES 2021-05-11 22:22:36 +02:00
Thomas Waldmann 852bc7b0d9 update CHANGES 2021-05-01 23:06:48 +02:00
TW a9b1e1fe56
Merge pull request #5773 from ThomasWaldmann/attack-or-unsafe-docs-master
docs: add unsafe workaround to use an old repo copy, fixes #5722
2021-04-19 20:23:27 +02:00
Thomas Waldmann 06c6e7e79c docs: add unsafe workaround to use an old repo copy, fixes #5722 2021-04-19 20:11:37 +02:00
Thomas Waldmann c5ec6e78d2 update CHANGES (master) 2021-04-19 18:34:56 +02:00
Robert Blenis b2dea4422e add --json-lines option to diff command 2021-03-13 11:50:55 -05:00
Manu 2ad2c90d6b Use macFUSE instead of osxfuse 2021-02-18 21:36:14 +08:00
Manu 9d54507e22 Wording update, combine paras. 2021-02-17 22:06:46 +08:00
Manu 2729529ee2 Add note on macFUSE dependency. 2021-02-17 08:44:49 +08:00
Manu 0b5d332a89 Add short note on pointing setup.py to openssl on macOS 2021-02-15 11:54:21 +08:00
Matthew R. Trower 1e01aca301 docs: remove /var/cache exclusion in example commands
This is generally a poor idea and shouldn't be promoted through examples.

Fixes #5625
2021-02-12 14:32:33 -06:00
Manu f8d7b9c232
Recommend download via CLI on macOS (#5682)
docs: recommend download via CLI on macOS

otherwise (browser) one has to remove the quarantine xattr.
2021-02-11 21:31:40 +01:00
Manu 78b94adc06
Update macOS install instructions (#5677)
update macOS install instructions. Fixes #5522, #5622.
2021-02-08 20:09:37 +01:00
Thomas Waldmann ae5c5653a8 build_man 2021-02-06 01:32:54 +01:00
Thomas Waldmann e48289e8b7 build_usage 2021-02-06 01:32:02 +01:00
Thomas Waldmann 6561d7b478 update CHANGES 2021-02-06 01:24:14 +01:00
Thomas Waldmann b1fff5dd39 FAQ: project_name -> Borg
see changeset 8d830d069f where this was
started.
2021-02-06 01:24:14 +01:00
Thomas Waldmann c3df6fcca4 fix docs about blake2 requirements / origin 2021-01-28 18:00:00 +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
TW b20c7229e6
Merge pull request #5642 from rpolley/fix-grammar-in-docs-5632
fix grammar in faq
2021-01-23 01:44:28 +01:00
Ryan Polley 1c5b57f1b3 recomend running tests only on installed versions for setup 2021-01-22 16:21:13 -06:00
Ryan Polley 974fd9eecb add link back to git-installation 2021-01-22 16:12:52 -06:00
Ryan Polley 921cac0177 fix grammar in faq 2021-01-22 14:35:45 -06:00
infectormp ab97bc20ed
Add badge with current status of package 2021-01-09 17:58:47 +03:00
TW 37d4aee122
Merge pull request #5597 from Gelma/typos_dec
Fix typos
2021-01-07 19:21:03 +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
Jens Diemer 5a585c5c2e
"python-virtualenv" -> "python3-virtualenv" 2021-01-07 10:31:26 +01:00
Thomas Waldmann 4394fa45ba update CHANGES 2021-01-03 21:40:31 +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
TW 2b992fe078
Merge pull request #5332 from amikula/keep-oldest-when-retention-target-not-met
Keep oldest when retention target not met
2020-12-25 19:00:19 +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
Alf Mikula e208ba68bd Document retention of oldest archive, add to example and tests 2020-12-18 10:16:38 -08: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 2031494f23 build man 2020-12-06 20:45:41 +01:00
Thomas Waldmann 4f7aa1a92f build usage 2020-12-06 20:44:59 +01:00
Thomas Waldmann 77dd5e4d81 update CHANGES (master)
set release date.
2020-12-06 20:25:14 +01:00
Thomas Waldmann 938c2dc223 update CHANGES (master) 2020-12-06 18:04:50 +01:00
Nehalenniæ Oudin 810d82395d
Complete documentation on append-only remote repos (#5519)
improve docs/FAQ about append-only remote repos, fixes #5497
2020-12-06 15:53:39 +01:00
Thomas Waldmann 7831280aa4 update CHANGES (master) 2020-12-04 19:05:26 +01:00
Samuel fa331c3e3b
Change references of Travis to GitHub Actions (#5536)
s/travis/github actions/g, fixes #5528
2020-12-03 20:10:53 +01:00
Thomas Waldmann b45874bead ObfuscateSize compressor 2020-12-02 14:21:42 +01:00
Guinness 046acb882a
Add a hint on sleeping computer in the FAQ
Now the FAQ warns that a sleeping computer can lead to a broken pipe
when backing up over ssh.

Fixes #5301
2020-11-17 10:50:45 +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
Kurt Yoder f73555e5b2 Fix link for OSX security 2020-11-14 19:41:59 -05:00
Kurt Yoder 5d2c6e9eca Note requirement for full disk access on Catalina 2020-11-14 19:39:14 -05:00
TW e881ce3e93
Merge pull request #5505 from Gu1nness/1633-compression-algorithms
Add some documentation for new compression algorithm
2020-11-13 15:05:21 +01:00
Guinness 4212730e54
Add some documentation for new compression algorithm 2020-11-13 13:23:37 +01:00
Guinness 3278d253c5
Update the documentation on hacked backup client.
Fixes #5480.
2020-11-13 10:31:05 +01:00
TW 122dfce405
Merge pull request #5464 from Samuel-BF/patch-1
Doc / Deployment with ansible: generic install
2020-11-07 17:57:50 +01:00
Samuel BF 7e60a5e052 Rephrasing doc on deployement with ansible 2020-11-06 14:28:27 +01:00
Samuel-BF e18649d2d2 Doc / Deployment with ansible: pacman -> package
Using "package" ansible module make the ansible playbook able to run
against most unix OSes. Pacman module only works with Arch and derivatives.

Also : changing state from "latest" to "present". Ansible should not be
a way to keep your system up-to-date : it's a configuration management
system and, as such, should not change anything if neither the playbook
nor the machine changed its state (idempotency).

Reference : https://github.com/ansible/ansible-lint/blob/master/lib/ansiblelint/rules/PackageIsNotLatestRule.py#L24
2020-11-06 14:28:01 +01:00
TW 47e96bc261
Merge pull request #5475 from milkey-mouse/fp-5377
docs: how to approach borg speed issues (forward port)
2020-11-03 15:55:15 +01:00
Thomas Waldmann 60ee199a0f docs: how to approach borg speed issues, fixes #5371
also: give a speed example for unchanged files

also: explicitly mention chmod/chown changing ctime

also: reformat one paragraph
2020-11-02 17:36:08 -08:00
Thomas Waldmann 9d2cabc4d2 update travis-ci.org -> .com (master) 2020-11-02 23:06:15 +01: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