Thomas Waldmann
b2ab823fea
docs: update cygwin install notes to python 3.9
2022-03-26 17:56:54 +01:00
Thomas Waldmann
07cf06f9e1
docs: add libdeflate requirement to install docs, fixes #6446
...
there was no change required due to argon2-cffi, because that will be automatically installed by pip.
2022-03-26 17:52:46 +01:00
Thomas Waldmann
10cbdcc67e
add encryption-aead diagram
2022-03-26 17:05:57 +01:00
Thomas Waldmann
ce247526c2
docs: update borg init examples
2022-03-26 17:05:57 +01:00
Thomas Waldmann
298c5ee539
docs: security infos only applying to legacy encryption
2022-03-26 17:05:57 +01:00
Thomas Waldmann
f4a6ad080b
docs: add new AEAD modes to security docs
2022-03-26 17:05:57 +01:00
Michael Bauer
638774761c
use --numeric-ids in pull doc
...
replace flag --numeric-owner with --numeric-ids
2022-03-09 21:43:22 +01:00
Manu
af5103d833
Incorporate feedback by TW
2022-03-09 15:48:57 +04:00
Manu
dd1023df44
Add discussion and note on file attrs.
2022-03-09 14:06:40 +04:00
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
cbeef56454
pyupgrade --py38-plus ./**/*.py
2022-02-27 20:11:56 +01:00
Thomas Waldmann
64e7ccd3fc
require python >= 3.9, fixes #6315
2022-02-27 18:46:30 +01:00
Thomas Waldmann
80c21b2e23
remove docs of previously bundled blake2 code
2022-02-26 22:22:02 +01:00
Thomas Waldmann
96d93dcf0e
do not support bundled 3rd party code any more, fixes #6316
2022-02-26 22:18:12 +01:00
Thomas Waldmann
ecd0865d9c
unbundle zstd 3rd party code, see #6316
2022-02-26 21:36:30 +01:00
Thomas Waldmann
7c8f288a18
unbundle lz4 3rd party code, see #6316
2022-02-26 21:35:17 +01:00
Thomas Waldmann
d1d3d1dfa4
crypto: remove support for: OpenSSL < 1.1.1, LibreSSL < 2.7.0
...
All these are unsupported since long.
Newer versions of LibreSSL have gained chacha20-poly1305 support,
but still lack aes256-ocb support.
Also they have the HMAC_CTX_new/free api now.
docs: openssl >= 1.1.1 is required now
anything older is out of support anyway.
2022-02-26 00:55:19 +01:00
Julian Picht
091c48bc37
docs: Clarify on-disk order and size of log entry fields ( #6357 )
...
docs: clarify on-disk order and size of log entry fields
The order of the fields of a log entry on disk is CRC32 first, the docs had the size first.
I tried to make this list similar to the HashIndex struct description.
2022-02-25 12:53:58 +01:00
Thomas Waldmann
d6756d0070
docs: do not transform --/--- to unicode dashes
2022-02-24 08:44:51 +03:00
Andrey Bienkowski
f225d15093
Update the screencasts
2022-02-20 11:51:17 +03:00
Andrey Bienkowski
ccf48ade3d
Screencasts: implement the remoteserver example
2022-02-20 11:51:07 +03:00
Andrey Bienkowski
904897bce1
Screencasts: echo the current borg version
2022-02-20 10:46:32 +03:00
Thomas Waldmann
7265f6adb8
quickstart docs: only borg compact frees disk space
2022-02-19 19:25:16 +01:00
Thomas Waldmann
6641a9629d
build_man
2022-02-19 18:48:13 +01:00
Thomas Waldmann
9a8eec6af1
build_usage
2022-02-19 18:47:47 +01:00
Thomas Waldmann
7b36f001f6
fixup: set release date
2022-02-19 18:45:19 +01:00
Thomas Waldmann
0a5b329008
update CHANGES
2022-02-19 18:41:43 +01:00
Andrey Bienkowski
1b633c1ca1
Reimplement screencasts using Vagrant
2022-02-19 13:00:04 +03:00
Thomas Waldmann
ee32c1b63d
update CHANGES
2022-02-14 18:55:59 +01:00
Andrey Bienkowski
e3a0b5fde8
Automate the installation asciinema screencast
2022-02-07 20:05:12 +03:00
Thomas Waldmann
634b1e5a1a
docs: add borg 1.2 upgrade notes
2022-02-06 21:22:37 +01:00
Thomas Waldmann
ef8aac2e4c
build_man
2022-02-05 17:52:25 +01:00
Thomas Waldmann
b430c8d15a
build_usage
2022-02-05 17:52:25 +01:00
Thomas Waldmann
fa26d5f7c4
update CHANGES
2022-02-05 17:45:35 +01:00
Andrey Bienkowski
6bc1f48e4e
Apply review suggestions
2022-02-05 09:07:13 +03:00
Andrey Bienkowski
d6c16d77cb
Review suggestion: mention local nonce path
...
> do we maybe also want to mention the specific path where the local
> nonce is kept?
2022-02-05 09:07:13 +03:00
Andrey Bienkowski
fab5024cb7
Doc: warn about tampered server nonce
...
https://github.com/borgbackup/borg/pull/6188#discussion_r794752672
> Well, guess one could also use max(list of trusted nonce values).
>
> The real issue is if you have lost all or some of the trusted
> (client side) nonce values and you also have reason to not trust the
> server side nonce, because someone might attack you on the server.
2022-02-05 09:07:13 +03:00
Andrey Bienkowski
62fe1cab30
Doc: impact of deleting path/to/repo/nonce
...
Fixes: https://github.com/borgbackup/borg/issues/5858
2022-02-05 09:07:04 +03:00
Thomas Waldmann
6c517e4c25
docs: FUSE "versions" view is not experimental any more
2022-01-31 21:01:49 +01:00
Andrey Bienkowski
3c380f8a90
Compile the screencast
2022-01-29 17:16:16 +03:00
Andrey Bienkowski
e4c08f0643
rm basic.sh
2022-01-29 17:03:08 +03:00
Andrey Bienkowski
cc6768ec71
Add prompts
2022-01-29 16:36:19 +03:00
Andrey Bienkowski
c67646857f
Remove commented-out code
2022-01-29 16:36:13 +03:00
Andrey Bienkowski
7a6454618c
Automate the basic usage screencast
2022-01-29 16:31:29 +03:00
Andrey Bienkowski
910852acbf
Begin automating asciinema screencasts
2022-01-29 15:54:30 +03:00
Thomas Waldmann
faf980cb69
update install docs, fixes #6180
2022-01-29 01:52:41 +01:00
Dee Newcum
03bbad0d17
docs: fix/update cygwin package requirements ( #5735 )
...
docs: cygwin package requirements fixes/updates
Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2022-01-29 01:51:23 +01:00
Andrey Bienkowski
98fcef57ce
Doc: ~/.config/borg/keys is not used w/ repokey ( #6185 )
...
docs: ~/.config/borg/keys is not used for repokey keys, fixes #6107
Thanks to ThomasWaldmann for suggesting this
https://github.com/borgbackup/borg/pull/6185#discussion_r793995379
2022-01-28 18:29:40 +01:00
Thomas Waldmann
ab1a83c813
changes.rst markup fixes
2022-01-23 17:18:17 +01:00
Thomas Waldmann
c643210741
docs: fix tar-related doc structure
2022-01-23 17:16:20 +01:00
Thomas Waldmann
61c7ee2b35
build_man
2022-01-23 15:53:42 +01:00
Thomas Waldmann
572e996d9a
build_usage
2022-01-23 15:52:21 +01:00
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