Commit Graph

1720 Commits

Author SHA1 Message Date
Thomas Waldmann 52b9f8e7e9
build_usage 2023-02-26 21:32:42 +01:00
Thomas Waldmann 1233b47878
sphinx: fix extlinks configuration
otherwise sphinx crashes.
2023-02-26 21:32:40 +01:00
Thomas Waldmann 03cb4d4124
update CHANGES, set release date
also minor other changes.
2023-02-26 21:32:32 +01:00
Thomas Waldmann c8f5cab8b6
update CHANGES 2023-02-26 01:14:18 +01:00
Andreas Vögele 4b18980768 Installation: Update Fedora in distribution list
Fixes #7357
2023-02-16 18:27:48 +01:00
Thomas Waldmann b42d2bf6dd
update CHANGES 2023-02-11 18:56:30 +01:00
Thomas Waldmann 55af2933fb
update CHANGES 2023-02-04 20:43:50 +01:00
TW 9b7647c89d
Merge pull request #7309 from ThomasWaldmann/no-part-files-in-final-archive
remove part files from final archive
2023-02-03 01:33:47 +01:00
Thomas Waldmann 856d98c72f
document another way to get UTF-8 encoding on stdin/stdout/stderr, fixes #2273 2023-02-01 15:32:29 +01:00
Thomas Waldmann b92f4aa487
remove --consider-part-files, related stats code, update docs
we now just treat that one .borg_part file we might have inside
checkpoint archives as a normal file.

people can recognize via the file name it is a partial file.

nobody cares for statistics of checkpoint files and the final
archive now does not contain any partial files any more, thus
no needs to maintain statistics about count and size of part
files.
2023-02-01 13:04:18 +01:00
Thomas Waldmann bf667170a7
ArchiveItem.cmdline list-of-str -> .command_line str, fixes #7246
Same change for .recreate_cmdline -> .recreate_command_line .

JSON output key "command_line":
borg 1.x: sys.argv [list of str]
borg 2: shlex.join(sys.argv) [str]
2023-01-20 00:19:00 +01:00
Thomas Waldmann 1672aee031
Item: symlinks: rename .source to .target, fixes #7245
Also, in JSON:
- rename "linktarget" to "target" for symlinks
- remove "source" for symlinks
2023-01-16 20:28:25 +01:00
TW 9b067fd1f7
Merge pull request #7275 from ThomasWaldmann/docs-key-change-passphrase
key change-passphrase: fix --encryption value in examples
2023-01-16 18:18:06 +01:00
Thomas Waldmann 54892f711d
key change-passphrase: fix --encryption value in examples
"repokey" (as in borg < 2.0, referring to the AES-CTR mode)
does not exist any more and was superseded by other repokey-*
modes.
2023-01-16 17:58:50 +01:00
Thomas Waldmann 8765e62bcd
document how borg deals with non-unicode bytes in JSON output 2023-01-16 17:45:46 +01:00
Helmut Grohne e210c6c053 delete left over documentation for borg key change-algorithm 2023-01-13 13:20:49 +01:00
Josh Soref 0958d94791 spelling: vagrant
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2023-01-12 11:24:05 -05:00
Josh Soref f41cf1c25f spelling: requirements
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2023-01-12 09:36:03 -05:00
Josh Soref a26c1d99d9 spelling: new
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2023-01-12 09:36:03 -05:00
Josh Soref 6e7f593b98 spelling: healthy
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2023-01-12 09:36:03 -05:00
Thomas Waldmann 43cbe6d8b6
remove BORG_LIBB2_PREFIX (not used any more)
the code now uses hashlib.blake2b from python stdlib.
2023-01-10 14:10:34 +01:00
Thomas Waldmann ac1df899aa
build_man 2023-01-03 00:37:04 +01:00
Thomas Waldmann b5ff043ac1
build_usage 2023-01-03 00:36:59 +01:00
Thomas Waldmann 36f5e66df0
update CHANGES 2022-12-30 15:46:58 +01:00
Paul D 991b53ebea Misc fixes. 2022-12-29 22:26:55 +00:00
Paul D 949dc51156 Rewrite for quickstart 2022-12-29 22:26:55 +00:00
Paul D 8ada680c87 'Want' fixes
aka who are you to presume what I want?
2022-12-29 22:26:55 +00:00
Paul D 253d8e8d4e Docs grammar fixes
joined split infinitives, and relocated adverbs appropriately.
2022-12-29 22:26:54 +00:00
Paul D a85b643866 Docs grammar fixes.
One cannot "to not x", but one can "not to x".
Avoiding split infinitives gives the added bonus that machine
translation yields better results.

setup (n/adj) vs set(v) up. We don't "I setup it" but "I set it up".

Likewise for login(n/adj) and log(v) in, backup(n/adj) and back(v) up.
2022-12-29 00:01:48 +00:00
Rayyan Ansari 66a407ff9f Use \n for the {NL} format specifier
\n is automatically converted on write to the platform-dependent os.linesep.
Using os.linesep instead of \n means that on Windows, the line ending becomes "\r\r\n".
Also switches mentions of {LF} to {NL} in code and docs.
2022-12-18 14:05:24 +00:00
Thomas Waldmann af93136ca7
build_man 2022-11-26 22:23:46 +01:00
Thomas Waldmann 4d2eb06ed3
build_usage 2022-11-26 22:23:17 +01:00
Thomas Waldmann 3ab46c5f46
update release date of 2.0.0b4 2022-11-26 22:16:53 +01:00
Thomas Waldmann 82aaef12b0
update CHANGES 2022-11-26 19:35:30 +01:00
Thomas Waldmann 4b446dc146 update CHANGES 2022-10-12 22:49:58 +02:00
TW 16e8213716
Merge pull request #7071 from ThomasWaldmann/misc
misc updates / fixes
2022-10-03 21:59:19 +02:00
Thomas Waldmann 4574ae0178 update quickstart docs with --match-archives 2022-10-03 20:30:34 +02:00
Thomas Waldmann 8342f74d5c docs: add rcompress to usage index 2022-10-03 13:50:29 +02:00
Thomas Waldmann 3f159ca3bb build_man / build_usage 2022-10-02 15:51:17 +02:00
Thomas Waldmann 5d8d21df4d rcompress docs / examples / markup fixes 2022-10-02 15:50:41 +02:00
Thomas Waldmann c6785c8f15 set release date 2022-10-02 15:01:16 +02:00
Thomas Waldmann fa74247ecb update CHANGES 2022-10-02 14:51:34 +02:00
Thomas Waldmann 9315ecb89e update CHANGES 2022-09-28 15:20:15 +02:00
Thomas Waldmann e57ff29f22 BORG_LOCK_WAIT=n env var to set default for --lock-wait option, fixes #5279 2022-09-27 17:09:19 +02:00
Thomas Waldmann 18ca2ab3ce build_usage build_man 2022-09-10 18:15:45 +02:00
Thomas Waldmann c8964e92fd update CHANGES 2022-09-10 18:15:45 +02:00
Thomas Waldmann 057db79b44 update CHANGES 2022-09-10 01:06:42 +02:00
Thomas Waldmann c8830cde44 update docs 2022-09-08 22:26:23 +02:00
Thomas Waldmann e078337c7c update CHANGES 2022-08-14 00:08:51 +02:00
TW c2bcecf2eb
Merge pull request #6942 from mh4ckt3mh4ckt1c4s/doc-shift-odg
update diagrams to odg format, fixes #6928
2022-08-09 22:03:09 +02:00
mh4ckt3mh4ckt1c4s 15a450c7e8 Fix transparency level 2022-08-09 21:20:44 +02:00
mh4ckt3mh4ckt1c4s 259d3fdc76 Tiny fix of transparency bug 2022-08-09 19:33:30 +02:00
mh4ckt3mh4ckt1c4s be9e99e346 Fix size of images to match old ones 2022-08-09 19:21:16 +02:00
mh4ckt3mh4ckt1c4s 3e40f68409 Added the transparency thing to compaction schema 2022-08-09 19:15:09 +02:00
mh4ckt3mh4ckt1c4s 45663552bf Updated compaction to an odg file 2022-08-07 22:13:33 +02:00
Thomas Waldmann f5b7ae5b30 build_usage build_man 2022-08-07 19:20:34 +02:00
Thomas Waldmann 8148d4e400 fix sphinx warnings 2022-08-07 19:14:03 +02:00
Thomas Waldmann 3556bcb0db set release date 2022-08-07 19:09:06 +02:00
Thomas Waldmann 97ec8a819d update CHANGES 2022-08-07 18:40:20 +02:00
mh4ckt3mh4ckt1c4s cd27313693 Changed structure schema to odg format 2022-08-07 00:55:22 +02:00
mh4ckt3mh4ckt1c4s 085b244bb7 Removed object-graph.vdg and added 'simplified' mention in schema 2022-08-07 00:25:31 +02:00
Thomas Waldmann fb74fdb710 massively increase per archive metadata stream size limit, fixes #1473
implemented by introducing one level of indirection, the limit is now
very high, so it is not practically relevant any more.

we always use the indirection (storing the metadata stream chunk ids list not
directly into the archive item, but into some repo objects referenced by the new
ArchiveItem.item_ptrs list).

thus, the code behaves the same for all archive sizes.
2022-08-06 19:01:41 +02:00
mh4ckt3mh4ckt1c4s 7ed3fad470 Updated object-graph to an odg file 2022-08-06 11:32:32 +02:00
mh4ckt3mh4ckt1c4s 2c29da2553 Fix duplicate object in borg-data-flow graph 2022-08-06 10:53:13 +02:00
mh4ckt3mh4ckt1c4s 1716502cff Some visual fixes 2022-08-06 02:28:51 +02:00
mh4ckt3mh4ckt1c4s dcc7fba2e5 Updated borg-data-flow to an odg file 2022-08-06 02:18:38 +02:00
Thomas Waldmann f621b21ec1 docs: update security.rst 2022-08-03 22:19:28 +02:00
Thomas Waldmann c7c7690b26 build_man build_usage 2022-08-03 22:19:12 +02:00
Thomas Waldmann c3345fe423 remove remainders of borg key migrate-to-repokey 2022-08-03 21:48:55 +02:00
Thomas Waldmann 78230dd299 docs: key: fix keyfile mode in example 2022-08-03 18:46:50 +02:00
Thomas Waldmann bcd7ab3dec docs: rcreate: explain "related repo" 2022-08-03 18:20:10 +02:00
Thomas Waldmann d5df53732d increase Key.version to 2
Old borg (< 2.0) can not read/process the new keys that have crypt_key instead of enc_key and enc_hmac_key.
2022-08-03 12:25:58 +02:00
Thomas Waldmann 89e4a52c56 docs: misc. updates
- remove outdated stuff
- fix infos for borg 2.0
2022-08-03 11:35:25 +02:00
Jonas Schäfer 33b846e292 docs: update encryption drawing for new compression bytes
Since compression type identification has been split into type and
level, the graphic needed a slight update.

Unfortunately, I don't have access to Visio, so I converted this to odg.
2022-07-30 19:24:26 +02:00
Jonas Schäfer c8ab490017 docs: provide more details on object layout
While writing my own out-of-band decoder, I had a hard time figuring out
how to unpack the manifest. From the description, I was only able to
read that the manifest is msgpack'd, but I had not been able to figure
out that it's also going through the same encryption+compression logic
as all other things do.

This should make it a little clearer and provide the necessary
information to understand how the compression works.
2022-07-30 19:24:26 +02:00
Thomas Waldmann ad7c7159b2 Merge branch 'master' into borg2 2022-07-27 13:49:50 +02:00
remyabel2 ddb805cd10
docs: add info on man page installation (#6888)
docs: add info about man page installation, fixes #6661
2022-07-27 12:48:27 +02:00
Thomas Waldmann c7e719f209 docs: update archive_progress json description about "finished", see #6570 2022-07-25 13:05:16 +02:00
Thomas Waldmann dfbf638a5b Merge branch 'master' into borg2 2022-07-23 21:21:41 +02:00
a1346054 160dd877ab
fix typos 2022-07-22 15:51:46 +00:00
Thomas Waldmann 9d6c98d9f9 docs: remove _assert_id() call for new crypto 2022-07-20 14:31:37 +02:00
Thomas Waldmann 357aa5241b build_usage / build_man 2022-07-17 09:23:06 +02:00
Thomas Waldmann 32a7896573 update CHANGES 2022-07-16 23:16:39 +02:00
Thomas Waldmann 47c2672a64 ssh:// URLs: remove support for /~otheruser/, see #6855
If you used this, just replace it by:

ssh://user@host:port/home/otheruser/
2022-07-15 16:02:45 +02:00
Thomas Waldmann 55a5c5867a update CHANGES 2022-07-09 15:34:15 +02:00
TW 2418795ed1
Merge pull request #6197 from hexagonrecursion/expect
Automate asciinema screencasts
2022-07-06 23:55:23 +02:00
Thomas Waldmann 45b3f6418d update ascinemacasts 2022-07-06 23:46:14 +02:00
Thomas Waldmann 0f5fb7d38d use borg 1.2.1 2022-07-06 23:34:35 +02:00
Andrey Bienkowski 1e83415c51 Screencasts/advanced: start where basic left off 2022-07-06 17:21:31 +02:00
Andrey Bienkowski 5e8e10a53c Screencasts/basic: use sample data 2022-07-06 17:19:10 +02:00
Andrey Bienkowski 6e197f66f5 Screencasts: add wallpaper download urls
We need some sample data to propoerly demo the backup.

I have selected 30 random wallpapers form wikimedia commons
2022-07-06 17:19:10 +02:00
Andrey Bienkowski 1c10eabc80 rm advanced.sh 2022-07-06 17:19:10 +02:00
Andrey Bienkowski 1cf184dfda Screencasts/advanced: type slowly 2022-07-06 17:19:10 +02:00
Andrey Bienkowski 828a969174 Screencasts/advanced: do not print "spawn /bin/sh" 2022-07-06 17:19:10 +02:00
Andrey Bienkowski 06a19dd87b Screencasts/advanced: fix the key export example
The previous example had an incorrect sequence of arguments
in the --qr-html case. I have also updated --paper
for consistency
2022-07-06 17:19:10 +02:00
Andrey Bienkowski 62d77454b2 Screencasts: do not start screencasts with "exit"
vagrant is magic: sometimes it decides to type "exit" into stdin
2022-07-06 17:19:10 +02:00
Andrey Bienkowski aae1b439e4 Screencasts/install: do not timeout due to slow wget 2022-07-06 17:19:10 +02:00
Andrey Bienkowski 9b9294d940 Screencasts: do not redownload borg 2022-07-06 17:19:10 +02:00
Andrey Bienkowski 3391236d00 Update the screencasts 2022-07-06 17:19:10 +02:00
Andrey Bienkowski df0e8599de Automate the advanced usage screencast 2022-07-06 17:19:10 +02:00
Andrey Bienkowski bff922a9ba Screencasts: improve the README 2022-07-06 17:19:10 +02:00
Thomas Waldmann 2e063a9c44 docs: using black for code formatting 2022-07-06 16:35:31 +02:00
Thomas Waldmann 7957af562d blacken all the code
https://black.readthedocs.io/
2022-07-06 16:34:38 +02:00
TW 1905f6289d
Merge pull request #6839 from ThomasWaldmann/hlid-docs
document hlid, fixes #2388
2022-07-06 14:08:07 +02:00
Thomas Waldmann 5e0c4a8fd4 document hlid, fixes #2388 2022-07-05 22:27:08 +02:00
TW dbb9f62afd
Merge pull request #6836 from ThomasWaldmann/cleanups
Cleanups
2022-07-05 02:46:43 +02:00
Thomas Waldmann dbb63f874b docs: fix rst literal blocks 2022-07-05 00:38:37 +02:00
Thomas Waldmann dbe62b8074 docs: replaced tabs by spaces 2022-07-05 00:32:57 +02:00
Thomas Waldmann 5c8a5f111f stop using libdeflate
borg2's new repo format does not need computing crc32 over big amounts of
(content) data any more (we now use xxh64 for that).

thus, having a quick crc32 implementation via libdeflate is not important
enough any more to rectify having libdeflate as a requirement.
2022-07-04 20:33:59 +02:00
Thomas Waldmann 6fa8d11ecc build_usage ; build_man 2022-07-04 14:09:19 +02:00
Thomas Waldmann 907ffbecfa update CHANGES 2022-07-04 14:09:19 +02:00
Thomas Waldmann c7ed985ffd Merge branch 'master' into borg2 2022-07-02 23:28:39 +02:00
Thomas Waldmann 6888d5dcb2 remove -P (aka --prefix) option, fixes #6806
-a (aka --glob-archives) can be used for same purpose and is more powerful.
2022-07-02 20:52:41 +02:00
Thomas Waldmann ea4ed6b98f docs: json progress_percent: some values are optional, fixes #4074
in the finished == true message, these are missing:
- message
- current / total
- info

This is to be somewhat consistent with #6683 by only providing a
minimal set of values for the finished case.

The finished messages is primarily intended for cleanup purposes,
e.g. clearing the progress display.
2022-07-01 14:35:44 +02:00
TW e577ccb094
Merge pull request #6755 from fantasya-pbem/docs/5960_FAQ-quota-size
[DOCS] #5960 - FAQ: Full quota / full disk
2022-06-29 14:42:11 +02:00
Thomas Waldmann 0a7baa53c4 docs: fix borg transfer formatting / rendering, fixes #6800 2022-06-26 20:29:10 +02:00
Thomas Waldmann e2f7087aa8 docs: remove reference to borg upgrade 2022-06-26 20:09:54 +02:00
Thomas Waldmann 9680538a70 fix rendering of list/rlist help 2022-06-26 20:08:38 +02:00
Thomas Waldmann a98c6ba479 changes: init -> rcreate 2022-06-26 19:59:08 +02:00
Thomas Waldmann ab25bf8175 build_usage build_man 2022-06-26 13:56:33 +02:00
Thomas Waldmann 20bf97a8a4 CHANGES: set release date, formatting 2022-06-26 13:52:47 +02:00
Thomas Waldmann 3232cb4a7e transfer: add a specific transfer example 2022-06-26 01:22:28 +02:00
Thomas Waldmann 391178e68e update CHANGES 2022-06-26 01:03:58 +02:00
Thomas Waldmann dbae8e60eb remove borg upgrade 2022-06-26 00:25:44 +02:00
Thomas Waldmann 51cf85e627 build_usage / build_man / doc updates 2022-06-25 21:58:19 +02:00
Thomas Waldmann 7f99aa155e update CHANGES, split changelog by major version 2022-06-25 21:58:19 +02:00
Thalian 036eb97f03 [DOCS] #5960 - FAQ: Full quota / full disk 2022-06-24 17:55:14 +02:00
Thomas Waldmann e0c64629d1 Merge branch 'master' into borg2
strange conflicts, automated patches seemed to not have applied correctly.
also had to fix some stuff manually, tests were failing.
2022-06-23 11:25:01 +02:00
Thomas Waldmann 1393e4f391 remove csize references from docs 2022-06-12 18:01:57 +02:00
targhs 35c031ed2c Correct shell syntax for installation using git 2022-06-12 20:19:31 +05:30
Maltimore 4902398554 [DOCS] Remove unnecessary/dangerous line continuation 2022-06-10 21:21:52 +03:00
Thomas Waldmann 421d4bdfb0 docs: fix bytes -> str in data-structures docs 2022-06-09 17:57:28 +02:00
TW 0e8c9941bb
Merge pull request #6747 from fantasya-pbem/docs/4776_FAW-swapped-targets
[DOCS] #4776 - FAQ: How to swap backup media
2022-06-05 18:20:36 +02:00
Thalian c7c98ca0fd [DOCS] #4776 - FAQ: How to swap backup media
fixes #4776
2022-06-05 18:05:16 +02:00
Thomas Waldmann 7634426195 update CHANGES with 1.1.18 changelog 2022-06-05 17:47:41 +02:00
Thalian b4d3859b9e #6407 - Document Borg 1.2 pattern behavior change
Make clear that absolute paths always go into the matcher as if they are relative (without leading slash). Adapt all examples accordingly.

fixes #6407
2022-05-27 14:13:12 +02:00
Thomas Waldmann 61299d23db Revert "Remove scp syntax for locations (#6697)"
This reverts commit 1b4b84dfd8.
2022-05-18 17:31:10 +02:00
Thomas Waldmann 6bfdb3f630 refactor hardlink_master processing globally
borg now has the chunks list in every item with content.
due to the symmetric way how borg now deals with hardlinks using
item.hlid, processing gets much simpler.

but some places where borg deals with other "sources" of hardlinks
still need to do some hardlink management:
borg uses the HardLinkManager there now (which is not much more
than a dict, but keeps documentation at one place and avoids some
code duplication we had before).

item.hlid is computed via hardlink_id function.

support hardlinked symlinks, fixes #2379
as we use item.hlid now to group hardlinks together,
there is no conflict with the item.source usage for
symlink targets any more.

2nd+ hardlinks now add to the files count as did the 1st one.
for borg, now all hardlinks are created equal.
so any hardlink item with chunks now adds to the "file" count.

ItemFormatter: support {hlid} instead of {source} for hardlinks
2022-05-18 14:20:01 +02:00
Emil M George 1b4b84dfd8
Remove scp syntax for locations (#6697)
remove scp syntax support from cli and from Location parser, add note about converting scp-style URLs to ssh-style, fixes #6691
2022-05-15 21:55:19 +02:00
Andrea Gelmini c79fd61b5c
Fix typos (#6688)
fix typos

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2022-05-15 21:23:48 +02:00
Christopher Klooz 594d83aad5
docs: authentication primitives: improved security and performance infos (master) (#6667)
docs: authentication primitives: improved security and performance infos
2022-05-14 22:57:22 +02:00
ReethuVinta ac4666d7f4
documented workaround for getting help for sub-sub-commands (#6346)
docs: how to get help for sub-sub-commands
2022-05-13 18:29:43 +02:00
ReethuVinta c85bcfd3ad
documented secret key usage against fingerprinting (#6345)
docs: secret key usage against fingerprinting

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2022-05-10 21:18:40 +02:00
Thomas Waldmann 9f09a9e096 docs: mention BORG_FILES_CACHE_SUFFIX as alternative to BORG_FILES_CACHE_TTL, fixes #5602 2022-04-30 20:28:46 +02:00
Thomas Waldmann c2ad118434 FAQ: add a hint about --debug-topic=files_cache 2022-04-20 13:00:02 +02:00
Thomas Waldmann 0cf97dc6db build_usage 2022-04-17 00:07:12 +02:00
Thomas Waldmann 9f86c375b4 python setup.py build_man 2022-04-14 21:25:12 +02:00
Thomas Waldmann d7fe23c515 python setup.py build_usage 2022-04-14 21:25:12 +02:00
Thomas Waldmann 801751e44e set 1.3.0a1 release date
also: cosmetic fixes in changelog
2022-04-14 21:03:11 +02:00
TW 4c749eac2a
Merge pull request #6595 from ThomasWaldmann/update-changes3
update CHANGES
2022-04-14 20:47:48 +02:00